﻿短信服务使用方可通过消息组+密码+拉取的条数，拉取短信回执

<span id="接口说明"></span>
## 接口说明


* 请求方式：`POST`

* 接口地址：`https://sms.volcpartner.com/generic/receipt`

* 注意事项：

   * 当记录被拉取后，会被记录成已获取状态；再次请求此接口时，会继续返回未返回过的数据

   * 已经被拉取过的回执，无法被再次拉取


<span id="请求参数"></span>
## 请求参数

<span id="header"></span>
### **Header**


|**参数** |**数据类型** |**是否必填** |**示例值** |**描述** |
|---|---|---|---|---|
|Content\-Type |string |是 |application/json;charset=utf\-8 |指定请求消息体的结构化格式。短信服务的 Content\-Type 为`application/json;charset=utf-8`。 |


<span id="body"></span>
### Body


|**参数** |**类型** |**是否必填** |**示例值** |**描述** |
|---|---|---|---|---|
|sub_account |string |是 |6df864b1 |消息组ID |
|password |string |是 |\*\*\*\*\*\*\*\* |密码 |
|count |int |是 |200 |拉取条数，最大拉取条数200 |


<span id="返回参数"></span>
## 返回参数

请求响应数据以JSON格式返回，以下仅列出了短信业务逻辑相关的字段，其他公共返回参数详见[返回结果](https://www.volcengine.com/docs/6369/80336)。


|**参数** |**数据类型** |**描述** |
|---|---|---|
|account |string |火山引擎账号 |
|sub_account |string |消息组ID |
|signature |string |签名 |
|template_id |string |模板ID |
|mobile |string |手机号 |
|channel_type |string |短信类型 |
|ext |string |发送时传递的“tag”字段 |
|message_id |string |发送时返回的meassage_id |
|status_code |string |发送状态，"0"代表成功，其余表示失败 |
|description |string |状态描述 |
|msg_count |int |拆分条数 |
|service_id |string |发送通道，非必传，国际/港澳台短信没有该字段 |
|send_time |string |发送时间 |
|recv_time |string |1651760981000 |


<span id="示例"></span>
## 示例

<span id="请求示例"></span>
### 请求示例

```json
{
    "sub_account": "6df864b1",
    "password": "********",
    "count": 200
}
```


<span id="返回示例"></span>
### 返回示例


* **正确返回\*\*\*\*示例**


```json
[
  {
    "account": "",//火山账号
    "sub_account": "",//消息组ID
    "signature": "", //短信签名
    "template_id": "",//模板ID
    "mobile": "", //明文手机号
    "channel_type": "CN_OTP", //短信发送类型: 验证码 通知 营销
    "ext": "", // 透传字段，在发送时传入
    "message_id": "", // 发送时返回的全局唯一ID
    "status_code": "0", //状态，0为成功，其他均为失败
    "description": "DELIVRD", // 状态描述
    "msg_count": 1, //拆分条数
    "service_id": "10691724452300001", // 下发通道号,非必传
    "send_time": 1651760981000, // 发送时间
    "recv_time": 1651760981000 // 收到回执时间
  }
]
```



* **失败响应示例**


```json
{
    "status_code": -1,
    "status_message": "auth failed"
}
```


<span id="status-code及说明"></span>
## Status_code及说明


|<div style="text-align: center"><br><strong>错误码</strong></div><br> |**描述** |**处理建议** |
|---|---|---|
|<div style="text-align: center"><br>NE:0100</div><br> |非法手机号 |建议更换手机号码后尝试重新下发 |
|<div style="text-align: center"><br>NE:0101</div><br> |停机，空号 |请确认手机号码是否为正常状态 |
|<div style="text-align: center"><br>NE:0102</div><br> |号码漫游、不在服务状态 |建议用户开通漫游权限重新尝试 |
|<div style="text-align: center"><br>NE:0103</div><br> |终端异常，如信号不稳定、手机对短信支持异常等 |请检查手机当前接收状态是否正常，或重启手机刷新网络，尝试重新获取。 |
|<div style="text-align: center"><br>NE:0104</div><br> |终端无短信服务 |请确认手机号码是否为正常状态，是否开通短信功能。 |
|<div style="text-align: center"><br>NE:0105</div><br> |关机或无响应 |请确认手机终端是否正常开机可用 |
|<div style="text-align: center"><br>NE:0106</div><br> |携号转网问题 |建议尝试重新发送，或联系火山引擎客服处理 |
|<div style="text-align: center"><br>CR:0200</div><br> |内容拦截 |内容中包含管控关键词，请对文案进行优化 |
|<div style="text-align: center"><br>CR:0201</div><br> |黑名单拦截 |用户已退订此签名或命中运营商平台黑名单规则，建议征求用户意见联系运营商平台解除黑名单 |
|<div style="text-align: center"><br>CR:0202</div><br> |频次管控 |请合理控制号码的下发频次 |
|<div style="text-align: center"><br>CR:0203</div><br> |时间段管控 |请错开管控时间段（早8晚9点半）进行信息下发 |
|<div style="text-align: center"><br>CR:0204</div><br> |计费异常 |请登录控制台[费用中心](https://console.volcengine.com/finance/account-overview/)查询余额是否充足 |
|<div style="text-align: center"><br>CR:0205</div><br> |审核拦截 |内容不符合管控要求，请优化文案 |
|<div style="text-align: center"><br>CR:0206</div><br> |超流速拦截 |建议降低短信提交的QPS |
|<div style="text-align: center"><br>CR:0207</div><br> |压测模式拦截 |压测模式不实际下发，若需关闭压测模式，请联系火山引擎客服。 |
|<div style="text-align: center"><br>CR:0208</div><br> |超流量拦截 |超出流量管控限制 |
|<div style="text-align: center"><br>CR:0209</div><br> |发送类型与实际地区不匹配 |请只在允许下发地区进行发送或申请开通该地区的下发 |
|<div style="text-align: center"><br>CR:0210</div><br> |未开通的国家/地区 |请只在允许下发地区进行发送或申请开通该地区的下发 |
|<div style="text-align: center"><br>CR:0212</div><br> |签名拦截 |请更换签名下发或重新申请符合[签名规范](https://www.volcengine.com/docs/6361/67325#%E5%86%85%E5%AE%B9%E5%A1%AB%E5%86%99%E8%A7%84%E8%8C%83)的签名 |
|<div style="text-align: center"><br>CR:0213</div><br> |重复发送相同内容 |短时间内，请不要对同一个手机号下发相同的内容 |
|<div style="text-align: center"><br>CR:0215</div><br> |签名报备问题（一码一签） |请联系火山引擎客服完善一码一签报备 |
|<div style="text-align: center"><br>CE:0300</div><br> |模板参数格式问题 |请检查模板变量报文格式是否正确 |
|<div style="text-align: center"><br>CE:0301</div><br> |内容过长或未填写 |请对短信文案长度进行优化 |
|<div style="text-align: center"><br>CE:0302</div><br> |长短信缺失 |请检查长短信拆分和提交是否正确 |
|<div style="text-align: center"><br>CE:0304</div><br> |不支持的发送类型 |请登录控制台，在[消息组列表](https://console.volcengine.com/sms/subaccount/list)点击编辑，检查允许发送的短信类型是否勾选 |
|<div style="text-align: center"><br>CE:0305</div><br> |不支持发送的运营商 |请联系火山引擎客服确认 |
|<div style="text-align: center"><br>SY:0500</div><br> |系统异常 |若个别下发失败，建议尝试重新发送；若出现大量失败，请联系火山引擎客服进行确认 |
|<div style="text-align: center"><br>SY:0501</div><br> |网关问题 |若个别下发失败，建议尝试重新发送；若出现大量失败，请联系火山引擎客服进行确认 |
|<div style="text-align: center"><br>UN:0900</div><br> |未知错误 |若个别下发失败，建议尝试重新发送；若出现大量失败，请联系火山引擎客服进行确认 |
|<div style="text-align: center"><br>ZJ10300</div><br> |The Phone number over frequency control. |传入电话号码超过频控 |
|<div style="text-align: center"><br>:\-\-</div><br> |:\-\- |:\-\- |
|<div style="text-align: center"><br>ZJ10301</div><br> |Illegal Content |传入内容有问题，可能是触发关键字等情况 |
|<div style="text-align: center"><br>ZJ10302</div><br> |The phone number is on the blacklist. |传入电话号码在block名单中，全局黑名单，需要后台解除 |
|<div style="text-align: center"><br>ZJ10303</div><br> |Out of Service. |企业已停止短信服务/账号欠费等 |
|<div style="text-align: center"><br>ZJ10304</div><br> |Non\-industry SMS, or high complaint content. |非行业短信，或高投诉内容 |
|<div style="text-align: center"><br>ZJ10305</div><br> |Sign is on the block list |签名黑名单 |
|<div style="text-align: center"><br>ZJ10306</div><br> |Unsubscribe words is wrong or none. please check the content of the marketing message. |营销短信未带退订方式说明 |
|<div style="text-align: center"><br>ZJ10307</div><br> |repeat sending in a short time in terms of referenceId.Invalid operation to the record, please check the status and the permission |短时间内发送了同样的内容给同样的手机号 |
|<div style="text-align: center"><br>ZJ10308</div><br> |Invalid operation to the record, please check the status and the permission |短信群发专用错误。取消群发任务时，剩余未发送短信会发送失败 |
|<div style="text-align: center"><br>ZJ10309</div><br> |The url in the content is illegal. |内容中有高风险 URL |
|<div style="text-align: center"><br>ZJ20000</div><br> |Other |其他，请与客户支持联系 |
|<div style="text-align: center"><br>ZJ20001</div><br> |illegal_number |非法手机号 |
|<div style="text-align: center"><br>ZJ20002</div><br> |illegal_account_password |用户名密码错误 |
|<div style="text-align: center"><br>ZJ20003</div><br> |content_length_limit |内容超过长度限制 |
|<div style="text-align: center"><br>ZJ20004</div><br> |number_not_exist |空号 |
|<div style="text-align: center"><br>ZJ20005</div><br> |intercept |短信拦截，内容，流速，参数等原因 |
|<div style="text-align: center"><br>ZJ20006</div><br> |block_list |号码在黑名单中 |
|<div style="text-align: center"><br>ZJ20007</div><br> |abnormal_state |关停欠费携号转网等异常状态 |
|<div style="text-align: center"><br>ZJ20008</div><br> |vendor_problem |供应商及其下游通道问题 |
|<div style="text-align: center"><br>ZJ20009</div><br> |signature_problem |签名相关问题 |


<span id="错误码"></span>
## 错误码

如果您在返回结果中遇到错误消息，可以使用下表作为详细信息和解决方案的指南。其中火山引擎网关公共错误码请参考[火山引擎网关公共错误码](https://www.volcengine.com/docs/6369/68677)。


|**Code** |**Message** |**说明** |**处理建议** |
|---|---|---|---|
|\-1 |错误描述 | | |




