You need to enable JavaScript to run this app.
导航

短信上行回调

最近更新时间2023.09.08 11:43:17

首次发布时间2023.01.17 16:25:05

您可以在短信服务控制台的回执配置中设置上行回调 URL,用于接收用户的上行短信内容。

注意事项

回调地址需要符合以下条件,才可以成功接收用户的上行短信内容。

  • 使用 HTTP/HTTPS URL。

  • 短信服务可以直接访问回调地址,即回调地址具备公网访问能力。

  • 如果回调地址所在服务器设置了防火墙,请放行来自短信服务的请求。

准备工作

在您接收短信服务的上行回调消息之前,需要登录短信服务控制台配置用于接收上行回调消息的 URL。

  1. 登录短信服务控制台

  2. 在左侧导航栏,选择通用管理 > 回执配置

  3. 回执配置页面,编辑默认上行地址

    设置您用于接收回调消息的 URL。URL 格式为http(s)://<您的回调地址>


在短信服务控制台设置回调地址后,当终端手机用户发送上行短信时,则短信服务会异步向回调地址返回短信上行报告。

回调请求说明

当短信服务返回短信状态报告时,会向回调地址发送 POST 请求。本章节介绍请求 Header 和 Body 包含的参数说明。

参数取值描述
Content-Typeapplication/json;charset=utf-8定义网络文件的类型和网页的编码。
Accept-Encodinggzip, deflate采用指定的压缩格式传输数据。
Accept*/*指定客户端希望接收的数据类型。

Body

请求体整体是一个 JSON 数组。

参数类型描述
accountstring火山引擎账号
sub_accountstring消息组ID
signaturestring下行签名,单上行通道即为空
contentstring上行内容
mobilestring手机号
channel_typestring短信类型
service_idstring发送通道,非必传,国际/港澳台短信没有该字段
recv_timeint64收到上行时间
extstring发送时传递的Tag字段

回调结果示例

[
    {
        "account":"2000****",
        "sub_account":"049c****",
        "signature":"测试发送",
        "content":"hhhhh",
        "mobile":"181****9843",
        "channel_type":"CN_OTP",
        "service_id":"106966940****",
        "recv_time": 1651760981000, // 收到上行时间
        "ext":"1047"
    }
]

返回值

要求用户侧接收成功后,返回 httpStatus为200,否则火山侧会认为回执失败

常见问题

  1. 上行推送失败后会重试几次?

答:10次,时间间隔:[0,5,10,30,120,300,1200,3600,21600,86400],单位秒。

  1. 返回httpStatus为200的格式是怎样的?

答:http协议里的statuscode返200即可,不是在请求体中返回。