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

AXE模式绑定信息修改接口

分享
更新时间: 2020/07/13 GMT+08:00

接口功能

该接口用于SP修改指定分机小号绑定关系的信息。

请求方向

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

使用说明

前提条件

  • 已从管理员处获取对应的app_key。
  • 已调用“大客户SP简单认证API”获取access_token。
  • 已调用“设置分机小号绑定关系”接口设置绑定关系。
  • 若使用个性化提示音,请确认已按要求制作并提交放音文件至管理员。

接口类型

表1 接口类型说明

请求方法

PUT

访问URI

/rest/caas/extendnumber/v1.0

通信协议

HTTPS

请求参数

表2 请求Headers参数说明

参数名称

是否必选

参数类型

说明

Content-Type

String

固定填写为application/json;charset=UTF-8。

表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参数说明

参数名称

是否必选

参数类型

说明

virtualNum

String(1-32)

分机个人小号,为全局号码格式(包含国家码),如:+8617000000021或+8675528000011。

该参数必须与extendNum同时携带,指定唯一一组绑定关系。

extendNum

String(1-4)

分机号,最大4位,如:1234。

该参数必须与virtualNum同时携带,指定唯一一组绑定关系。

subscriptionId

String(1-64)

设置分机小号绑定关系时返回的绑定ID。

携带该参数时系统以该参数为准,可不关注virtualNum和extendNum参数。

displayNumMode

String(枚举)

非小号用户呼叫分机小号时,小号用户看到的主显号码。

0:分机个人小号;

1:真实主叫号码;

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

recordFlag

String(1-32)

录音标识。

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

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

当参数取值为true,则本次绑定关系中的主叫和被叫所有通过分机小号拨通的通话都会被录音。

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

recordHintTone

String(1-128)

此参数在recordFlag为true时才有效。

此字段用于设置使用录音功能的提示音。

  • 需要定制个性化放音文件时,接口消息中携带此参数,参数取值为指定的放音文件名,如:recordHintTone.wav。请提前制作放音文件并提交到Open API业务平台。
  • 无需定制个性化放音文件时,接口消息中无需携带此参数,此时系统可能会放默认提示音,也可能不放,请与管理员确认局点配置。

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

当修改值为“”时清空该字段配置。

callbackTone

String(1-128)

小号用户回呼时,如果不存在回呼记录,则播放该参数指定的语音文件,参数取值为指定的放音文件名,如:callbackTone.wav。请提前制作放音文件并提交到Open API业务平台。

参数callbackTone和callbackNum为二选一关系,两者都携带时以callbackNum为准,两者都不携带表示不修改该参数值。

当修改值为“”时清空该字段配置。

callbackNum

String(1-32)

小号用户回呼时,如果不存在回呼记录,则转接到该参数指定的号码。

参数取值填写为全局号码格式(包含国家码),如:+8617000000021。

参数callbackTone和callbackNum为二选一关系,两者都携带时以callbackNum为准,两者都不携带表示不修改该参数值。

当修改值为“”时清空该字段配置。

timeUnit

String(枚举)

时间单位。

  • 0:小时
  • 1:分钟

携带该参数时,必须同时携带bindExpiredTime。

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

bindExpiredTime

Integer

绑定关系的有效时间,从修改绑定关系成功开始计算,过期后系统会自动解除绑定关系,该绑定关系下的主叫和回呼都不可达。单位:由timeUnit控制。

取值范围:

  • 当timeUnit取值为0时:0~720
  • 当timeUnit取值为1时:0~43200

0代表绑定关系永不过期。

携带该参数时,必须同时携带timeUnit。

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

响应参数

表5 响应结果参数

参数名称

是否必选

参数类型

默认值

说明

resultcode

String(1-32)

请求返回的结果码。

resultdesc

String(1-256)

操作结果描述。

结果码说明

表6 响应结果码

响应码

结果码

英文描述

中文描述

处理方法

200

0

Success.

成功。

-

403

1010002

Invalid request.

非法请求。

请检查请求携带的参数格式是否都合法。

例如:

  • 检查是否同时携带callbackTone和callbackNum,若是,请保留一个。
  • 检查timeUnit是否格式错误,若是,请填写正确格式。
  • 请检查callbackNum参数是否为+86、95或10开头的号码,若不是,请修改。

1010003

Invalid app_key.

无效的app_key。

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

1010004

Invalid access_token.

access_token无效。

请检查app_key和access_token的填写是否正确。

1010005

Expired access_token.

access_token过期。

请调用“大客户SP简单认证API”重新获取access_token。为避免出现此错误,在access_token有效期还剩下1/4时,需要调用“刷新授权API”到隐私保护通话业务平台重新获取新的access_token。

1010008

The status of the app_key is unavailable.

app_key不可用。

请联系管理员确认该app_key状态是否正常。

1010010

The flow control upper limit is reached on the platform.

平台达到系统流控上限。

请稍等一分钟后再试。

1010040

The app_key is not allowed to invoke the API.

app_key没有调用本API的权限。

请联系管理员确认该app_key是否具有分机小号能力。

1016001

The record does not exist.

记录不存在

绑定关系不存在,请检查virtualNum,extendNum或subscriptionId的填写是否正确。

1012001

Resource of number is not to be applied.

资源未申请

app_key和分机个人小号未绑定,请检查app_key和virtualNum参数的填写是否正确。

1020166

The app client ip is not in ip white list.

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

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

1020167

No idle extend Number.

没有空闲的分机号。

请重新指定分机号。

500

1010001

Internal system error.

系统错误。

请联系客服处理。

接口示例

  • 请求示例
    PUT /rest/caas/extendnumber/v1.0?app_key=appkey&access_token=AccessToken  HTTP1.1 
    
    content-type: application/json;charset=UTF-8 
    content-encoding:UTF-8 
    content-length:xx 
    
    { 
    "subscriptionId":"a132d3244543tg425982fe34df",
    "callbackNum":"+8617000000021"
    }
  • 响应示例
    HTTP/1.1 200 OK 
    Content-Type: application/json;charset=utf-8 
    Content-Length: xx 
    
    { 
    "resultcode":"0", 
    "resultdesc":"Success"
    }
分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问