# 制码通知

## 基本信息

制码通知，易百将制码通知分发给渠道或者品牌，对接方需提供接口接收通知。

## 请求参数


### Headers

<table border="1" id="bkmrk-%E5%8F%82%E6%95%B0%E5%90%8D%E7%A7%B0-%E5%8F%82%E6%95%B0%E5%80%BC-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-conten" style="border-collapse: collapse; width: 100%; height: 89.3907px;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">参数名称</td><td style="height: 29.7969px;">参数值</td><td style="height: 29.7969px;">是否必填</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Content-Type</td><td style="height: 29.7969px;">application/json</td><td style="height: 29.7969px;">是</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr></tbody></table>

### Body

<table border="1" id="bkmrk-%E5%8F%82%E6%95%B0%E5%90%8D%E7%A7%B0-%E7%B1%BB%E5%9E%8B-%E5%BF%85%E5%A1%AB-%E9%BB%98%E8%AE%A4%E5%80%BC-%E5%A4%87%E6%B3%A8-%E5%85%B6%E4%BB%96" style="border-collapse: collapse; width: 100%; height: 1593px;"><colgroup><col style="width: 30.9796%;"></col><col style="width: 12.2862%;"></col><col style="width: 6.7938%;"></col><col style="width: 16.6865%;"></col><col style="width: 16.6865%;"></col><col style="width: 16.6865%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">参数名称</td><td style="height: 29.7969px;">类型</td><td style="height: 29.7969px;">必填</td><td style="height: 29.7969px;">默认值</td><td style="height: 29.7969px;">备注</td><td style="height: 29.7969px;">其他信息</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">channelInfoList</td><td style="height: 29.7969px;">array</td><td style="height: 29.7969px;">是</td><td style="height: 29.7969px;">通知渠道列表</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"> |\_\_action</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">是</td><td style="height: 46.5938px;">VerifyCodeNotify</td><td style="height: 46.5938px;">通知action</td><td style="height: 46.5938px;">最大长度：24  
最小长度：1</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"> |\_\_channelAppId</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">是</td><td style="height: 46.5938px;">ebuy19915d0498cf</td><td style="height: 46.5938px;">通知渠道appId</td><td style="height: 46.5938px;">最大长度：24  
最小长度：1</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"> |\_\_channelId</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">是</td><td style="height: 46.5938px;">ebuywha102410004</td><td style="height: 46.5938px;">通知渠道id</td><td style="height: 46.5938px;">最大长度：24  
最小长度：1</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"> |\_\_channelName</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">是</td><td style="height: 46.5938px;">易百演示</td><td style="height: 46.5938px;">通知渠道名称</td><td style="height: 46.5938px;">最大长度：16  
最小长度：1</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"> |\_\_channelType</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">是</td><td style="height: 46.5938px;">saleChannel</td><td style="height: 46.5938px;">通知渠道类型</td><td style="height: 46.5938px;">最大长度：12  
最小长度：1</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"> |\_\_messageType</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">是</td><td style="height: 46.5938px;">ebuy</td><td style="height: 46.5938px;">通知消息格式</td><td style="height: 46.5938px;">最大长度：12  
最小长度：1</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"> |\_\_notifyType</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">是</td><td style="height: 46.5938px;">Verify</td><td style="height: 46.5938px;">通知消息类型</td><td style="height: 46.5938px;">最大长度：12  
最小长度：1</td></tr><tr style="height: 39.7969px;"><td style="height: 39.7969px;"> |\_\_ticketIds</td><td style="height: 39.7969px;">array</td><td style="height: 39.7969px;">是</td><td style="height: 39.7969px;">券批次活动id</td><td style="height: 39.7969px;">  
</td><td style="height: 39.7969px;">  
</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"> |\_\_transferUrl</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">否</td><td style="height: 46.5938px;">通知渠道三方地址</td><td style="height: 46.5938px;">  
</td><td style="height: 46.5938px;">最大长度：255  
最小长度：1</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">appId</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">是</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">核销请求appid</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 31.375px;"><td style="height: 31.375px;">codeCount</td><td style="height: 31.375px;">number</td><td style="height: 31.375px;">否</td><td style="height: 31.375px;"> </td><td style="height: 31.375px;"> </td><td style="height: 31.375px;"> </td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">createDate</td><td style="height: 29.7969px;">number</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;">最大长度：8</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">items</td><td style="height: 29.7969px;">array</td><td style="height: 29.7969px;">是</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_activityId</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_activityName</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_brandSalePrice</td><td style="height: 29.7969px;">number</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_codeCount</td><td style="height: 29.7969px;">number</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_codeDetails</td><td style="height: 29.7969px;">array</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_code</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">券码</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_codeH5Url</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">券码链接</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_codeMask</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_codePicUrl</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_searchCode</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_status</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_statusDesc</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_useTimes</td><td style="height: 29.7969px;">number</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_ticketId</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">券批次id</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_ticketName</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">券批次名称</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_ecouponType</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_outerOrderItemId</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_productId</td><td style="height: 29.7969px;">number</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_productName</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_returnCode</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_returnMessage</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_ticketWhaleId</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_validEnd</td><td style="height: 29.7969px;">number</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_validStart</td><td style="height: 29.7969px;">number</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_userInfo</td><td style="height: 29.7969px;">object</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">制码用户信息</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"> |\_\_mobile</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">否</td><td style="height: 46.5938px;">  
</td><td style="height: 46.5938px;">制码上送用户手机号</td><td style="height: 46.5938px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_thirdUserId</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">制码上送用户id</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_thirdPlatformType</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">上送平台类型</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_uuid</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_orderRemark</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;"> </td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_outerOrderId</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_saleAppId</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"> |\_\_saleChannelId</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">否</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td><td style="height: 29.7969px;">  
</td></tr></tbody></table>

