网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

语音回呼场景API

更新时间:2024-11-11 GMT+08:00
分享

典型场景

当应用要实现语音回呼功能时,可以调用语音回呼场景API。

接口功能

主叫用户通过应用拨打被叫用户,语音通话平台呼叫主叫和被叫,使主叫和被叫能够互相通话。

图1 语音回呼体验流程

语音回呼业务体验描述:

  1. 用户A通过应用呼叫用户B,请求上报到SP。
  2. SP调用语音回呼场景API。
  3. 语音通话平台呼叫用户A的号码,用户A接听,并听到提示音。
  4. 语音通话平台呼叫用户B的号码。
  5. 用户B接听,用户A和用户B通话。

使用说明

  • 前提条件
    1. 已通过“应用管理”页面获取该语音回呼能力的APP_Key,APP_Secret和APP接入地址。
    2. 已通过“号码订购”页面向语音通话平台申请以下号码:
      • 若使用定制化主叫端来电显示号码,请确认已申请固话号码(displayNbr)。
      • 若需隐藏主叫号码,使用定制化被叫端来电显示号码,请确认已申请固话号码(displayCalleeNbr)。
    3. 若需使用通话录音功能,请确认已向语音通话平台申请该功能。
    4. 若使用个性化放音,请确认已按要求制作并通过放音文件管理页面向语音通话平台提交放音文件,包括最后一分钟提示音(lastMinVoice),主叫提示音(preVoice),主叫等待音(waitVoice),录音提示音(recordHintTone),回呼提示音(callBackTone)。
    5. 若需订阅呼叫状态和话单通知,请确认已通过应用管理向语音通话平台提交呼叫状态通知URL(statusUrl)和话单通知URL(feeUrl)。若未提交,调用接口时填写也可以。

  • 注意事项

    无。

  • 使用限制

    无。

接口类型

表1 接口类型说明

请求方法

POST

访问URI

/rest/httpsessions/click2Call/v2.0

通信协议

HTTPS

请求参数

表2 请求Headers参数说明

参数名称

是否必选

参数类型

说明

Content-Type

String

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

Authorization

String

固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。

X-AKSK

String

取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。
  • PasswordDigest:根据PasswordDigest = Base64 (HMAC-SHA256 (PasswordNonce + Created))生成。其中,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参数说明

参数名称

是否必选

参数类型

默认值

说明

displayNbr

String(4-31)

此字段定义主叫用户收到语音通话平台的呼叫时,主叫用户手机终端的来电显示号码。需提前在订购号码页面申请该号码。

号码格式(固话):国家码+区号+固话,与号码管理页面的“固话号码”保持一致。

若该号码为“暂停”状态,语音通话平台会从该应用下随机选取一个其他可用的固话号码进行外呼。

callerNbr

String(4-31)

此字段定义用户在SP开发的应用中,通过语音回呼功能发起呼叫时所使用的主叫号码。

  • 手机号码格式:+{国家码}{手机号码}。示例:+86135***0002。
  • 固话格式:+{国家码}{区号}{固话号码},其中区号需去掉首位的0。示例:国家码86,区号0755,固话号码28****02,填写为+8675528****02。

displayCalleeNbr

String(4-31)

此字段定义被叫用户收到语音通话平台的呼叫时,被叫用户终端的来电显示号码。需提前在订购号码页面申请该号码。

该号码可以与displayNbr配置为同一个号码,也可以配置为不同号码。

号码格式(固话):国家码+区号+固话,与号码管理页面的“固话号码”保持一致。

若该号码为“暂停”状态,语音通话平台会从该应用下随机选取一个其他可用的固话号码进行外呼。

calleeNbr

String(4-31)

此字段定义终端用户在SP开发的应用中通过语音回呼业务发起呼叫时所拨打的被叫号码。

号码格式:

  • 手机号码格式:+{国家码}{手机号码}。示例:+86135****0004。
  • 固话格式:+{国家码}{区号}{固话号码},其中区号需去掉首位的0。示例:国家码86,区号0755,固话号码28****04,填写为+8675528****04。

maxDuration

Integer

0

此字段用于设置允许单次通话进行的最长时间,通话时间从被叫接通的时刻开始计算。

取值范围:0~1440分钟

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

不携带时,参数值默认为0。

lastMinVoice

String(1-128)

当maxDuration字段设置为非0时此参数有效。

