拉取短信回执

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

接口说明

• 请求方式：POST

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

• 注意事项：

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

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

请求参数

Header

Body

返回参数

请求响应数据以JSON格式返回，以下仅列出了短信业务逻辑相关的字段，其他公共返回参数详见返回结果。

示例

请求示例

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

返回示例

• 正确返回****示例

[
  {
    "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 // 收到回执时间
  }
]

• 失败响应示例

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

Status_code及说明

错误码

如果您在返回结果中遇到错误消息，可以使用下表作为详细信息和解决方案的指南。其中火山引擎网关公共错误码请参考火山引擎网关公共错误码。