华为云首页 用户手册

隐私保护通话 PRIVATENUMBER-AX模式呼叫事件通知接口:请求参数

隐私保护通话 PRIVATENUMBER-AX模式呼叫事件通知接口:请求参数

时间：2024-11-19 14:24:00
隐私保护通话 PRIVATENUMBER AX模式

请求参数

AX模式中，A和X号码形成绑定关系，所有与A用户建立的通讯都是通过X号码建立：A呼叫X，呼叫转接给指定的呼叫对象（A主叫场景）；其他用户呼叫X，呼叫转接给A（A被叫场景）。

注：以下流程和接口示例以A主叫场景为例，即A呼叫X，呼叫转接给指定的呼叫对象B，B用户接听为例。流程和接口示例仅供参考，请以实际消息为准。

图1 A主叫场景业务流程
表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。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同，部分语言可参考表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参数说明

参数名称

是否必选

参数类型

说明

eventType

是

String(枚举)

该参数标识通知的事件类型。

取值范围如下：

  • callin：呼入事件
  • callout：呼出事件
  • alerting：振铃事件
  • answer：应答事件
  • disconnect：挂机事件

statusInfo

否

CallStatusInfo

呼叫状态事件的信息。

当eventType参数为callin、callout、alerting、answer、disconnect时携带。
CallStatusInfo定义
表5 callin：呼入事件

参数名称

是否必选

参数类型

说明

timestamp

是

String(1-128)

该呼叫事件发生时 隐私保护通话 平台的UNIX时间戳。

该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。

sessionId

是

String(1-256)

唯一指定一条通话链路的标识ID。

caller

否

String(1-32)

主叫号码。

号码为全局号码格式（包含国家码），如+86138****0021。

说明：
  • A主叫场景，呼入事件的主叫号码为A号码。
  • A被叫场景，呼入事件的主叫号码为B号码（B为任意其他用户）。

called

否

String(1-32)

被叫号码。

说明：

A主叫/被叫场景，呼入事件的被叫号码为X号码。

subscriptionId

否

String(1-64)

绑定ID。

userData

否

String(1-256)

用户附属信息。

说明：

使用该参数的场景请联系华为云客服获取。

接口示例

POST /status HTTP/1.1

content-type: application/json;charset=UTF-8
authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"
x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"
Content-Length: xx 

{"eventType":"callin","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:03","caller":"+86138****0021","called":"+86138****0022","subscriptionId":"****"}}
表6 callout：呼出事件

参数名称

是否必选

参数类型

说明

timestamp

是

String(1-128)

该呼叫事件发生时隐私保护通话平台的UNIX时间戳。

该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。

sessionId

是

String(1-256)

唯一指定一条通话链路的标识ID。

caller

否

String(1-32)

主叫号码。

号码为全局号码格式（包含国家码），如+86138****0021。

说明：

A主叫/被叫场景，呼出事件的主叫号码为X号码。

called

否

String(1-32)

被叫号码。

说明：

  • A主叫场景，呼出事件的被叫号码为B号码。

  • A被叫场景，呼出事件的被叫号码为A号码。

subscriptionId

否

String(1-64)

绑定ID。

userData

否

String(1-256)

用户附属信息。

当客户在AX模式绑定接口、AX模式绑定信息修改接口或AX模式设置临时被叫接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。

接口示例

POST /status HTTP/1.1

content-type: application/json;charset=UTF-8
authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"
x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"
content-length:xx 

{"eventType":"callout","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:03","caller":"+86138****0022","called":"+86138****7021","subscriptionId":"****"}}
表7 alerting：振铃事件

参数名称

是否必选

参数类型

说明

timestamp

是

String(1-128)

该呼叫事件发生时隐私保护通话平台的UNIX时间戳。

该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。

sessionId

是

String(1-256)

唯一指定一条通话链路的标识ID。

caller

否

String(1-32)

主叫号码。

号码为全局号码格式（包含国家码），如+86138****0021。

说明：

A主叫/被叫场景，振铃事件的主叫号码为X号码。

called

否

String(1-32)

被叫号码。

说明：

  • A主叫场景，振铃事件的被叫号码为B号码。

  • A被叫场景，振铃事件的被叫号码为A号码。

subscriptionId

否

String(1-64)

绑定ID。

userData

否

String(1-256)

用户附属信息。

当客户在AX模式绑定接口、AX模式绑定信息修改接口或AX模式设置临时被叫接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。

接口示例

POST /status HTTP/1.1

content-type: application/json;charset=UTF-8
authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"
x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"
content-length:xx

{"eventType":"alerting","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:04","caller":"+86138****0022","called":"+86138****7021","subscriptionId":"****"}}

