隐私保护通话 PRIVATENUMBER-短信通知接口:请求参数
下载隐私保护通话 PRIVATENUMBER用户手册完整版
请求参数
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
Content-Type |
是 |
String |
固定填写为application/json;charset=UTF-8。 |
Authorization |
是 |
String |
固定填写为WSSE realm="SDP",profile="UsernameToken",type="Appkey"。 |
X-WSSE |
是 |
String |
取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。
|
编程语言 |
时间格式 |
|---|---|
Java |
yyyy-MM-dd'T'HH:mm:ss'Z' |
PHP |
Y-m-d\TH:i:s\Z |
Python |
%Y-%m-%dT%H:%M:%SZ |
C# |
yyyy-MM-ddTHH:mm:ssZ |
Node.js |
toISOString().replace(/.[0-9]+\Z/, 'Z') 注：Node.js中，使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
appKey |
是 |
String(1-32) |
隐私保护通话 应用的APP_Key。 |
smsEvent |
是 |
SMS EventInfoType |
短信状态事件。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
smsIdentifier |
是 |
String(1-64) |
短信唯一标识。 若用户发送的是长短信，隐私保护通话平台会将长短信的多个分片合并为一个通知上报。 |
notificationMode |
是 |
String(1-8) |
通知模式：
|
calling |
否 |
String(1-32) |
真实发送方号码。 号码为全局号码格式（包含国家码），比如+86138****7021。 |
called |
否 |
String(1-32) |
真实接收方号码。 仅在隐私保护通话平台转发短信成功后携带。 号码为全局号码格式（包含国家码），比如+86138****7022。 |
virtualNumber |
否 |
String(1-32) |
X号码。 号码为全局号码格式（包含国家码），比如+86138****0001。 |
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 |
发送结果。
|
areaCode |
否 |
String(0-32) |
隐私保护号码（X号码）的城市码。 说明：
使用该参数的场景请联系华为云客服获取。 |
userData |
否 |
String(1-256) |
用户附属信息。 说明：
使用该参数的场景请联系华为云客服获取。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
extParas |
是 |
JsonArray |
扩展信息(Key-Value)列表。 格式如下： "extParas": [{"key": "splitNum","value": "value1"},{"key": "direction","value": "value2"}] Key、Value取值分别不能超过32个字节。 “key”取值为“splitNum”时表示实际短信发送成功数量，即长短信拆分后的短信数量。value1表示“splitNum”的取值。 “key”取值为“direction”时表示短信发送方向。value2表示“direction”取值，含义如下：
|