参数请参考（原始参数均来自券系统4.1）：[制码通知 | e-Buy Docs](https://book.e-buy.com/books/e-buy-41/page/a516a)

### 请求示例

```json
{
    "outerOrderId": "20591242205212698112000",
    "userInfo": {

    },
    "channelInfoList": [
        {
            "transferUrl": "https://ups.starbucks.com.cn/***",
            "notifyType": "MakeCode",
            "whaleChannel": false,
            "messageType": "third",
            "channelAppId": "ebuywha102410120",
            "action": "MakeCodeNotify",
            "channelName": "星巴克GC",
            "channelType": "brandChannel",
            "channelId": "674",
            "ticketIds": [
                1000000010882
            ]
        }
    ],
    "codeCount": 1,
    "saleChannelId": 138,
    "appId": "ebuywha102410120",
    "saleAppId": "ebuywha102410120",
    "orderRemark": "{\"trackingNo\":\"COU20210825001\"}",
    "items": [
        {
            "codeCount": 1,
            "productId": 5249,
            "brandSalePrice": -1,
            "validStart": -62170185600000,
            "activityName": "【星巴克GC】 星巴克电子券平台运维-2021第13期",
            "returnMessage": "SUCCESS",
            "thirdSendTicketId": "C0002204",
            "productName": "大杯饮品电子券\t",
            "ticketUseDescription": {
                "useThreshold": "3400"
            },
            "activityId": "503152",
            "returnCode": "00",
            "ecouponType": "exchangeCoupon",
            "outerOrderItemId": "20591242205212698112000",
            "validEnd": -62170185600000,
            "codeDetails": [
                {
                    "code": "1004240520320002019=JN3kEB19",
                    "statusDesc": "未激活",
                    "codeH5Url": "https://w.ebuy.io/lk/dtnGGoWZGf",
                    "codeMask": "100***EB19",
                    "searchCode": "1004240520320002019",
                    "status": "03",
                    "useTimes": 1
                }
            ],
            "ticketId": 1000000010882,
            "ticketWhaleId": "519423_1000000010882",
            "ticketName": "大杯饮品电子券\t"
        }
    ],
    "uuid": "20240520-78293a474547477f97f3f074ebbf8ba8",
    "createDate": 1716206401876
}
```

## 响应

### 响应参数

<table border="1" id="bkmrk-%E5%8F%82%E6%95%B0%E5%90%8D%E7%A7%B0-%E7%B1%BB%E5%9E%8B-%E5%BF%85%E5%A1%AB-%E9%BB%98%E8%AE%A4%E5%80%BC-%E5%A4%87%E6%B3%A8-%E5%85%B6%E4%BB%96-1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col><col style="width: 16.6667%;"></col></colgroup><tbody><tr><td>参数名称</td><td>类型</td><td>必填</td><td>默认值</td><td>备注</td><td>其他信息</td></tr><tr><td>code</td><td>string</td><td>是</td><td>  
</td><td>响应码</td><td>  
</td></tr><tr><td>message</td><td>string</td><td>否</td><td>  
</td><td>响应消息</td><td>  
</td></tr></tbody></table>

### 响应示例

```json
{"code":"EB_SUCCESS","message":"操作成功"}
```

注意：

响应码不为<span style="background-color: rgb(251, 238, 184);">EB\_SUCCESS 或 <span style="background-color: rgb(251, 238, 184);">EB\_FAIL</span></span> 易百将会进行重试，请保证接口幂等性。

- <span style="background-color: rgb(251, 238, 184);">{"code":"EB\_SUCCESS","message":"操作成功"} // 业务处理成功，不重试</span>
- <span style="background-color: rgb(251, 238, 184);">{"code":"EB\_FAIL","message":"操作失败"} // 业务处理失败，不重试</span>
- <span style="background-color: rgb(251, 238, 184);">其他未知失败 // 重试</span>