隐私保护通话 PRIVATENUMBER-AXE模式绑定接口:请求参数
下载隐私保护通话 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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 |
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
virtualNum |
否 |
String(0-32) |
指定已申请到的X号码进行绑定。 可在 隐私保护通话 控制台的“号码管理”页面或订购号码成功后返回的号码表中查看已申请到的X号码。 填写为全局号码格式（国家码+11位数字的手机号码），如：+86138****0021。 该参数与areaCode是二选一关系。 同时携带virtualNum和areaCode时系统以virtualNum为准。 |
|
areaCode |
否 |
String(0-32) |
指定城市码，由隐私保护通话平台从客户已申请到的X号码中选择可用号码进行绑定。 填写为标准格式的城市码，如：0755、010等。 X号码对应城市码可在订购号码成功后返回的号码表中查看，点击查看如何下载号码表。 该参数与virtualNum是二选一关系。 同时携带virtualNum和areaCode时系统以virtualNum为准。 |
|
areaMatchMode |
否 |
String(枚举) |
号码筛选方式。
说明：
|
|
bindNum |
是 |
String(1-32) |
AXE中的A号码。 填写为全局号码格式。
说明：
因运营商管控，固话号码只能接收来自X号码的呼叫，不能作为主叫呼叫X号码。即当A号码为固话号码时，其他用户（手机号码）可以拨打X号码后输入分机号联系A，但A无法通过拨打X号码回呼之前通话用户或企业指定号码。 |
|
extendNum |
否 |
String(1-4) |
分机号，即AXE中的E。仅支持数字，最大4位 ，例如：1234。 取值范围：1-9，01-99，001-999，0001-9999。 该参数仅在指定virtualNum进行绑定时有效。 不携带该参数或取值为空时，则系统自动分配分机号E。 |
|
displayNumMode |
否 |
String(枚举) |
非A用户呼叫X号码时，A看到的主显号码。
如不携带此参数，系统默认值为0。
说明：
由于运营商管控，当前平台要求该参数必须设置为0，否则呼叫会被运营商拦截。 |
|
recordFlag |
否 |
String(枚举) |
是否需要针对该绑定关系产生的所有通话录音。
该参数仅当客户添加应用时申请开通了录音功能才有效。 如果不携带该参数，系统默认不录音。 |
|
recordHintTone |
否 |
String(1-128) |
该参数仅在recordFlag为true时有效。 该参数用于设置录音提示音，填写为放音文件名，可在放音文件管理页面查看。 不携带该参数表示录音前不播放提示音。
说明：
因隐私协议及运营商管控，录音的呼叫必须携带该参数，否则呼叫会被运营商拦截。 |
|
callbackTone |
否 |
String(1-128) |
A呼叫X时，如果不存在回呼记录，则播放该参数指定的语音文件。填写为放音文名，可在放音文件管理页面查看。 参数callbackTone和callbackNum为二选一关系，两者不能同时携带，两者都不携带时以添加应用时的配置为准。 |
|
callbackNum |
否 |
String(1-32) |
A呼叫X时，如果不存在回呼记录，则转接到该参数指定的号码。填写为全局号码格式（包含国家码），如：+86170****0021或+8675528****08。 参数callbackTone和callbackNum为二选一关系，两者不能同时携带，两者都不携带时以添加应用时的配置为准。 |
|
timeUnit |
否 |
String(枚举) |
时间单位。
携带该参数时，必须同时携带bindExpiredTime和callbackExpiredTime。如不携带此参数，则系统默认为小时。 |
|
bindExpiredTime |
否 |
Integer |
绑定关系的有效时间，过期后系统会自动解除绑定关系，该绑定关系下的主叫和回呼都不可达。单位：由timeUnit控制。
0代表绑定关系永不过期。
说明：
该参数取值须大于等于callbackExpiredTime。 |
|
callbackExpiredTime |
否 |
Integer |
回呼记录有效时间，过期后系统会自动清除回呼记录，回呼将转接到callbackNum或播放callbackTone提示音。单位：由timeUnit控制。
0代表绑定有效期内回呼一直有效。 当绑定关系失效时，回呼记录有效时间无论是否已经到达失效时间都会被清除。
说明：
该参数取值须小于等于bindExpiredTime。当bindExpiredTime为0时，callbackExpiredTime可设置为适用范围的任意值。 |
|
userData |
否 |
String(1-256) |
用户自定义数据，会在响应消息中原样返回。
说明：
若在设置绑定关系时携带该参数，绑定关系对应的呼叫、话单通知消息中也会携带该参数。 |
