短信明细推送回调
更新时间:2025-11-07
描述
外呼系统通过用户配置的回调地址将短信明细进行推送
URL
回调地址(配置台-API配置-其他配置)
HTTP Method
POST
请求参数
| 参数名称 | 类型 | 是否必须 | 说明 | 示例 |
|---|---|---|---|---|
| callbackType | int | 是 | 回调数据类型: 0-任务呼叫单通电话回调 1-号码组终态回调 2-任务状态变更回调 3-实时呼叫单通电话回调 4-呼入单通电话回调 5-短信明细回调 | 5 |
| data | obj | 是 | 短信明细数据对象 | — |
data字段
| 字段 | 类型 | 是否必填 | 说明 | 示例 | |
|---|---|---|---|---|---|
| tenantId | long | 是 | 租户唯一标识 | 10945 | |
| smsId | string | 是 | 短信唯一标识 | "202410201234567890" | |
| taskId | string | 否 | 任务标识 | "874634757898496" | |
| mobile | string | 是 | 接收短信手机号(明文) | "13800000000" | |
| signatureId | string | 否 | 短信签名ID | "1001" | |
| templateId | string | 否 | 模板ID | "2002" | |
| providerId | string | 否 | 供应商 '1' = 百度简单消息(内置平台)'2' = 客户自有第三方短信平台(通过 HTTP 集成,HTTP_SMS)'3' = 百盛(通过 HTTP 集成,HTTP_BS_SMS)'4' = 云通信短信能力(内置平台,PNS_SMS) | "4" | |
| sendStatus | string | 否 | 短信发送状态(说明见下表) | "0" | |
| statusInfo | string | 否 | 状态描述(说明见下表) | "发送失败(超频)" | |
| sendTime | long | 否 | 调用服务商接口的时间,毫秒时间戳 | 1734710400000 | |
| receiptTime | long | 否 | 接受到PNS的回调时间,毫秒时间戳 | 1734710405123 | |
| smsContent | string | 否 | 短信内容 | "感谢你的接听,祝你生活愉快" | |
| smsVar | obj | 否 | 短信变量 | { "code": "1234", "minutes": "5" } | |
| source | int | 是 | 标识回调时机 1 表示发送后收到短信平台响应的推送(非最终回执)2 表示收到云短信/运营商最终回执的推送。 | 2 | |
| sessionId | string | 否 | 会话ID | "5083599462301697_263cbce31cc34ecb950fa0f1b79a219d" | |
| triggerTactics | int | 是 | 触发短信策略类型 节点事件触发(0)、接通后挂机触发(1)、未接通后挂机触发(2)、审核结果通知触发(3)、大模型抽取标签命中自定义标签触发(4)、短信插件触发(5)、预约触发(6)、振铃后触发(7)、接通后立即触发(8) ,短信任务触发(9)。 | 9 | |
| messageId | string | 是 | 消息流水ID | "msg_202410201234567890" | |
| secretId | long | 否 | 密钥Id | "3947847300939776" | |
| secretType | int | 否 | 加密类型 | 1 |
短信状态码映射说明
| 数字码 | 文字说明 |
|---|---|
| -1 | 短信发送失败(调用异常) |
| 0 | 短信发送成功 |
| 2 | 短信发送失败(其他原因) |
| 3 | 短信发送中 |
| 4 | 短信发送失败(黑名单) |
| 5 | 短信发送失败(超频) |
| 6 | 短信发送失败(空号) |
| 7 | 短信发送失败(停机) |
| 8 | 短信发送失败(禁发-400号码) |
| 9 | 短信发送失败(禁发-800号码) |
| 10 | 短信发送失败(禁发-固话号码) |
| 11 | 短信发送失败(禁发-95号码) |
| 12 | 短信发送失败(禁发-96号码) |
| 13 | 短信发送失败(禁发-其他号码) |
| 14 | 短信发送失败(重复号码) |
请求示例
Plain Text
1{
2 "callbackType": 5,
3 "data": {
4 "tenantId": 10945,
5 "smsId": "cmsg_202410201234567890",
6 "taskId": "874634757898496",
7 "mobile": "13800000000",
8 "sendStatus": "0",
9 "statusInfo": "发送成功",
10 "receiptStatus": "0",
11 "sendTime": 1734710400000,
12 "receiptTime": 1734710405123,
13 "smsContent": "您的验证码为1234,5分钟内有效。",
14 "providerId": "1",
15 "signatureId": "1001",
16 "templateId": "2002",
17 "smsVar": { "code": "1234", "minutes": "5" },
18 "secretType": 3003,
19 "secretId": 3003,
20 "statusCode": "0",
21 "triggerTactics": 1,
22 "source": 1,
23 "sessionId": "5083599462301697_263cbce31cc34ecb950fa0f1b79a219d",
24 "messageId": "msg_202410201234567890"
25 }
26}
响应要求
Plain Text
1{
2 "code": 200,
3 "msg": "success"
4}
