隐私保护通话 PRIVATENUMBER-AXB模式绑定信息修改接口:请求参数

时间:2024-12-30 16:28:46

请求参数

表2 请求Headers参数说明

参数名称

是否必选

参数类型

说明

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="随机数生成时间"。
  • PasswordDigest:根据PasswordDigest = Base64 (HMAC-SHA256 (Password,Nonce + Created))生成。其中,Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可,无需包含+号和空格。
  • Nonce:客户发送请求时生成的一个随机数,长度为1~128位,可包含数字和大小写字母。例如:66C92B11FF8A425FB8D4CCFE0ED9ED1F。
  • Created:随机数生成时间。采用标准UTC格式,例如:2018-02-12T15:30:20Z。不同编程语言中的时间格式转换方式不同,部分语言可参考表3
表3 不同编程语言的时间格式

编程语言

时间格式

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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。

表4 请求Body参数说明

参数名称

是否必选

参数类型

说明

subscriptionId

String(1-64)

指定“AXB模式绑定接口”返回的绑定ID进行修改。

callerNum

String(4-31)

将A号码修改为新的值。

填写为全局号码格式。

  • 手机号码格式为国家码(如+86)+手机号码(11位数字的手机号码,如138****0001),填写为"+86138****0001"。
  • 固话号码为国家码(如+86)+不带前置0的区号(如755)+本地固话号码(7或8位数字的固话号码,以实际号码为准,如28****01),填写为"+8675528****01"。

说明:
  • 因运营商管控,固话号码只能接收来自X号码的呼叫,不能作为主叫呼叫X号码。即当A号码为固话号码时,B(手机号码)可以拨打X号码联系A,但A无法通过拨打X号码联系B。
  • 若需双向呼叫,A和B号码都必须是手机号码。

calleeNum

String(4-31)

将B号码修改为新的值。

填写为全局号码格式。

  • 手机号码格式为国家码(如+86)+手机号码(11位数字的手机号码,如138****0001),填写为"+86138****0001"。
  • 固话号码为国家码(如+86)+不带前置0的区号(如755)+本地固话号码(7或8位数字的固话号码,以实际号码为准,如28****01),填写为"+8675528****01"。

说明:
  • 因运营商管控,固话号码只能接收来自X号码的呼叫,不能作为主叫呼叫X号码。即当B号码为固话号码时,A(手机号码)可以拨打X号码联系B,但B无法通过拨打X号码联系A。
  • 若需双向呼叫,A和B号码都必须是手机号码。

callDirection

Integer

表示修改后的绑定关系允许的呼叫方向,取值范围:

  • 0:bidirectional,表示callerNum和calleeNum都可以通过X号码呼叫对方。
  • 1:caller to callee,表示只允许callerNum通过X号码呼叫calleeNum。
  • 2:callee to caller,表示只允许calleeNum通过X号码呼叫callerNum。

不携带该参数表示不修改呼叫方向。

duration

Integer

更新绑定关系保持时间,单位为秒,从修改绑定关系成功开始计算。

取值范围:0~7776000(90天)

不携带该参数表示不修改绑定关系保持时间。

preVoice

ApiPlayInfo

修改个性化通话前等待音。

不携带该参数表示不修改通话前等待音。

maxDuration

Integer

修改允许单次通话进行的最长时间,单位为分钟。

取值范围:0~1440

  • 0:系统不主动结束通话,由主被叫双方结束通话。
  • 1~1440:当通话时长达到此配置值,系统主动结束通话。

不携带时,表示不修改该参数值。

lastMinVoice

String(0-128)

该绑定关系的maxDuration不为0时该参数有效。

修改通话剩余最后一分钟时的提示音,填写为放音文件名,可在放音文件管理页面查看。

不携带时,表示不修改该参数值。

privateSms

String(枚举)

修改该绑定关系是否支持短信功能。

若客户添加应用时未开通短信功能,请勿携带此参数。

取值范围:

  • false:不支持短信
  • true:支持短信

不携带时,表示不修改该参数值。

recordFlag

String(枚举)

是否需要针对该绑定关系产生的所有通话录音。

  • false:表示不录音
  • true:表示录音。

该参数仅当客户添加应用时申请开通了录音功能才有效。

不携带时,表示不修改该参数值。

userData

String(1-256)

用户自定义数据。

  • 不允许携带以下字符:“^”,“{”,“}”。
  • 不允许包含中文字符,如果包含中文字符请采用Base64编码。
说明:

若在设置绑定关系时携带该参数,绑定关系对应的呼叫、话单和短信通知消息中也会携带该参数。

表5 ApiPlayInfo定义

参数名称

是否必选

参数类型

说明

callerHintTone

String(0-128)

修改callerNum的通话前等待音,填写为放音文件名,可在放音文件管理页面查看。

不携带时,表示不修改该参数值。

calleeHintTone

String(0-128)

修改calleeNum的通话前等待音,填写为放音文件名,可在放音文件管理页面查看。

不携带时,表示不修改该参数值。

support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0004.html