此参数用于设置最后一分钟放音提示音,此值填写SP定制的放音文件名,例如lastmin_voice1.wav,参数取值有以下两种场景:

  • SP无需定制个性化放音,无需配置此参数,系统将使用默认放音文件,放音内容为:“本次通话时长还剩1分钟”
  • SP需要定制个性化放音,接口消息中携带此参数,参数值携带定制的放音文件名,请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。

lastMinToUE

String(枚举)

both

当maxDuration字段设置为非0时此参数有效。

此字段用于设置最后一分钟放音的播放对象。

  • toa:仅对主叫用户放音。
  • tob:仅对被叫用户放音。
  • both:同时给主叫和被叫用户放音。

不携带时,参数值默认为both。

playPreVoice

String(枚举)

false

此字段用于设置主叫(callerNbr)应答语音回呼后,呼叫被叫(calleeNbr)前,是否向主叫(callerNbr)播放提示音。

当该参数设置为true时,播放完主叫提示音(preVoice)后才播放主叫等待音(waitVoice)并呼叫被叫(calleeNbr)。

  • true:播放提示音。
  • false:不播放提示音。

不携带时,参数值默认为false。

preVoice

String(1-128)

当playPreVoice字段设置为true时此参数有效。

此字段用于设置主叫(callerNbr)应答语音回呼后,呼叫被叫(calleeNbr)前向主叫播放的提示音,此值填写放音文件名,例如pre_voice1.wav。

  • SP无需定制个性化放音文件,接口消息中无需携带此参数,系统将使用默认放音“正在为您转接中,请稍后”。
  • SP需要定制个性化放音文件,接口消息中携带此参数,请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。

waitVoice

String(1-128)

此字段用于设置主叫应答语音回呼后的等待音,此值填写放音文件名,例如wait_voice1.wav。

  • SP无需定制个性化放音文件,接口消息中无需携带此参数,系统将使用默认放音,系统边给主叫放音(循环放音)边拨打被叫用户;被叫应答才中止放音。
  • SP需要定制个性化放音文件,接口消息中携带此参数,请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。

waitVoice可结合calleeMedia使用。

calleeMedia

String(枚举)

all

该参数用于指定被叫的媒体音播放方式,参数取值范围如下:

  • all:透传被叫端的所有放音。当被叫端返回振铃音等媒体音,则终止主叫的等待音,播放被叫的媒体音,如彩铃音等。
  • none:不透传被叫所有放音,一直播放主叫的等待音,直到被叫应答或挂机。
  • fail:只有在被叫回失败放音时(带reason原因值),才终止主叫的等待音、播放被叫的失败放音。

不携带时,参数值默认为all。

statusUrl

String(1-128)

此参数请采用BASE64编码进行加密。

此字段用于设置SP接收状态上报的URL。

语音通话平台将业务触发过程中通话的状态信息(包括呼出、振铃、摘机和挂机信息)推送至此服务器,SP根据通话状态信息确定用户状态。

URL可填写为https://IP:Port或域名,推荐使用域名。且该域名对应多个服务器,避免单点故障无法接收通知。

URL只能由大小写字母(a-z、A-Z),数字(0-9),中划线(-),英文冒号(:),英文点号(.),以及英文斜杠(/)组成,不支持其它字符。最大128字节。

feeUrl

String(1-128)

此参数请采用BASE64编码进行加密。

此参数用于设置SP接收话单上报的URL。

语音通话平台将业务产生的话单推送至此服务器。

URL可填写为https://IP:Port或域名,推荐使用域名。且该域名对应多个服务器,避免单点故障无法接收话单。

URL只能由大小写字母(a-z、A-Z),数字(0-9),中划线(-),英文冒号(:),英文点号(.),以及英文斜杠(/)组成,不支持其它字符。最大128字节。

recordFlag

String(枚举)

false

此字段设置语音回呼通话过程是否录音。

  • true:开启录音,请在添加应用时开启录音功能。
  • false:不开启录音。

不携带时,参数值默认为false。

recordHintTone

String(1-128)

此字段在recordFlag为true时才有效。

此字段用于设置使用录音功能的提示音,参数传值为指定的放音文件名,例如recordhint_voice1.wav。

  • 无需定制个性化放音时,接口消息中无需携带此参数。
  • 需要定制个性化放音文件时,接口消息中携带此参数,请提前制作放音文件并通过放音文件管理页面提交到语音通话平台。

partyTypeRequiredInDisconnect

String(枚举)

false

该参数用于指定语音通话平台给开发者发送disconnect的呼叫状态时,通知消息是否需要携带通话主动挂机的用户类型(主叫挂机、被叫挂机、平台挂机)。

该参数取值范围如下:

  • true:需要携带
  • false:不需要携带

