语音通话 VoiceCall语音通话 VoiceCall

计算
弹性云服务器 ECS
裸金属服务器 BMS
云手机 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器 HECS
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属企业存储服务
云存储网关 CSG
专属分布式存储服务 DSS
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘小站 IES
智能边缘平台 IEF
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
园区智能体 CampusGo
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
语音交互服务 SIS
知识图谱 KG
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
设备管理 IoTDM(联通用户专用)
全球SIM联接 GSL
IoT开发者服务
IoT数据分析
车联网服务 IoV
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
开发与运维
软件开发平台 DevCloud
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
开源镜像站 Mirrors
应用魔方 AppCube
云性能测试服务 CPTS
应用管理与运维平台 ServiceStage
云应用引擎 CAE
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
区块链
区块链服务 BCS
可信跨链服务 TCS
智能协作
IdeaHub
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
API问题定位指导
云生态
云市场
合作伙伴中心
华为云培训中心
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
云原生服务中心 OSC
容器批量计算 BCE
容器交付流水线 ContainerOps
应用服务网格 ASM
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB (for openGauss)
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
数据管理服务 DAS
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据湖治理中心 DGC
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
API网关 APIG
分布式缓存服务 DCS
分布式消息服务RocketMQ版
企业应用
域名注册服务 Domains
云解析服务 DNS
云速建站 CloudSite
网站备案
华为云WeLink
会议
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
API全生命周期管理 ROMA API
安全与合规
安全技术与应用
DDoS防护 ADS
Web应用防火墙 WAF
云防火墙 CFW
应用信任中心 ATC
企业主机安全 HSS
容器安全服务 CGS
云堡垒机 CBH
数据库安全服务 DBSS
数据加密服务 DEW
数据安全中心 DSC
云证书管理服务 CCM
SSL证书管理 SCM
漏洞扫描服务 VSS
态势感知 SA
威胁检测服务 MTD
管理检测与响应 MDR
安全治理云图 Compass
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
专属云
专属计算集群 DCC
解决方案
高性能计算 HPC
SAP
游戏云
混合云灾备
华为工业云平台 IMC
价格
成本优化最佳实践
专属云商业逻辑
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
文档首页> 语音通话 VoiceCall> API参考> 语音回呼API> 语音回呼呼叫状态通知API
更新时间:2021-09-18 GMT+08:00
分享

语音回呼呼叫状态通知API

接口功能

语音通话平台通过此接口向客户推送语音通话业务用户呼叫时的状态信息,如呼入、呼出、振铃、应答、挂机等状态的信息。

请求方向

语音通话平台(客户端) → 客户服务器(服务端)

使用说明

  • 前提条件
    • SP在开发应用时,若需订阅呼叫状态通知,必须要提供呼叫状态接收URL(statusUrl),并且确保URL能够正常处理语音通话平台发送的通知信息。
    • 提供呼叫状态接收URL有以下两种方式:
      • 提前通过应用管理向语音通话平台提交呼叫状态接收URL。
      • SP应用调用场景API时,填写statusUrl。
  • 使用限制

    语音通话平台推送呼叫状态给开发者应用,仅支持POST方式。

接口类型

表1 接口类型说明

请求方法

POST

访问URI

开发者应用接收呼叫状态URL

通信协议

HTTPS/HTTP

语音回呼场景请求参数

语音回呼,也叫双向回呼,用户使用语音回呼软件呼叫另一方,语音通话平台依次呼叫主被叫号码,建立通话,实现主被叫号码间的点对点通信。

注:以下流程以用户A请求呼叫用户B,语音通话平台依次呼叫主叫号码A和被叫号码B,B用户接听为例。流程和接口示例仅供参考,请以实际消息为准。

表2 请求Body参数说明

参数名称

是否必选

参数类型

说明

eventType

String(枚举)

该参数标识API事件通知的类型。取值范围如下:

statusInfo

CallStatusInfo

呼叫状态事件的信息。

当eventType参数为callout、alerting、answer、disconnect时携带。

CallStatusInfo

表3 callout:呼出事件

参数名称

是否必选

参数类型

说明

timestamp

String(1-128)

该呼叫事件发生时语音通话平台的UNIX时间戳。

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

userData

String(1-256)

用户附属信息,此参数的值与“语音回呼场景API”中的"userData"参数值一致。

sessionId

String(1-256)

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

caller

String(1-32)

主叫号码。

号码仅支持全局号码格式(包含国家码),比如+86138****7021。

注:

语音回呼业务:

  • 语音通话平台呼叫A时的呼出事件主叫号码为SP设置的主叫端来电显示号码(displayNbr)。
  • 语音通话平台呼叫B时的呼出事件主叫号码为SP设置的被叫端来电显示号码(displayCalleeNbr)。

called

String(1-32)

被叫号码。

号码仅支持全局号码格式(包含国家码),比如+86138****7021。

