短链接点击结果回调--短信服务-火山引擎

文档中心

立即注册

导航

短链接点击结果回调

最近更新时间：2023.07.06 16:10:00首次发布时间：2023.01.16 23:06:12

您可以在短信服务控制台的回执配置中设置回调 URL，用于接收短链接的点击详情。

注意事项

回调地址需要符合以下条件，才可以成功接收短链接的点击详情。

使用 HTTP/HTTPS URL。
短信服务可以直接访问回调地址，即回调地址具备公网访问能力。
如果回调地址所在服务器设置了防火墙，请放行来自短信服务的请求。

准备工作

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

登录短信服务控制台。
在左侧导航栏，选择通用管理 > 回执配置。
在回执配置页面，编辑短链点击状态回调地址。
设置您用于接收回调消息的 URL。URL 格式为http(s)://<您的回调地址>。

在短信服务控制台设置回调地址后，当模版中配置转换成短链接且统计点击时，短信服务会异步向回调地址返回短链接点击状况。

回调请求说明

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

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

Body

请求体整体是一个 JSON Object。

参数	类型	说明
account	string	火山引擎账号
sub_account	string	消息组ID
mobile	string	手机号
message_id	string	消息ID
token	string	短链接的token
target	string	原始长链接
ip	string	请求IP
ua	string	用户代理
click_time	long	点击跳转时间

回调结果示例

{
        "account":"2000****",
        "sub_account":"049c****",
        "mobile":"181****9843",
        "message_id":"bde1b10d-19cf-460f-abcd-26231a82****",
        "token":"",
        "target":"",
        "ip":"106966940****",
        "ua":"",
        "click_time": 1651760981000
    }

返回值

要求用户侧接收成功后，返回 httpStatus为200，否则火山侧会认为回调失败。
回调失败不重推。