文档首页 > > API参考> AX模式> AX模式绑定信息修改接口

AX模式绑定信息修改接口

分享
更新时间:2020/09/28 GMT+08:00

接口功能

该接口用于客户向隐私保护通话平台修改已设置的AX绑定关系的相关信息。

注:该接口当前仅支持修改绑定关系是否支持短信。

请求方向

客户应用(客户端) → 隐私保护通话平台(服务端)

使用说明

已设置至少一组AX绑定关系。

接口类型

表1 请求说明

请求方法

PUT

访问URI

/rest/provision/caas/privatenumber/v1.0

通信协议

HTTPS

请求参数

表2 请求Headers参数说明

参数名称

是否必选

参数类型

说明

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="随机数生成时间"。
  • PasswordDigest:根据PasswordDigest = Base64 (SHA256 (Nonce + Created + Password))生成。其中,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参数说明

参数名称

是否必选

参数类型

说明

origNum

String(1-32)

AX中的A号码。

填写为全局号码格式。

  • 手机号码格式为国家码(如+86)+手机号码(如13800000001),填写为"+8613800000001"。
  • 固话号码为国家码(如+86)+不带前置0的区号(如755)+本地固话号码(如28000001),填写为"+8675528000001"。

如果需要修改绑定关系中的用户号码,请指定新的用户号码。不携带时表示不修改该参数值。

注:因运营商管控,固话号码只能接收来自X号码的呼叫,不能作为主叫呼叫X号码。即当A号码为固话号码时,其他用户(手机号码)可以拨打X号码联系A,但A无法通过拨打X号码联系其他用户。

privateNum

String(1-32)

AX中的X号码。

填写为全局号码格式(包含国家码),例如:+8613800000021。

系统可通过subscriptionId或privateNum确定唯一一个绑定关系,即不携带subscriptionId时,必须携带privateNum。

subscriptionId

String(0-64)

指定“AX模式绑定接口”返回的绑定ID修改绑定信息。

请求携带了subscriptionId时,系统会以subscriptionId的值为准,不关注privateNum参数。

privateSms

String(枚举)

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

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

取值范围:

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

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

recordFlag

String(枚举)

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

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

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

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

maxDuration

Integer

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

取值范围:0~1440

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

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

lastMinVoice

String(0-128)

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

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

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

userData

String(1-256)

用户自定义数据。

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

callDirection

Integer

呼叫方向控制。表示该绑定关系允许的呼叫方向。

取值范围如下:

  • 0:允许双向呼叫。
  • 1:只允许A呼叫X号码。
  • 2:只允许其他号码呼叫X号码。

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

响应参数

表5 响应结果参数

参数名称

是否必选

参数类型

默认值

说明

resultcode

String(1-32)

请求返回的结果码。

resultdesc

String(1-256)

操作结果描述。

结果码说明

表6 响应结果码

响应码

结果码

英文描述

中文描述

处理方法

200

0

Success.

成功。

-

400

1023006

Authorization not contained in the HTTP header.

HTTP消息头未找到Authorization字段。

请检查HTTP消息头中是否携带了Authorization字段。

1023007

realm not contained in Authorization.

Authorization字段中未找到realm属性。

请检查Authorization字段中的是否携带了realm属性。

1023008

profile not contained in Authorization.

Authorization字段中未找到profile属性。

请检查Authorization字段中的是否携带了profile属性。

1023009

The value of realm in Authorization must be SDP.

Authorization中realm属性值应该为“SDP”。

请检查Authorization字段中的realm属性值是否为“SDP”

1023010

The value of profile in Authorization must be UsernameToken.

Authorization中profile属性值应该为“UsernameToken”。

请检查Authorization字段中的profile属性值是否为“UsernameToken”

1023011

The value of type in Authorization must be app_key.

Authorization中type属性值应该为“Appkey”。

请检查Authorization字段中的type属性值是否为Appkey

1023012

type not contained in Authorization.

Authorization字段中未找到type属性。

请检查Authorization字段中是否携带了type属性。

1023013

WSSE not contained in Authorization.

Authorization中没有携带WSSE。

请检查Authorization字段中是否携带了WSSE。

1023026

X-WSSE not contained in the HTTP header.

HTTP头未找到X-WSSE字段。

请检查HTTP消息头中是否携带了X-WSSE字段。

1023027

Username not contained in X-WSSE.

X-WSSE字段中未找到Username属性。

请检查X-WSSE字段中的是否携带了Username属性。

1023028

Nonce not contained in X-WSSE.

X-WSSE字段中未找到Nonce属性。

请检查X-WSSE字段中的是否携带了Nonce属性。

