# ESB转发类接口--mq转发请求接口 # 品牌方通知 ### 电子凭证系统通知到品牌渠道 #### **接口用途** - 当电子凭证发生变更操作需要通知到品牌渠道时,调用该接口。 #### **接口说明** - 该接口为异步通知接口,电子凭证系统无需返回值,由ESB负责与外部系统交互。 - messageType字段的值在对接时确定,默认易百标准报文格式,赋值“ebuy”;如果品牌方有规定格式,则值为“third”。 - 队列名称:`whale.core.brandNotify` **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===>ESB** **通知报文主体**
字段类型是否必填字段意义备注
channelIdString品牌id
notifyUrlString通知地址
notifyTypeString通知类型
messageTypeString报文类型ebuy:易百标准报文格式,third:第三方自定义格式
whaleMessageString易百标准报文
**易百标准报文:制码通知** - notifyType:`MakeCode`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识MakeCodeNotify
bizContentJSONString<[makeCodeNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAmakecodenot "makeCodeNotify")>制码通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
**易百标准报文:制码订单作废** - notifyType:`MakeVoid`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识MakeVoidNotify
bizContentJSONString<[makeVoidNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAmakevoidnot "makeVoidNotify")>制码订单作废通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
**易百标准报文:码状态更新通知** - notifyType:`UpdateCodeStatus`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识UpdateCodeStatusNotify
bizContentJSONString<[updateCodeStatusNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAupdatecodes "updateCodeStatusNotify")>更新码状态通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
**易百标准报文:码延期通知** - notifyType:`CodeDelay`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识CodeDelayNotify
bizContentJSONString<[codeDelayNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAcodedelayno "codeDelayNotify")>码延期通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
**易百标准报文:码过期通知** - notifyType:`CodeExpire`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识CodeExpireNotify
bizContentJSONString<[codeExpireNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAcodeexpiren "codeExpireNotify")>码过期通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
**易百标准报文:串码核销** - notifyType:`Verify`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识VerifyNotify
bizContentJSONString<[verifyNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAverifynotif "verifyNotify")>核销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
**易百标准报文:串码核销撤销** - notifyType:`VerifyVoid`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识VerifyVoidNotify
bizContentJSONString<[verifyVoidNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAverifyvoidn "verifyVoidNotify")>核销撤销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
# 取码方通知 ### 电子凭证系统通知到取码方 #### **接口用途** - 当电子凭证发生变更操作需要通知到取码方时,调用该接口。 #### **接口说明** - 该接口为异步通知接口,电子凭证系统无需返回值,由ESB负责与外部系统交互。 - messageType字段的值在对接时确定,默认易百标准报文格式,赋值“Ebuy”;如果品牌方有规定格式,则值为“Third”。 - 队列名称:`whale.core.saleChannelNotify` **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>ESB** **通知报文主体**
字段类型是否必填字段意义备注
channelIdString品牌id
notifyUrlString通知地址
notifyTypeString通知类型
messageTypeString报文类型Ebuy:易百标准报文格式,Third:第三方自定义格式
whaleMessageString易百标准报文
**易百标准报文:串码核销** - notifyType:`Verify`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识VerifyNotify
bizContentJSONString<[verifyNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAverifynotif "verifyNotify")>核销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
**易百标准报文:串码核销撤销** - notifyType:`VerifyVoid`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识VerifyVoidNotify
bizContentJSONString<[verifyVoidNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAverifyvoidn "verifyVoidNotify")>核销撤销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
**易百标准报文:码状态更新** - notifyType:`UpdateCodeStatus`
字段类型是否必填字段意义备注
appIdString(10)电子凭证系统对接方id
actionString(20)业务标识UpdateCodeStatusNotify
bizContentJSONString<[updateCodeStatusNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAupdatecodes "updateCodeStatusNotify")>更新码状态通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString(10)版本号
timestampString时间戳
signString签名
# 制码方通知 ### 电子凭证系统通知到制码方 #### **接口用途** - 当电子凭证发生变更操作需要通知到制码方时,调用该接口。 #### **接口说明** - 该接口为异步通知接口,电子凭证系统无需返回值,由ESB负责与外部系统交互。 - messageType字段的值在对接时确定,默认易百标准报文格式,赋值“Ebuy”;如果品牌方有规定格式,则值为“Third”。 - 队列名称:`whale.core.sendChannelNotify` **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>ESB** **通知报文主体**
字段类型是否必填字段意义备注
channelIdString品牌id
notifyUrlString通知地址
notifyTypeString通知类型
messageTypeString报文类型Ebuy:易百标准报文格式,Third:第三方自定义格式
whaleMessageString易百标准报文
**易百标准报文:码状态更新通知** - notifyType:`UpdateCodeStatus`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识UpdateCodeStatusNotify
bizContentJSONString<[updateCodeStatusNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAupdatecodes "updateCodeStatusNotify")>更新码状态通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
# 代理渠道通知 ### 电子凭证系统通知到代理商 #### **接口用途** - 当电子凭证发生变更操作需要通知到代理商时,调用该接口。 #### **接口说明** - 代理商:介于取码方与易百电子凭证系统之间,帮助取码方进行取码等操作,比如微信商家券系统系统。 - 该接口为异步通知接口,电子凭证系统无需返回值,由ESB负责与外部系统交互。 - messageType字段的值在对接时确定,默认易百标准报文格式,赋值“Ebuy”;如果品牌方有规定格式,则值为“Third”。 - 队列名称:`whale.core.agentChannelNotify` **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>ESB** **通知报文主体**
字段类型是否必填字段意义备注
channelIdString代理商id
notifyUrlString通知地址
notifyTypeString通知类型
messageTypeString报文类型Ebuy:易百标准报文格式,Third:第三方自定义格式
whaleMessageString易百标准报文
**易百标准报文:串码核销** - notifyType:`Verify`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识VerifyNotify
bizContentJSONString<[verifyNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAverifynotif "verifyNotify")>核销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
**易百标准报文:串码核销撤销** - notifyType:`VerifyVoid`
字段类型是否必填字段意义备注
appIdString电子凭证系统对接方id
actionString业务标识VerifyVoidNotify
bizContentJSONString<[verifyVoidNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAverifyvoidn "verifyVoidNotify")>核销撤销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString版本号
timestampString时间戳
signString签名
# 第三方微信卡包通知 ### 调用第三方插入微信卡包接口 #### **接口用途** - 当取码方需要易百协助调用制码方完成微信卡包通知时,电子凭证平台请求ESB调用此接口。 - 制码方需提供给易百相应URL。 #### **接口说明** - 该接口为电子凭证平台调用ESB做用户卡包通知操作,ESB再根据不同制码方拼装报文并实时请求。 #### **url** - `activityInsert` **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>ESB**
字段类型是否必填字段意义备注
channelIdString外部制码方id
requestIdString请求流水号32个字符,用于标识唯一一笔交易
codesString码号
userUnionIdString微信用户唯一识别号
appIdString公众号id
userOpenIdString微信用户唯一识别号
signString签名
**请求报文举例** ``` { "channelId":"10002401", "requestId": "20181019112535100000000000000002", "codes": "1021242013780905000", "userUnionId":"2429********************", "sign":"deid3412dj98s34lix" } ``` **返回参数,ESB===>[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")**
字段类型是否必填字段意义备注
returnCodeString请求返回码
returnMsgString请求返回信息
**返回报文举例** ``` { "returnCode": "00", "returnMsg": "操作成功", } ```