注:语音回呼场景

  • 语音通话平台呼叫A时的呼出事件被叫号码为A。
  • 语音通话平台呼叫B时的呼出事件被叫号码为B。

接口示例

POST /status HTTP/1.1

Content-Length: xx 

{"eventType":"callout","statusInfo":{"sessionId":"1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com","timestamp":"2019-01-24 03:04:24","caller":"+86138****0022","called":"+86138****0021"}}
表4 alerting:振铃事件

参数名称

是否必选

参数类型

说明

timestamp

String(1-128)

该呼叫事件发生时语音通话平台的UNIX时间戳。

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

userData

String(1-256)

用户附属信息,此参数的值与“语音回呼场景API”中的"userData"参数值一致。

sessionId

String(1-256)

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

caller

String(1-32)

主叫号码。

号码仅支持全局号码格式(包含国家码),比如+86138****7021。

注:

语音回呼业务:

  • 语音通话平台呼叫A时的振铃事件主叫号码为SP设置的主叫端来电显示号码(displayNbr)。
  • 语音通话平台呼叫B时的振铃事件主叫号码为SP设置的被叫端来电显示号码(displayCalleeNbr)。

called

String(1-32)

被叫号码。

号码仅支持全局号码格式(包含国家码),比如+86138****7021。

注:语音回呼场景

  • 语音通话平台呼叫A时的振铃事件被叫号码为A。
  • 语音通话平台呼叫B时的振铃事件被叫号码为B。

接口示例

POST /status HTTP/1.1

Content-Length: xx 

{"eventType":"alerting","statusInfo":{"sessionId":"1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com","timestamp":"2019-01-24 03:04:26","caller":"+86138****0022","called":"+86138****0021"}}
表5 answer:应答事件

参数名称

是否必选

参数类型

说明

timestamp

String(1-128)

该呼叫事件发生时语音通话平台的UNIX时间戳。

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

userData

String(1-256)

用户附属信息,此参数的值与“语音回呼场景API”中的"userData"参数值一致。

sessionId

String(1-256)

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

caller

String(1-32)

主叫号码。

号码仅支持全局号码格式(包含国家码),比如+86138****7021。

注:

语音回呼业务:

  • 语音通话平台呼叫A时的应答事件主叫号码为SP设置的主叫端来电显示号码(displayNbr)。
  • 语音通话平台呼叫B时的应答事件主叫号码为SP设置的被叫端来电显示号码(displayCalleeNbr)。

called

String(1-32)

被叫号码。

号码仅支持全局号码格式(包含国家码),比如+86138****7021。

注:语音回呼场景

  • 语音通话平台呼叫A时的应答事件被叫号码为A。
  • 语音通话平台呼叫B时的应答事件被叫号码为B。

接口示例

POST /status HTTP/1.1

Content-Length: xx 

{"eventType":"answer","statusInfo":{"sessionId":"1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com","timestamp":"2019-01-24 03:04:31","caller":"+86138****0022","called":"+86138****0021"}}
表6 disconnect:挂机事件

参数名称

是否必选

参数类型

说明

timestamp

String(1-128)

该呼叫事件发生时语音通话业务平台的UNIX时间戳。

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

userData

String(1-256)

用户附属信息,此参数的值与“语音回呼场景API”中的"userData"参数值一致。

sessionId

String(1-256)

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

caller

String(1-32)

主叫号码。

号码仅支持全局号码格式(包含国家码),比如+86138****7021。

注:

语音回呼业务:

若A先挂机,则挂机事件主叫号码为SP设置的主叫端来电显示号码(displayNbr);若B先挂机,则挂机事件主叫号码为SP设置的被叫端来电显示号码(displayCalleeNbr)。

called

String(1-32)

被叫号码。

号码仅支持全局号码格式(包含国家码),比如+86138****7021。

注:

语音回呼场景,若A先挂机,则挂机事件被叫号码为A号码;若B先挂机,则挂机事件被叫号码为B号码。

partyType

String(枚举)

当通知类型“eventType”“disconnect”且客户调用“语音回呼场景API”时将“partyTypeRequiredInDisconnect”参数设置为“true”时才会携带。

取值范围如下:

  • caller:主叫
  • callee:被叫
  • platform:平台

stateCode

Integer

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

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

stateDesc

String(1-128)

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

接口示例

POST /status HTTP/1.1

Content-Length: xx 

{"eventType":"disconnect","statusInfo":{"sessionId":"1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com","timestamp":"2019-01-24 03:04:49","caller":"+86138****0022","called":"+86138****0021","stateCode":0,"stateDesc":"The user releases the call."}}

响应参数

接收到事件通知时,第三方服务器响应返回200则为成功,否则语音通话平台会认为推送失败。

响应示例
HTTP/1.1 200 OK 
Content-Type: application/json;charset=UTF-8

代码样例

前往代码样例查看。

分享:

    相关文档

    相关产品

关闭导读