文档首页 > > API参考> AXYB模式> AXYB模式接口使用说明

AXYB模式接口使用说明

分享
更新时间: 2019/11/13 GMT+08:00

隐私保护通话AXYB模式中,如A和B是同一个应用的两方用户,隐私保护通话平台为A、B分别绑定隐私号码X、Y。绑定完成后,A用户对B用户呈现X号码,与A用户建立的通信通过X号码建立;B用户对A用户呈现Y号码,与B用户建立的通信通过Y建立。如果您想要了解隐私保护通话AXYB模式的功能,请参考AXYB模式功能详解

典型的AX模式场景相关接口如下:

接口名称

接口功能

请求发起方

请求接收方

备注

AXYB模式绑定接口

设置以下绑定关系:

  • 用户A和隐私号码X的绑定关系
  • AX、用户B和隐私号码Y的绑定关系

客户应用(客户端)

隐私保护通话平台(服务端)

客户调用此接口分别设置了A和X、B和Y的绑定关系后,A、B才可以通过X、Y实现通讯。

AXYB模式绑定信息查询接口

查询已设置的AXYB模式的绑定信息

客户应用(客户端)

隐私保护通话平台(服务端)

-

AXYB模式呼叫事件通知接口

隐私保护通话平台向客户推送隐私保护通话用户呼叫时的状态信息,如呼入、呼出、振铃、应答、挂机等状态的信息

隐私保护通话平台(服务端)

客户应用(客户端)

若要接收呼叫事件通知,客户创建应用时需设置呼叫状态接收地址,并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。

AXYB模式话单通知接口

隐私保护通话平台向客户推送通话的话单信息

隐私保护通话平台(服务端)

客户应用(客户端)

若要接收话单通知,客户创建应用时需设置呼叫话单接收地址,并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。

X号码状态通知接口

X号码状态变化时,隐私保护通话平台会向客户推送X号码状态通知

隐私保护通话平台(服务端)

客户应用(客户端)

若要接收X号码状态通知,客户创建应用时需设置呼叫状态接收地址并启用推送X号码状态功能,并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。

AXYB模式解绑接口

解除以下绑定关系:

  • AXYB的绑定关系。
  • YB的绑定关系(单独解绑)。

客户应用(客户端)

隐私保护通话平台(服务端)

绑定关系使用完毕后,客户可解除绑定关系,以达到重复使用隐私号码资源的目的。

终止呼叫接口

终止一路呼叫

客户应用(客户端)

隐私保护通话平台(服务端)

客户可随时调用该接口终止一路隐私保护通话呼叫。

获取录音文件下载地址接口

获取录音文件的下载地址

客户应用(客户端)

隐私保护通话平台(服务端)

客户从呼叫话单中获取到录音文件名后,可通过调用此接口获取录音文件下载地址。

API请求地址

API请求地址由“APP接入地址”和“访问URI”组成,数据来源如下:

参数

来源

示例

APP接入地址

登录管理控制台,从隐私保护通话“应用管理”页面获取。

https://rtcapi.cn-north-1.myhuaweicloud.com:12543

访问URI

从各API接口页面中的“接口类型”介绍部分获取。

AXYB模式绑定接口:/rest/omp/xyrelationnumber/v1.0

综上,API请求地址示例如下:

设置AXYB模式绑定关系
https://rtcapi.cn-north-1.myhuaweicloud.com:12543/rest/omp/xyrelationnumber/v1.0

API样例

下载Demo,快速开发应用:

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区