表8 answer：应答事件

参数名称

是否必选

参数类型

说明

timestamp

是

String(1-128)

该呼叫事件发生时隐私保护通话平台的UNIX时间戳。

该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。

sessionId

是

String(1-256)

唯一指定一条通话链路的标识ID。

caller

否

String(1-32)

主叫号码。

号码为全局号码格式（包含国家码），如+86138****0021。

说明：

A主叫/被叫场景，应答事件的主叫号码为X号码。

called

否

String(1-32)

被叫号码。

说明：

  • A主叫场景，应答事件的被叫号码为B号码。

  • A被叫场景，应答事件的被叫号码为A号码。

subscriptionId

否

String(1-64)

绑定ID。

userData

否

String(1-256)

用户附属信息。

当客户在AX模式绑定接口、AX模式绑定信息修改接口或AX模式设置临时被叫接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。

接口示例

POST /status HTTP/1.1

content-type: application/json;charset=UTF-8
authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"
x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"
content-length:xx 

{"eventType":"answer","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:06","caller":"+86138****0022","called":"+86138****7021","subscriptionId":"****"}}
表9 disconnect：挂机事件

参数名称

是否必选

参数类型

说明

timestamp

是

String(1-128)

该呼叫事件发生时隐私保护通话平台的UNIX时间戳。

该参数取值为UTC时间（+8小时为北京时间）格式，即为“yyyy-MM-dd HH:mm:ss”。

sessionId

是

String(1-256)

唯一指定一条通话链路的标识ID。

caller

否

String(1-32)

主叫号码。

号码为全局号码格式（包含国家码），如+86138****0021。

说明：

此处返回号码非真实主被叫号码，真实主被叫号码请以fee事件中的返回值为准。

called

否

String(1-32)

被叫号码。

说明：

此处返回号码非真实主被叫号码，真实主被叫号码请以fee事件中的返回值为准。

stateCode

否

Integer

通话挂机的原因值，仅当eventType为disconnect时携带。

取值范围及表示的含义请参考通话挂机原因值说明。

stateDesc

否

String(1-128)

通话挂机的原因值的描述，仅当eventType为disconnect时携带。

subscriptionId

否

String(1-64)

绑定ID。

userData

否

String(1-256)

用户附属信息。

当客户在AX模式绑定接口、AX模式绑定信息修改接口或AX模式设置临时被叫接口中携带了“userData”时，对应此呼叫事件的通知消息中都会携带此参数。

接口示例

POST /status HTTP/1.1

content-type: application/json;charset=UTF-8
authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"
x-wsse: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"
content-length:xx

{"eventType":"disconnect","statusInfo":{"sessionId":"1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com","timestamp":"2019-01-24 02:30:22","caller":"+86138****0022","called":"+86138****7021","stateCode":0,"stateDesc":"The user releases the call.","subscriptionId":"****"}}
support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0006_1.html

华为云11.11 2核1G 2M 云服务器

29元/年

立即注册 领万元上云礼券

抽奖赢11111元免单

续费同价 L实例 2核2G 4M

98元/年

热门域名 1元 随心购

1元/年

看了此文的人还看了
CDN加速 GaussDB 文字转换成语音 免费的服务器 如何创建网站 域名网站购买 私有云桌面 云主机哪个好 域名怎么备案 手机云电脑 SSL证书申请 云点播服务器 免费OCR是什么 电脑云桌面 域名备案怎么弄 语音转文字 文字图片识别 云桌面是什么 网址安全检测 网站建设搭建 国外CDN加速 SSL免费证书申请 短信批量发送 图片OCR识别 云数据库MySQL 个人域名购买 录音转文字 扫描图片识别文字 OCR图片识别 行驶证识别 虚拟电话号码 电话呼叫中心软件 怎么制作一个网站 Email注册网站 华为VNC 图像文字识别 企业网站制作 个人网站搭建 华为云计算 免费租用云托管 云桌面云服务器 ocr文字识别免费版 HTTPS证书申请 图片文字识别转换 国外域名注册商 使用免费虚拟主机 云电脑主机多少钱 鲲鹏云手机 短信验证码平台 OCR图片文字识别 SSL证书是什么 申请企业邮箱步骤 免费的企业用邮箱 云免流搭建教程 域名价格
热门活动
隐私保护通话 PRIVATENUMBER-AX模式呼叫事件通知接口:请求参数

搜索反馈

您搜索到想要的结果了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
产品专区
推荐文章
更多内容
云硬盘存储EVS Web应用防火墙 人机语音识别 云计算入门 云数据库选择 HDC大会 华为云计算 响应式建站是什么 智慧班牌系统