不携带该参数时,默认值为false。

returnIdlePort

String(枚举)

false

指示是否需要返回平台空闲呼叫端口数量。

  • true:需要返回
  • false:不需要返回

不携带该参数时,默认值为false。

userData

String(1-256)

此字段用于SP开发者自定义呼叫发起时,设置用户的附属信息,应用场景可以是当开发者想要对每一次呼叫的用户进行跟踪时,该参数可以携带用于标识用户的信息,如customerId123。

语音通话平台不对此参数做强制要求,如果开发者传入此参数,语音通话平台会在后续发给SP的通知消息中携带该参数值。

不允许携带以下字符:“{”,“}”(即大括号)。

不允许包含中文字符,如果包含中文字符请采用Base64编码。

响应参数

表5 响应消息参数说明

参数名称

是否必选

参数类型

默认值

说明

resultcode

String(1-32)

请求返回的结果码。

resultdesc

String(1-128)

请求返回的结果描述。

sessionId

String(1-256)

请求返回的会话sessionId,用于标记一路会话。如果请求失败,则sessionId为空表示会话建立失败。

idlePort

Integer

请求参数中returnIdlePort为true时响应消息携带该参数。

该参数表示平台呼叫端口空闲可用数量,取值范围0~65535。

结果码

请根据以下结果码进行调测,如果有疑问,可联系管理员进行确认。

表6 结果码说明

响应码

结果码

英文描述

中文描述

处理方法

200

0

Success.

成功。

无需处理。

400

1023006

Authorization not contained in the HTTP header.

鉴权失败,请检查鉴权请求正确性。

请检查消息头中是否携带了Authorization,PasswordDigest字段填写是否正确,携带的app_key填写是否正确,且生成随机数的时间与发送请求时的本地时间不能相差太大。

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属性。

1023033

HTTP header not found X-AKSK field.

HTTP头未找到X-AKSK字段。

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

1023034

UserName not contained in X-AKSK.

X-AKSK字段中未找到UserName属性。

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

1023035

Nonce not contained in X-AKSK.

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

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

1023036

Created not contained in X-AKSK.

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

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

1023037

PasswordDigest not contained in X-AKSK.

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

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

1023038

UsernameToken not contained in X-AKSK.

X-AKSK中没有携带UsernameToken。

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

401

1010010

Invalid digest.

PasswordDigest校验失败。

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

1010013

Time out limit.

时间超出限制。

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

403

1010002

Invalid request.

非法请求。

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

1010003

Invalid app_key.

无效的app_key。

检查请求携带的app_key是否填写正确,app_key从应用管理页面获取,若填写正确,请在应用管理页面检查请求携带的app_key所属应用状态是否正常。

1010006

Invalid Rest API.

无效的Rest API。

检查请求方法填写是否正确。

1010008

The status of the app_key is unavailable.

app_key被暂停使用。

请在应用管理页面检查请求携带的app_key所属应用状态是否正常。

1010009

No more APIs can be invoked.

API达到调用上限。

请稍等一分钟后再试,并联系管理员申请更高的应用使用配额。

1010010

The flow control upper limit is reached on the platform.

平台达到系统流控上限。

请稍等一分钟后再试。

1010011

The app is not allowed to access a commercial address.

APP没有访问商用地址的权限。

请在应用管理页面检查请求携带的app_key所属应用状态是否正常。

1010021

Application unavailable.

应用不可用。

请在应用管理页面检查请求携带的app_key所属应用状态是否正常。

1010023

Invalid display number.

号码填写不合法。

检查displayNbr和displayCalleeNbr参数的填写是否合法,与号码管理页面的“固话号码”保持一致。若合法,请确认该号码是否已申请并下发。申请号码在号码订购页面申请,号码下发后可在号码管理页面查看。

1010024

Invalid caller number.

主叫号码不合法。

检查callerNbr参数的填写是否合法

1010040

The app_key is not allowed to invoke the API.

app_key没有调用本API的权限。

请联系管理员确认该app_key对应的应用是否具有语音回呼能力。

1012001

Resource of number is not to be applied.

资源未申请。

app_key和业务号码未绑定

1012006

The service number is not applied.

业务号码未申请。

请确认是否申请业务号码。

1012012

Application does not open recording function.

应用未开启录音功能。

请在应用管理页面确认请求携带的app_key是否开启了录音功能。

1013001

Calls exceed the SP limit.

请求次数超过SP配置上限。

请和管理员确认开发者呼叫数量限制。

1013002

Calls exceed the APP limit.

