You need to enable JavaScript to run this app.

拉取短信上行

最近更新时间：2023.01.17 16:18:33

首次发布时间：2023.01.17 16:18:33

短信服务调用方可通过消息组+密码+拉取的条数，拉取短信上行

接口说明

  • 请求方式：POST

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

  • 注意事项：

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

    • 已经被拉取过的上行，无法被再次拉取

请求参数

参数数据类型是否必填示例值描述

Content-Type

string

是

application/json;charset=utf-8

指定请求消息体的结构化格式。短信服务的 Content-Type 为application/json;charset=utf-8。

Body

参数类型是否必填示例值描述
sub_accountstring是6df864b1消息组ID
passwordstring是********密码
countint是200拉取条数，最大拉取条数200

返回参数

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

参数类型说明
accountstring火山引擎账号
sub_accountstring消息组ID
signaturestring签名
contentstring上行内容
mobilestring手机号
channel_typestring短信类型
service_idstring发送通道，非必传，国际/港澳台短信没有该字段
extstring用户透传字段
recv_timestring收到上行时间

示例

请求示例

{
    "sub_account": "71f67923",
    "password": "1234567",
    "count": 1
}

返回示例

  • 成功响应示例
[
    {
        "account":"2100001206", // 火山账号
        "sub_account":"078f8037",//消息组ID
        "signature":"",//短信签名
        "content":"hhhhh", // 上行内容
        "mobile":"", //手机号
        "channel_type":"CN_OTP", // 短信发送类型: 验证码 通知 营销
        "service_id":"106920088418200001",
        "ext":"ext", // 用户透传字段
        "recv_time": 1651760981000 // 收到上行时间
    }
]
  • 失败响应示例
{
    "status_code": -1,
    "status_message": "auth failed"
}

错误码

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

CodeMessage说明处理建议
-1错误描述