隐私保护通话 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) |
AX中的X号码。 填写为全局号码格式（包含国家码），例如：+86138****0021。 系统可通过subscriptionId或privateNum确定唯一一个绑定关系，即不携带subscriptionId时，必须携带privateNum。 |
subscriptionId |
否 |
String(0-64) |
指定“AX模式绑定接口”返回的绑定ID修改绑定信息。 请求携带了subscriptionId时，系统会以subscriptionId的值为准，不关注privateNum参数。 |
privateSms |
否 |
String(枚举) |
修改该绑定关系是否支持短信功能。 若客户添加应用时未开通短信功能，请勿携带此参数。 取值范围：
不携带时，表示不修改该参数值。 |
recordFlag |
否 |
String(枚举) |
是否需要针对该绑定关系产生的所有通话录音。
该参数仅当客户添加应用时申请开通了录音功能才有效。 不携带时，表示不修改该参数值。 |
maxDuration |
否 |
Integer |
修改允许单次通话进行的最长时间，单位为分钟。 取值范围：0~1440
不携带时，表示不修改该参数值。 |
lastMinVoice |
否 |
String(0-128) |
该绑定关系的maxDuration不为0时该参数有效。 修改通话剩余最后一分钟时的提示音，填写为放音文件名，可在放音文件管理页面查看。 不携带时，表示不修改该参数值。 |
userData |
否 |
String(1-256) |
用户自定义数据。
说明：
若在设置绑定关系时携带该参数，绑定关系对应的呼叫、话单和短信通知消息中也会携带该参数。 |
turnFlag |
否 |
String(枚举) |
修改隐私号开关机状态。 取值范围：
不携带时，表示不修改该参数值。 |
callDirection |
否 |
Integer |
呼叫方向控制。表示该绑定关系允许的呼叫方向。 取值范围如下：
不携带时，表示不修改该参数值。 |
calleeNumDisplay |
否 |
String(枚举) |
设置非A用户呼叫X时，A接到呼叫时的主显号码。 取值：
不携带时，表示不修改该参数值。
说明：
由于运营商管控，当前平台要求该参数必须设置为0，否则呼叫会被运营商拦截。 |