请求次数超过应用配置上限。

请和管理员确认应用呼叫数量限制。

1013003

Calls exceed the display number limit.

SP的主显号码受限。

请和管理员确认显示号码呼叫数量限制。

1013004

Callee in blacklist.

被叫用户是黑名单。

被叫号码在运营商黑名单库。

1013010

Caller in blacklist.

主叫用户是黑名单。

主叫号码在运营商黑名单库。

1013011

Callee is not on the whitelist.

被叫用户不在白名单中。

请和管理员确认被叫号码白名单限制。

1013100

Common error code .

未知错误

请和管理员确认安全管控限制。

1013101

Abnormal call restricted .

呼叫行为异常。

和管理员确认安全管控限制

1013111

International callin is forbidden.

国际呼入限制

请检查请求的号码格式是否为国际号码格式。

1013112

International callout is forbidden.

国际呼出限制

请检查请求的号码格式是否为国际号码格式。

1013113

Abnormal call duration restricted.

通话时间异常。

请检查请求的号码是否通话时间异常。

1013115

Abnormal call completion rate restricted.

呼叫接通率异常。

请检查请求的号码是否呼叫接通率异常。

1013116

Caller call frequency restricted.

主叫呼叫频次限制。

请检查主叫号码是否有呼叫频次限制。

1013117

Callee call frequency restricted.

被叫呼叫频次限制。

请检查被叫号码是否有呼叫频次限制。

1013118

Service number call frequency restricted.

业务号码呼叫频次限制。

请检查业务号码是否有呼叫频次限制。

1013119

Service number suspend.

业务号码被暂停。

请和管理员确认号码状态。

1013120

Ip address is null.

IPv4地址未携带

请客户接口携带请求发送方IPv4地址

1013121

Call black time forbidden.

呼叫时段限制。

呼叫时段为休息时段,请工作时段再呼叫。

1013122

Sub enterprise is suspended.

子企业已被暂停。

查看是否因投诉被下线,可查看订购号码时填写的邮箱是否有业务下线通知邮件。

1020165

The number of app_key voice call ports exceeds the upper limit.

超出语音呼叫端口数限制。

请稍等一分钟后再试。建议联系管理员为该应用申请更多的端口配额。

1020166

The app client ip is not in ip white list.

请求发送方app IP不在白名单列表中。

运营商IP地域管控,此地区无法呼通。

1020168

The call is rejected because the login IP of the peer app is blacklisted .

请求发送方app登录IP是黑名单。

运营商IP地域管控,此地区无法呼通。

1020171

The call is rejected because the login IP of the peer app is blacklisted area.

请求发送方app登录IP在受限地域。

运营商IP地域管控,此地区无法呼通。

1020176

Authentication failed, try again later

鉴权失败,稍后重试

IP因鉴权失败次数过多导致被拉黑,请30分钟后重试,或联系管理员放通该IP。

500

1010001

Internal system error.

系统错误。

请联系管理员处理。

1020001

Parameter error.

参数错误。

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

1020002

Internal error.

内部错误。

请联系管理员处理。

1020150

The app_key is invalid.

app_key无效。

检查请求携带的app_key是否填写正确,app_key从应用管理页面获取,若填写正确,请在应用管理页面检查请求携带的app_key所属应用状态是否正常。

1020151

The bindNum is invalid.

业务号码无效。

业务号码无效,请联系管理员处理。

1020154

Insufficient voice ports.

语音端口不足。

请稍等一分钟后再试,并联系管理员申请扩容语音端口。

1023001

Internal error.

内部错误。

请联系管理员处理。

1023002

Response timeout.

响应超时。

重新发送一次请求。

1040001

south ne error with responseCode: %$ and responseMsg: %$.

南部网元错误。

请联系管理员处理。

接口示例

  • 请求示例
    POST /rest/httpsessions/click2Call/v2.0  HTTP1.1
    
    content-type: application/json;charset=UTF-8
    authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"
    x-aksk: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="****",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"
    Content-Length:xx
    { 
    "displayNbr":"+86755****8888", 
    "callerNbr":"+86137****0001", 
    "calleeNbr":"+86137****0002", 
    "displayCalleeNbr":"+86755****8888", 
    "userData":"cwgtest" 
    }
  • 响应示例
    HTTP/1.1 200 OK 
    Content-Type: application/json;charset=UTF-8 
    { 
    "resultcode":"0", 
    "resultdesc":"Success", 
    "sessionId":"1202_566_0_20161228102743@callenabler.home1.com" 
    }     

代码样例

前往代码样例查看。

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容