隐私保护通话 PRIVATENUMBER-AX模式绑定接口:请求参数
下载隐私保护通话 PRIVATENUMBER用户手册完整版
请求参数
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
Content-Type |
是 |
String |
固定填写为application/json;charset=UTF-8。 |
|
Authorization |
是 |
String |
固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 |
|
X-AKSK |
是 |
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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 |
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
origNum |
是 |
String(1-32) |
AX中的A号码。 填写为全局号码格式。
说明：
因运营商管控，固话号码只能接收来自X号码的呼叫，不能作为主叫呼叫X号码。即当A号码为固话号码时，其他用户（手机号码）可以拨打X号码联系A，但A无法通过拨打X号码联系其他用户。 |
|
privateNum |
否 |
String(1-32) |
指定已申请到的X号码进行绑定。 可在 隐私保护通话 控制台的“号码管理”页面或订购号码成功后返回的号码表中查看已申请到的X号码。 填写为全局号码格式（国家码+11位数字的手机号码），如：+86138****0021。
说明：
|
|
areaCode |
否 |
String(0-32) |
指定城市码，由隐私保护通话平台从客户已申请到的X号码中选择可用号码进行绑定。 填写为标准格式的城市码，如：0755、010等。 X号码对应城市码可在订购号码成功后返回的号码表中查看，点击查看如何下载号码表。
说明：
|
|
privateNumType |
否 |
String(枚举) |
固定填写为mobile-virtual。
说明：
当参数privateNum为空时必须携带该参数。 |
|
areaMatchMode |
否 |
String(枚举) |
号码筛选方式。
说明：
|
|
recordFlag |
否 |
String(枚举) |
是否需要针对该绑定关系产生的所有通话录音。
如果不携带该参数，系统默认不录音。
说明：
该参数仅当客户添加应用时申请开通了录音功能才有效。 |
|
recordHintTone |
否 |
String(1-128) |
该参数仅在recordFlag为true时有效。 该参数用于设置录音提示音，填写为放音文件名，可在放音文件管理页面查看。
说明：
因隐私协议及运营商管控，录音的呼叫必须携带该参数，否则呼叫会被运营商拦截。 |
|
preVoice |
否 |
设置个性化通话前等待音，即主叫听到的回铃音。 |
|
|
calleeNumDisplay |
否 |
String(枚举) |
设置非A用户呼叫X时，A接到呼叫时的主显号码。 取值：
说明：
使用该参数的场景请联系华为云客服获取。由于运营商管控，当前平台要求该参数必须设置为0，否则绑定会失败、呼叫会被运营商拦截。 |
|
privateSms |
否 |
String(枚举) |
设置该绑定关系是否支持短信功能。 若客户添加应用时未开通短信功能，请勿携带此参数。 取值范围：
如果客户添加应用时开通了短信功能，不携带该参数时系统默认支持短信。 |
|
maxDuration |
否 |
Integer(0~1440) |
设置允许单次通话进行的最长时间，单位为分钟。通话时间从接通被叫的时刻开始计算。
不携带时，参数值默认为0。 |
|
lastMinVoice |
否 |
String(0-128) |
设置通话剩余最后一分钟时的提示音，填写为放音文件名，可在放音文件管理页面查看。 当maxDuration字段设置为非0时此参数有效。 不携带该参数表示通话剩余最后一分钟时不放音。 |
|
userData |
否 |
String(1-256) |
用户自定义数据。
说明：
若在设置绑定关系时携带该参数，绑定关系对应的呼叫、话单和短信通知消息中也会携带该参数。 |
|
turnFlag |
否 |
String(枚举) |
设置隐私号开关机状态。 取值范围：
不携带该参数时默认为开机状态。 |
|
callDirection |
否 |
Integer |
呼叫方向控制。表示该绑定关系允许的呼叫方向。 取值范围如下：
如果不携带该参数，系统默认该参数为0。 |
