# 品牌方通知

### 电子凭证系统通知到品牌渠道

#### **接口用途**

- 当电子凭证发生变更操作需要通知到品牌渠道时，调用该接口。

#### **接口说明**

- 该接口为异步通知接口，电子凭证系统无需返回值，由ESB负责与外部系统交互。
- messageType字段的值在对接时确定，默认易百标准报文格式，赋值“ebuy”；如果品牌方有规定格式，则值为“third”。
- 队列名称：`whale.core.brandNotify`

**请求参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;ESB**

**通知报文主体**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>channelId</td><td>String</td><td>是</td><td>品牌id</td><td> </td></tr><tr><td>notifyUrl</td><td>String</td><td>是</td><td>通知地址</td><td> </td></tr><tr><td>notifyType</td><td>String</td><td>是</td><td>通知类型</td><td> </td></tr><tr><td>messageType</td><td>String</td><td>是</td><td>报文类型</td><td>ebuy:易百标准报文格式，third:第三方自定义格式</td></tr><tr><td>whaleMessage</td><td>String</td><td>是</td><td>易百标准报文</td></tr></tbody></table>

**易百标准报文：制码通知**

- notifyType：`MakeCode`

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String</td><td>是</td><td>业务标识</td><td>MakeCodeNotify</td></tr><tr><td>bizContent</td><td>JSONString&lt;[makeCodeNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAmakecodenot "makeCodeNotify")&gt;</td><td>否</td><td>制码通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串</td><td> </td></tr><tr><td>version</td><td>String</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

**易百标准报文：制码订单作废**

- notifyType：`MakeVoid`

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String</td><td>是</td><td>业务标识</td><td>MakeVoidNotify</td></tr><tr><td>bizContent</td><td>JSONString&lt;[makeVoidNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAmakevoidnot "makeVoidNotify")&gt;</td><td>否</td><td>制码订单作废通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串</td><td> </td></tr><tr><td>version</td><td>String</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

**易百标准报文：码状态更新通知**

- notifyType：`UpdateCodeStatus`

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String</td><td>是</td><td>业务标识</td><td>UpdateCodeStatusNotify</td></tr><tr><td>bizContent</td><td>JSONString&lt;[updateCodeStatusNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAupdatecodes "updateCodeStatusNotify")&gt;</td><td>是</td><td>更新码状态通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串</td><td> </td></tr><tr><td>version</td><td>String</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

**易百标准报文：码延期通知**

- notifyType：`CodeDelay`

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a-2"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String</td><td>是</td><td>业务标识</td><td>CodeDelayNotify</td></tr><tr><td>bizContent</td><td>JSONString&lt;[codeDelayNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAcodedelayno "codeDelayNotify")&gt;</td><td>是</td><td>码延期通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串</td><td> </td></tr><tr><td>version</td><td>String</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

**易百标准报文：码过期通知**

- notifyType：`CodeExpire`

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a-3"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String</td><td>是</td><td>业务标识</td><td>CodeExpireNotify</td></tr><tr><td>bizContent</td><td>JSONString&lt;[codeExpireNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAcodeexpiren "codeExpireNotify")&gt;</td><td>是</td><td>码过期通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串</td><td> </td></tr><tr><td>version</td><td>String</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

**易百标准报文：串码核销**

- notifyType：`Verify`

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a-4" style="height: 208px;"><thead><tr style="height: 29px;"><th style="height: 29px; width: 84.4844px;">字段</th><th style="height: 29px; width: 177.203px;">类型</th><th style="height: 29px; width: 73px;">是否必填</th><th style="height: 29px; width: 168.469px;">字段意义</th><th style="height: 29px; width: 89.5156px;">备注</th></tr></thead><tbody><tr style="height: 29px;"><td style="height: 29px; width: 84.4844px;">appId</td><td style="height: 29px; width: 177.203px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 168.469px;">电子凭证系统对接方id</td><td style="height: 29px; width: 89.5156px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 84.4844px;">action</td><td style="height: 29px; width: 177.203px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 168.469px;">业务标识</td><td style="height: 29px; width: 89.5156px;">VerifyNotify</td></tr><tr style="height: 34px;"><td style="height: 34px; width: 84.4844px;">bizContent</td><td style="height: 34px; width: 177.203px;">JSONString&lt;[verifyNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAverifynotif "verifyNotify")&gt;</td><td style="height: 34px; width: 73px;">是</td><td style="height: 34px; width: 168.469px;">核销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串</td><td style="height: 34px; width: 89.5156px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 84.4844px;">version</td><td style="height: 29px; width: 177.203px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 168.469px;">版本号</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 84.4844px;">timestamp</td><td style="height: 29px; width: 177.203px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 168.469px;">时间戳</td><td style="height: 29px; width: 89.5156px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 84.4844px;">sign</td><td style="height: 29px; width: 177.203px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 168.469px;">签名</td></tr></tbody></table>

**易百标准报文：串码核销撤销**

- notifyType：`VerifyVoid`

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a-5"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String</td><td>是</td><td>业务标识</td><td>VerifyVoidNotify</td></tr><tr><td>bizContent</td><td>JSONString&lt;[verifyVoidNotify](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAverifyvoidn "verifyVoidNotify")&gt;</td><td>是</td><td>核销撤销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串</td><td> </td></tr><tr><td>version</td><td>String</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>