短信通知接口
接口功能
隐私保护通话平台通过此接口向客户服务器推送隐私号短信通知。
通知模式为Notify模式，客户收到通知后返回HTTP状态码为200的空消息即可。
AXB模式发送小号短信的流程如下：
A或B发送短信给X，隐私保护通话平台将短信转发给绑定关系的另一方（发送方号码是X），并推送Notify模式的小号短信通知给客户服务器。
请求方向
隐私保护通话平台（客户端） → 客户服务器（服务端）
使用说明
前提条件
- 客户添加应用时需设置短信通知接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。
- 若需要接收用户发送的短信内容，请参考如何设置才能收到短信内容？进行设置。
- 如果需要开启短信事件通知重传功能，需提前向系统管理员申请。该功能开启后，当隐私保护通话平台推送短信事件通知给客户服务器失败时，隐私保护通话平台会重传事件通知给客户服务器。最多重传6次，每次重传时间间隔可由系统管理员设置。
接口类型
请求方法 |
POST |
|---|---|
访问URI |
客户应用设置的接收短信通知的URL |
通信协议 |
HTTPS |
请求参数
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
appKey |
是 |
String(1-32) |
隐私保护通话应用的APP_Key。 |
smsEvent |
是 |
短信状态事件。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
smsIdentifier |
是 |
String(1-64) |
短信唯一标识。 若用户发送的是长短信，隐私保护通话平台会将长短信的多个分片合并为一个通知上报。 |
notificationMode |
是 |
String(1-8) |
通知模式： Notify：通知模式。 |
calling |
否 |
String(1-32) |
真实发送方号码。 号码为全局号码格式（包含国家码），比如+8613866887021。 |
called |
否 |
String(1-32) |
真实接收方号码。 仅在隐私保护通话平台转发短信成功后携带。 号码为全局号码格式（包含国家码），比如+8613866887022。 |
virtualNumber |
否 |
String(1-32) |
X号码。 号码为全局号码格式（包含国家码），比如+8613800000001。 |
event |
是 |
String(1-16) |
短信状态事件。 TextSMS：文本短信 |
timeStamp |
是 |
String(1-32) |
短信事件发生的系统时间戳，UTC时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' 其中SSS是毫秒，“T”和“Z”为固定字符。 |
extInfo |
是 |
拓展信息。 |
|
subscriptionId |
否 |
String(1-64) |
绑定ID。 |
smsContent |
否 |
String(1-2000) |
用户发送的短信内容。 请参考如何设置才能收到短信内容？开通改功能。 |
sendResult |
是 |
Integer |
发送结果。
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
extParas |
是 |
JsonArray |
扩展信息(Key-Value)列表。 格式如下： "extParas": [{"key": "splitNum","value": "value1"},{"key": "direction","value": "value2"}] Key、Value取值分别不能超过32个字节。 “key”取值为“splitNum”时表示实际短信发送成功数量，即长短信拆分后的短信数量。value1表示“splitNum”的取值。 “key”取值为“direction”时表示短信发送方向。value2表示“direction”取值，含义如下：
|
响应参数
客户服务器接收到隐私保护通话平台Notify模式的短信事件通知后，返回无消息体的200响应。
接口示例
接口示例仅供参考，请以实际消息为准。
- 请求示例
POST /notify HTTP/1.1 Content-Type: application/json;charset=UTF-8 { "appKey":"S368k6Y31w4kNuI6X1gsne5n09gA", "smsEvent":{"smsIdentifier":"db2e7744804f4c5aa7d923aeddb42443", "notificationMode":"Block", "calling":"+8613800000001", "virtualNumber":"+8613800000000", "event":"TextSMS", "timeStamp":"2018-09-13T09:46:16.023Z", "extInfo":{"extParas":[{"key":"splitNum","value":"2"},{"key": "direction","value": "1"}]}, "sendResult":0 } } - 响应示例
HTTP/1.1 200 OK
相关文档
相关产品