1023029

Created not contained in X-WSSE.

X-WSSE字段中未找到Created属性。

请检查X-WSSE字段中的是否携带了Created属性。

1023030

PasswordDigest not contained in X-WSSE.

X-WSSE字段中未找到PasswordDigest属性。

请检查X-WSSE字段中的是否携带了PasswordDigest属性。

1023031

The format of Created is incorrect.

Created属性格式错误。

请检查X-WSSE字段中的Created属性格式是否正确。

1023032

UsernameToken not contained in X-WSSE.

X-WSSE字段中未找到UsernameToken属性。

请检查X-WSSE字段中的是否携带了UsernameToken属性。

401

1010010

Invalid digest.

PasswordDigest校验失败。

请检查PasswordDigest字段填写是否正确。

1010013

Time out limit.

时间超出限制。

请确认X-WEES鉴权时,生成随机数的时间与发送请求时的本地时间不能相差太大(具体差值请与管理员确认)。

403

1010002

Invalid request.

无效请求。

参考各接口参数说明,检查请求携带的参数格式是否正确,如以下参数格式问题:

  • 绑定接口填写的号码参数需为全局号码格式,如+8613800000001或+8675528000001;
  • 放音文件需上传通过审核才可通过接口调用,点击查看如何上传审核
  • 参考接口参数说明,检查是否携带了不能同时携带的参数;
  • 参数长度或格式是否错误。
  • 请检查userData是否包含中文字符、“^”、“{”和“}”符号,若包含,请剔除后重试,或将内容Base64编码后重试。
  • 请检查origNum参数是否为+86、95或10开头的号码,若不是,请修改。

1010003

Invalid app_key.

无效的app_key。

请检查请求携带的app_key填写是否正确。

1010008

The status of the app_key is unavailable.

app_key状态异常。

请检查请求携带的app_key所属应用状态是否正常。

1010010

The flow control upper limit is reached on the platform.

平台达到系统流控上限。

请稍等一分钟后再试。

1010029

The subscriber status is frozen.

用户账号已冻结。

  • 查看账户是否欠费。如欠费需充值后才能继续使用。
  • 若未欠费,请联系华为云客服处理。

1010040

The app_key is not allowed to invoke the API.

app_key没有调用本API的权限。

调用的接口和app_key所属的应用模式不一致。如添加应用时选择的AXB模式的应用,调用接口时只能调用AXB模式的接口,不能调用其他模式的接口。

1016001

The record does not exist.

记录不存在。

找不到绑定记录。请检查origNum或者subscriptionId参数的填写是否正确。

1011001

The account does not exist.

账号不存在。

出现该错误码可能有以下两个原因:

  • 调用接口时指定的X号码(privateNum)可能不是该应用已申请的隐私号码,请确认privateNum参数的填写是否正确;
  • 调用接口时填写的X号码(privateNum)格式不正确,请根据接口文档修改号码格式后再次尝试。

1011004

The number is not applied for binding application.

X号码和app_key没有绑定关系。

携带的app_key和X号码没有绑定关系,请检查携带的X号码是否属于该应用。

1012102

The number is contained in the blacklist.

号码黑名单

出现该错误码表示调用接口时指定的X号码因投诉或号码状态异常被隐私保护通话平台加入了黑名单,请查看订购号码时填写的邮箱是否有业务下线通知邮件,如果没有,请拨打400电话联系华为云客服处理。

1020166

The app client ip is not in ip white list.

对端app IP不在白名单列表中。

联系管理员检查IP白名单是否配置正确。

500

1010001

Internal system error.

系统错误。

请联系管理员处理。

1023001

Internal error.

内部错误。

1023002

Response timeout.

响应超时。

重新发送一次请求,若依然返回响应超时,请联系管理员处理。

接口示例

接口示例仅供参考,请以实际消息为准。

  • 请求示例
    PUT /rest/provision/caas/privatenumber/v1.0 HTTP1.1 
    
    content-type: application/json;charset=UTF-8
    authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"
    x-wsse: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="NDA1MWIwNjI2ZTkyNWFlM2FhMTE5NDE1YTk5NjU1YWE4NjNlZTY1MmRhYzkxZGViNzczZjdjMjkzZWQ4ZjAwNA==",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"
    content-length:xx 
    
    { 
    "subscriptionId":"efw89efwf7fea324252",
    "privateSms":"true"
    }
  • 响应示例
    HTTP/1.1 200 OK 
    Content-Type: application/json;charset=utf-8 
    Content-Length: xx 
    
    { 
    "resultcode":"0", 
    "resultdesc":"Success" 
    }
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问