华为云用户手册

变更配置后对计费的影响 当前包年的工业工作台服务的规格不满足您的业务需要时，您可以发起变更规格操作，变更时系统将按照如下规则为您计算变更费用： 资源升配：新规格价格高于老规格价格，此时您需要支付新老配置的差价。 资源降配：资源降配会影响工作台配置，MIW暂不支持资源降配。 这里以资源升配且无任何优惠的场景为例，假设您在2023/04/08购买了专业版基础型实例，购买时长为1年，计划在2023/04/18变更规格为专业版标准型实例。旧配置价格为14000元/年，新配置价格为54000元/年。计算公式如下： 升配费用=新配置价格*剩余周期-旧配置价格*剩余周期 公式中的剩余周期为每个自然月的剩余天数/对应自然月的最大天数。本示例中，剩余周期=12（4月份剩余天数）/ 30（4月份最大天数）+ 8（5月份剩余天数）/ 31（5月份最大天数）+11（周期剩余月份）=11.6581，代入公式可得升配费用=54000*11.6581÷12-14000*11.6581÷12=33860.33（元） 费用计算结果保留小数点后两位，第三位四舍五入。如遇四舍五入后不足￥0.01，则按￥0.01展示。 实例规格和扩容包单价以售卖页的价格为准。 更多信息请参见变更资源规格费用说明。

到期后影响 图2描述了工业工作台服务各个阶段的状态。购买后，在计费周期内服务正常运行，此阶段为有效期；服务到期而未续费时，将陆续进入宽限期和保留期。 图2 包年MIW生命周期 到期预警 包年工业工作台服务在到期前第7天内，系统将向用户推送到期预警消息。预警消息将通过邮件、短信和站内信的方式通知到华为云帐号的创建者。 到期后影响 当您的包年工业工作台服务到期未续费，首先会进入宽限期，资源状态变为“已过期”。如果您在宽限期内仍未续费工业工作台服务，那么就会进入保留期，资源状态变为“已冻结”，您将无法对处于保留期的包年资源执行任何操作。 保留期到期后，若包年工业工作台服务资源仍未续费，那么服务将无法访问，数据无法恢复。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 关于续费的详细介绍请参见续费概述。

背景信息 在购买开天工业工作台服务后，如果发现当前规格套餐无法满足业务需求，您可以变更套餐规格。当需要变更到高规格套餐时，需补齐版本差价，剩余服务周期按照剩余天数（不含闰年的2.29号）/365 进行计算（变更当天不算） ，续费时按照变更后的版本进行续费。 升级版本费用 = 升级后版本价格 * 剩余周期 - 未升级版本价格 * 剩余周期 剩余周期计算：按照实际剩余有效期进行换算 示例：2023/11/1客户购买了3年的开天工业工作台服务套餐，有效期截止到2026/11/1，客户在2024/5/1发生变更版本，则剩余周期=2024年剩余周期+2025年剩余周期+2026年剩余周期=244/365+1+305/365=2.50（年）。

适用计费项 以下计费项支持包年。 表1 适用计费项 计费项 详细规格 计费模式 专业版基础型 支持用户数100个。 提供IM即时消息 、 日历 、 通讯录 、 审批 、 待办中心 、 新闻资讯 、 企业公告等办公应用。 提供统一组织 、 统一账号 、 统一授权 、 统一登录 、 应用分组管理 、 支持企业在华为云的自建应用对接。 支持默认门户和定制门户。 支持集成流编排和运行 (40条流)。 包年 专业版标准型 支持用户数500个。 提供IM即时消息 、 日历 、 通讯录 、 审批 、 待办中心 、 新闻资讯 、 企业公告等办公应用。 提供统一组织 、 统一账号 、 统一授权 、 统一登录 、 应用分组管理 、 支持企业在华为云的自建应用对接。 支持默认门户和定制门户。 支持集成流编排和运行 (80条流)。 包年 专业版增强型 支持用户数1000个。 提供IM即时消息 、 日历 、 通讯录 、 审批 、 待办中心 、 新闻资讯 、 企业公告等办公应用。 提供统一组织 、 统一账号 、 统一授权 、 统一登录 、 应用分组管理 、 支持企业在华为云的自建应用对接。 支持默认门户和定制门户。 支持集成流编排和运行 (200条流)。 包年 扩容包 1个扩容包包含100个用户数和10条集成流。 说明： 扩容包不可单独购买。当实例规格为专业版基础型和专业版标准型时，支持订购扩容包。 包年 假设您计划购买开天工业工作台服务，在购买工作台页面底部，您将看到所需费用的明细，如图1所示。 图1 配置费用示例 配置费用包括以下部分： 实例版本套餐：根据所选套餐和购买时长计算的费用。 扩容包：根据是否购买扩容包、扩容包数量和购买时长计算的费用。 仅专业版基础型和专业版标准型支持订购扩容包，且扩容包的购买时长与实例版本套餐购买时长一致。

适用场景 包年计费模式需要用户预先支付一定时长的费用，适用于长期、稳定的业务需求。以下是一些适用于包年计费模式的业务场景： 稳定业务需求：对于长期运行且资源需求相对稳定的业务，如企业官网、在线商城、博客等，包年计费模式能提供较高的成本效益。 长期项目：对于周期较长的项目，如科研项目、大型活动策划等，包年计费模式可以确保在整个项目周期内资源的稳定使用。 业务高峰预测：如果能预测到业务高峰期，如电商促销季、节假日等，可提前购买包年资源以应对高峰期的需求，避免资源紧张。 数据安全要求高：对于对数据安全性要求较高的业务，包年计费模式可确保资源的持续使用，降低因资源欠费而导致的数据安全风险。

计费示例 假设您在2023/03/08 15:50:04购买了包年的工业工作台服务，购买时长为一年，并在到期前手动续费1年，则： 第一个计费周期为：2023/03/08 15:50:04 ~ 2024/03/08 23:59:59 第二个计费周期为：2024/03/08 23:59:59 ~ 2025/03/08 23:59:59 您需要为每个计费周期预先付费，计费公式如表2所示，其中扩容包为可选项。 表2 计费公式 实例版本 计费公式 专业版基础型 （实例规格单价+订购扩容包单价 * 扩容包数量） * 购买时长 专业版标准型 （实例规格单价+订购扩容包单价 * 扩容包数量） * 购买时长 专业版增强型 实例规格单价 * 购买时长

计费说明 开天工业工作台的计费项由实例规格费用、购买时长、扩容包数量和扩容包费用组成。具体内容如表1所示。 标 * 的计费项为必选计费项。 表1 开天工业工作台计费项 计费项 计费项说明 适用的计费模式 计费公式 * 实例规格 开天工业工作台提供的实例版本有：基础版、专业版基础型、专业版标准型、专业版增强型，您可以根据实际业务需要按需选择，实例详细规格可参考表1。 其中基础版为免费使用版本，免费使用6个月后，用户可根据实际情况选择专业版基础型、专业版标准型或专业版增强型。 如果您当前使用的实例版本不能满足需要，工业工作台服务支持变更配置，例如从“专业版基础型”升级到“专业版标准型”，对现有业务没有影响。 包年 实例规格单价 * 购买时长 实例规格单价以售卖页的价格为准。 扩容包 1个扩容包包含100个用户数和10条集成流，您可以根据实际业务需要按需选择。 扩容包不可单独购买。当实例规格为专业版基础型和专业版标准型时，支持订购扩容包，扩容包购买时长与套餐一致。 包年 扩容包单价 * 购买时长* 购买个数 扩容包单价以售卖页的价格为准。

附录2-呼叫拆线点说明 拆线点 拆线点描述 0 接通后主动挂机 100 放音收号时系统接收到的号码为空，若要进行收号，请在语音通知内容播放完毕后的5秒之内进行按键操作 501 录音创建会议失败 502 录音创建会议超时 503 录音主叫加入会议失败 504 录音主叫加入会议超时 505 录音增加录音端点失败 506 录音增加录音端点超时 507 启动录音失败 508 启动录音超时 509 放录音提示音失败 510 放录音提示音超时 512 录音VCU倒换释放呼叫 513 呼叫超时 514 振铃超时 515 远端用户主动Cancel 516 本端用户主动Cancel 517 平台响应超时 518 远端用户呼叫失败，请结合Q850原因值分析 519 本端用户呼叫失败(OXX)，请结合Q850原因值分析 520 本端用户呼叫失败(18X)，请结合Q850原因值分析 521 远端呼叫还未振铃已经拆线 522 语音端口不足 524 放音文件不存在 526 静音失败 527 取消静音失败 528 限制呼叫非特定前缀的号码 529 appkey不存在 530 forward前主叫挂机 539 录音流程未完成，主叫主动挂断电话 540 录音流程未完成，被叫主动挂断电话 541 被叫接通后和主叫的重协商失败 542 录音超时释放呼叫 550 本端呼叫振铃失败 551 点击呼叫本端收到OXX消息 552 远端振铃时本端用户挂机 553 远端还未振铃时本端用户挂机 400~699 在对端没有返回Q850原因值时，直接用SIP消息码（如404：NOT FOUND） 1001 坐席主动挂机 1002 用户主动挂机 1003 SP调用总机释放接口挂机 1004 发起点击外呼后，坐席进行盲转并挂机 2801 IVR放音失败 2802 IVR规则无效 2803 IVR按键超过最大次数 2805 IVR不在服务时间-1 2806 IVR不在服务时间-2 2810 未配置MRF 2811 未配置I CS CF 2812 放音超时 2825 满意度调查结束-1（配置满意度结束音） 2829 拨分机号被叫忙或者无应答 2831 企业呼入License受限 2837 放音失败 2838 INVITE超时释放 2847 总机选线无可用坐席 2853 坐席不可用，拒接呼入 2863 留言创建录音失败 2868 企业已停机 2871 动态ivr等待sp指令超时 2901～2914 录音失败 7001 开发者呼叫频次管控 7002 应用呼叫频次管控 7003 显示号码呼叫频次管控 7004 被叫黑名单呼叫管控 7005 主叫黑名单呼叫管控 7100 app信息不存在 7105 业务类型不匹配 7106 APP未申请个人小号能力 7107 安全管控提示音放音失败 7108 用户状态已冻结 7109 语音端口不足 8000 内部错误 8001 用户未接续成功，可能包含以下场景： 开发者/应用/固话号码呼叫频次管控：若使用的是95号码，请重新申请固话，（流程：请先添加应用，再参考添加企业完善企业信息，最后参考订购号码申请固话号码）。其他情况请联系华为云客服处理 线路故障/运营商故障：请拨打400电话联系华为云客服处理 被叫关机/无应答/用户正忙等：请核实被叫手机终端是否处于正常状态 8002 接续用户时对端返回失败放音 8003 用户振铃超时 8004 用户振铃时挂机 8005 TTS 转换失败 8006 放音文件不存在 8007 给用户放音失败 8008 给用户放音收号失败，若要进行收号，请在语音通知内容播放完毕后的5秒之内进行按键操作 8009 接通前主叫用户主动挂机 8010 超过通话最大时长挂机 8011 内部错误 8012 无效的app_key 8015 给用户录音失败 8017 客户指示挂机 8018 业务无权限 8020 业务异常 8100 被叫号码不存在 8101 被叫无应答 8102 被叫用户正忙（被叫正在通话、振铃等） 8103 被叫用户暂时无法接通 8104 被叫已关机（被叫处于关机、飞行模式、无网络等状态） 8105 被叫挂机或被叫已停机 8106 主叫号码不存在 8107 主叫无应答 8108 主叫用户正忙（主叫正在通话、振铃等） 8109 主叫用户暂时无法接通 8110 主叫已关机（主叫处于关机、飞行模式、无网络等状态） 8111 主叫挂机或主叫已停机 父主题： 附录

附录1-Q850原因值说明 原因值 原因值描述 0 不涉及 1 无法找到号码 2 无法路由到网络 3 无法路由到目的地 4 发送特殊消息 5 中继前缀出错 6 通道无法接入 7 已经建立频道 8 抢先占有 9 抢先占有保留 16 正常呼叫清除 17 用户忙 18 无应答 19 无用户应答 20 用户不可及 21 拒绝呼叫 22 号码已改变 23 重定向 25 交换路由错误 26 无用户准许 27 目标无序 28 非法号码格式 29 设备拒绝 30 状态查询 31 正常 34 路由不可达 38 网络状态不好 39 服务链接不上 40 链接进行中 41 暂时失败 42 设备拥塞 43 信息丢弃 44 通道无法接入 46 呼叫阻塞 47 无可用资源 49 品质无效 50 设备没预订 53 闭合群OCB呼出受限 55 闭合群ICB呼入受限 57 无权限发送 58 发送无效 62 等级不一致 63 服务无效 65 发送无法执行 66 通道无法执行 69 设备无效 70 发送有效 79 CV服务没设置 81 引用非法值 82 通道不存在 83 ID不存在 84 呼叫ID不存在 85 无呼叫等待 86 隐藏号码呼叫 87 CUG无成员 88 目标冲突 90 CUG不存在 91 无效网络 95 无效信息 96 非托管元素 97 类型不存在 98 信息没执行 99 信息单元不存在 100 无效的信息单元 101 呼叫状态不一致 102 定时器超时 103 参数不存在 110 消息中带有未识别的参数 111 协议错误 127 未指定的交互 父主题： 附录

接口示例 请求示例 示例1POST /rest/httpsessions/callnotify/v2.0 HTTP/1.1 content-type: application/json;charset=UTF-8authorization: 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":"+86186****5611", "calleeNbr":"+8675581****01", "playInfoList":[{"notifyVoice":"welcome.wav"},{"notifyVoice":"welcome.wav","collectInd":4}], "statusUrl":"****", "feeUrl":"****", "userData":"testUserData" }示例2语音通话平台上设置的模板ID=test_template，模板内容为“您有${NUM_2}件快递请到${TXT_32}领取”。下面的API将播放文本“您有3件快递请到人民公园正门领取”。POST /rest/httpsessions/callnotify/v2.0?app_key=z4Sdu8p7nml5Wd790aENW64oV5Fp HTTP/1.1 content-type: application/json;charset=UTF-8authorization: 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":"+86186****5611", "calleeNbr":"+8675581****01", "playInfoList":[{"templateId":"test_template", "templateParas":["3","人民公园正门"],"collectInd":5}], "statusUrl":"****", "feeUrl":"****", "userData":"testUserData" } 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "resultcode":"0", "resultdesc":"Success","sessionId":"1200_366_0_20161228102743@callenabler.home1.com"}

结果码 请根据以下结果码进行调测，如果有疑问，可联系管理员进行确认。 表8 结果码说明 响应码 结果码 英文描述 中文描述 处理方法 200 0 Success. 成功。 无需处理。 400 1023006 Authorization not contained in the HTTP header. Authentication fails. Check whether the authentication request is correct. 鉴权失败，请检查鉴权请求正确性。 请检查消息头中是否携带了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和业务号码未绑定。 1012005 %s of templateParas does not meet template requirements. 参数templateParas中的%s不符合模板定义的要求。 请检查templateParas携带的变量值格式与长度是否符合templateId对应的模板内容中变量的定义。 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. 响应超时。 重新发送一次请求。

响应参数 表7 响应消息参数说明 参数名称 是否必选 参数类型 默认值 说明 resultcode 是 String(1-32) 无 请求返回的结果码。 resultdesc 是 String(1-128) 无 请求返回的结果描述。 sessionId 是 String(1-256) 无 请求返回的会话sessionId，如果请求失败，则sessionId为空。 idlePort 否 Integer 无 请求参数中returnIdlePort为true时响应消息携带该参数。 该参数表示平台呼叫端口空闲可用数量，取值范围0~65535。

接口功能 语音通知是SP将被叫号码和语音通知文件名（语音文件需要提前通过放音文件管理页面上传）或语音通知文本（通过语音模板管理页面提交）发送给业务平台，由业务平台呼叫被叫，被叫接听后业务平台向被叫播放语音，并进行收号。SP可以要求业务平台播放多段语音，每段语音的内容都可以是下列两种语音中的一种： 语音文件中录制的语音。 文本（需要先通过模板定义）通过TTS服务转换成的语音。 业务体验描述： SP想要给用户A通知一段或多段语音。 SP向语音通话平台发送播放语音通知业务请求。 语音通话平台呼叫用户A的号码。 用户A接听。 语音通话平台向用户A播放语音。

请求参数 表2 请求URL参数说明 参数名称 是否必选 参数类型 默认值 说明 version 是 String(枚举) 无 版本，取值为v2.0。 表3 请求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 (Password，Nonce + Created))生成。其中，Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可，无需包含+号和空格。 Nonce：客户发送请求时生成的一个随机数，长度为1~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created：随机数生成时间。采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同，部分语言可参考表4。 表4 不同编程语言的时间格式 编程语言 时间格式 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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 表5 请求Body参数说明 参数名称 是否必选 参数类型 默认值 说明 displayNbr 是 String(4-31) 无 固话号码，被叫终端上显示的主叫号码，需要提前在订购号码页面申请该号码。 号码格式（固话）：国家码+区号+固话，与号码管理页面的“固话号码”保持一致。 若该号码为“暂停”状态，语音通话平台会从该应用下随机选取一个其他可用的固话号码进行外呼。 calleeNbr 是 String(4-31) 无 被叫号码。 手机号码格式：+{国家码}{手机号码}。示例：+86134****2222。 固话格式：+{国家码}{区号}{固话号码}，其中区号需去掉首位的0。示例：国家码86，区号0755，固话号码28****01，填写为+8675528****01。 playInfoList 是 PlayContentInfo[1-5] 无 播放信息列表，最大支持5个，每个播放信息携带的参数都可以不相同。 statusUrl 否 String(1-128) 无 此参数请采用BASE64编码进行加密。 此字段用于设置SP接收状态上报的URL。 语音通话平台将业务触发过程中通话的状态信息（包括呼出、振铃、摘机和挂机信息）推送至此服务器，SP根据通话状态信息确定用户状态。 URL可填写为https://IP:Port或 域名 ，推荐使用域名。且该域名对应多个服务器，避免单点故障无法接收通知。 URL只能由大小写字母（a-z、A-Z），数字（0-9），中划线（-），英文冒号（:），英文点号（.），以及英文斜杠（/）组成，不支持其它字符。 feeUrl 否 String(1-128) 无 此参数请采用BASE64编码进行加密。 此参数用于设置SP接收话单上报的URL。 语音通话平台将业务产生的话单推送至此服务器。 URL可填写为https://IP:Port或域名，推荐使用域名。且该域名对应多个服务器，避免单点故障无法接收话单。 URL只能由大小写字母（a-z、A-Z），数字（0-9），中划线（-），英文冒号（:），英文点号（.），以及英文斜杠（/）组成，不支持其它字符。 returnIdlePort 否 String(枚举) false 指示是否需要返回平台的空闲端口数量。 true：需要返回 false：不需要返回 如果不携带该参数，系统默认该参数为false。 userData 否 String(1-256) 无 用户附属信息，此标识由第三方服务器定义，会在后续的通知消息中携带此信息。 不允许携带以下字符：“{”，“}”（即大括号）。 不允许包含中文字符，如果包含中文字符请采用Base64编码。 表6 PlayContentInfo定义 参数名称 是否必选 参数类型 默认值 说明 notifyVoice 否 String(1-128) 无 通知语音的放音文件名。需要先通过放音文件管理页面上传放音文件并通过审核才能使用。 当前系统只支持Wave格式的音频文件，文件如“notifyvoice.wav”。 该参数和templateId是二选一的关系，即两个参数必须携带其中一个。 templateId 否 String(1-32) 无 语音通知模板ID，用于唯一标识语音通知模板。语音通知模板为TTS文本的模板，需要先通过语音模板管理页面提交模板并通过审核才能使用，并获取对应的模板ID。 该参数和notifyVoice是二选一的关系。需要与templateParas参数配合使用。 templateParas 否 String(1-32)[1-10] 无 语音通知模板的变量值列表，用于依次填充templateId参数指定的模板内容中的变量。 该参数需填写为JSONArray格式。具体可参考变量规则。 参数内容必须是“UTF-8”编码，不能包含以下3个字符：“$”，“{”，“}”。 当接口中携带“templateId”参数时，必须携带此参数，若未携带此参数系统将返回“非法请求”错误。 列表中变量值的个数及长度必须和templateId对应模板内容中定义的变量个数及长度保持一致；例如templateId对应的模板内容有2个变量且变量长度分别为5和6，则此处需要设置2个变量值且内容长度分别小于等于5和6。 如模板内容为“您有${NUM_2}件快递请到${TXT_32}领取”时，该参数可填写为["3","人民公园正门"]。 collectInd 否 Integer(0-32) 0 是否进行收号。若进行收号，请在语音通知内容播放完毕后的5秒之内进行按键操作，系统会将用户输入的号码通过语音通知呼叫状态通知API发送给SP。 取值范围： 0：不收号 1~32：收号，并且取值表示收号位长，最大支持32位。 若不携带该参数，则默认不收号。 replayAfterCollection 否 String(枚举) false 当collectInd字段设置为非0时此参数有效。 此字段用于设置是否在收号后重新播放notifyVoice、ttsContent或templateId指定的放音。 true：播放。 false：不播放。 默认值：false。 collectContentTriggerReplaying 否 String(1-32) 无 当replayAfterCollection字段设置为true时此参数有效。 此字段用于设置触发重新放音的收号内容。只有实际收号内容与该参数值一致时，才重新放音。例如：该参数设置为1，当用户根据收号语音提示按1，两者一致，则重复放音。

响应参数 接收到话单通知时，第三方服务器返回200响应，同时若携带表6中的响应参数，系统则会根据resultcode参数值判断是否推送成功。 表6 响应消息参数说明 参数名称 是否必选 参数类型 说明 resultcode 否 String(0-32) 请求返回的结果码。 0为成功 其他均为失败 resultdesc 否 String(0-128) 请求返回的结果描述。 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8{"resultcode":"0","resultdesc":"Success"}

表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(appSecret, url+安全随机数+时间戳))生成。其中，url使用客户设置的话单推送URL，随机数需使用安全随机数。 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(枚举) 该参数标识API事件通知的类型。取值范围如下： fee：话单事件 feeLst 否 FeeInfo[1-50] 呼叫话单事件的信息，参数取值为列表，最大50条。 当eventType参数为fee时携带。 FeeInfo 表5 fee：话单事件 参数名称 是否必须 参数类型 默认值 描述 direction 是 Integer (0-1) 无 通话的呼叫方向，以语音通话平台为基准。 0表示呼出（外呼） spId 是 String(1-32) 无 客户的云服务账号。 appKey 是 String(1-32) 无 应用的app_key。 icid 否 String(1-64) 无 呼叫记录的唯一标识。 bindNum 是 String(1-32) 无 发起此次呼叫的固话号码。 号码仅支持全局号码格式（包含国家码），比如+8675528****02。 sessionId 是 String(1-256) 无 通话链路的唯一标识。 callerNum 是 String(1-32) 无 主叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。 注：callerNum为SP设置的来电显示号码（displayNbr）。 calleeNum 是 String(1-128) 无 被叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。 注：calleeNum为A号码。 callEndTime 否 String(1-128) 无 呼叫结束时间。 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 fwdUnaswRsn 否 Integer 无 转接呼叫操作失败的Q850原因值。详细说明参见附录1-Q850原因值说明。 failTime 否 String(1-128) 无 呼入、呼出的失败时间。 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 ulFailReason 否 Integer 无 通话失败的拆线点。详细说明参见附录2-呼叫拆线点说明。 sipStatusCode 否 Integer 无 呼入、呼出的失败SIP状态码。 callOutStartTime 否 String(1-128) 无 Initcall的呼出开始时间 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 callOutAlertingTime 否 String(1-128) 无 Initcall的呼出振铃时间 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 callOutAnswerTime 否 String(1-128) 无 Initcall的呼出应答时间 该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。 callOutUnaswRsn 否 Integer NA Initcall的呼出失败的Q850原因值。 详细说明参见附录1-Q850原因值说明。 recordFlag 否 Integer (0-1) 无 该字段用于录音标识，参数值范围如： 0：表示未录音 1：表示有录音 ttsPlayTimes 否 integer 无 应用TTS功能时，使用TTS的总次数。 ttsTransDuration 否 integer 无 应用TTS功能时，TTS Server进行TTS转换的总时长。单位为秒。 serviceType 否 String(1-32) 无 携带呼叫的业务类型信息，取值范围： 001：语音播放 hostName 否 String(1-128) 无 该参数用于标识话单生成的服务器设备对应的主机名。 userData 否 String(0-256) 无 用户附属信息，此参数的值与“语音验证码场景API”中的"userData"参数值一致。 响应示例 POST /status HTTP/1.1Content-Length: xx {"eventType":"fee","feeLst":[{"direction":0,"spId":"CaaS_Test_01","appKey":"7VN6w60Pl3e1E5C8310517x32698","icid":"CAE-20190124105808-12009374","bindNum":"+8675528****02","sessionId":"1200_164_4294967295_20190124025808@callenabler245.huaweicaas.com","callerNum":"+86138****0021","calleeNum":"+86138****7021","callEndTime":"2019-01-24 02:58:36","fwdUnaswRsn":0,"ulFailReason":0,"sipStatusCode":0,"callOutStartTime":"2019-01-24 02:58:08","callOutAlertingTime":"2019-01-24 02:58:13","callOutAnswerTime":"2019-01-24 02:58:24","callOutUnaswRsn":0,"recordFlag":0,"ttsPlayTimes":0,"ttsTransDuration":0,"serviceType":"001","hostName":"callenabler245.huaweicaas.com"}]}

使用说明 前提条件 SP在开发应用时，若需订阅话单通知，必须要提供话单接收URL（feeUrl），并且确保URL能够正常处理语音通话平台发送的通知信息。 提供话单接收URL有以下两种方式： 提前通过应用管理向语音通话平台提交话单接收URL。 SP应用调用场景API时，填写feeUrl参数。 注意事项 若平台给SP推送话单后未收到成功响应，视为推送失败，会重新推送话单，直至客户返回成功响应。平台最多重推6次，每次时间间隔1小时。 单个用户（一路呼叫）的话单通知是根据呼叫状态顺序推送的，一通通话会推送一条话单。但同一个应用下，如果多个用户（多路呼叫）的通话结束时间（callEndTime）相同，话单会合并在一起发送，最多不超过50条。 使用限制 语音通话平台推送话单信息给开发者应用，仅支持POST方式。

通话挂机原因值说明 通话挂机原因值 原因值描述 0 接通后主动挂机 7001 开发者呼叫频次管控 7002 应用呼叫频次管控 7003 固话号码呼叫频次管控 7004 被叫黑名单呼叫管控 7108 用户状态已冻结 7109 语音端口不足 8000 内部错误 8001 用户未接续成功，可能包含以下场景： 开发者/应用/固话号码呼叫频次管控：若使用的是95号码，请重新申请固话，（流程：请先添加应用，再参考添加企业完善企业信息，最后参考订购号码申请固话号码）。其他情况请联系华为云客服处理 线路故障/运营商故障：请拨打400电话联系华为云客服处理 被叫关机/无应答/用户正忙等：请核实被叫手机终端是否处于正常状态 8002 接续用户时对端返回失败放音 8003 用户振铃超时 8004 用户振铃时挂机 8005 TTS转换失败 8006 放音文件不存在 8007 给用户放音失败 8008 给用户放音收号失败，请在语音通知内容播放完毕后的5秒之内进行收号操作 8009 接通前主叫用户主动挂机 8010 超过通话最大时长挂机 8012 无效的app_key 8015 给用户录音失败 8017 用户指示挂机 8018 业务无权限 8020 业务异常 8100 被叫号码不存在 8101 被叫无应答 8102 被叫用户正忙 8103 被叫用户暂时无法接通 8104 被叫已关机 8105 被叫挂机或被叫已停机 父主题： 附录

接口示例 请求示例 POST /rest/httpsessions/callVerify/v1.0 HTTP/1.1content-type: application/json;charset=UTF-8authorization: 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":"+8675528****88", "calleeNbr":"+86189****0007", "languageType":2, "preTone":"welcome.wav", "verifyCode":"12345678", "times":3, "userData":"cwgtest" } 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "resultcode":"0", "resultdesc":"Success","sessionId":"1200_366_0_20161228102743@callenabler.home1.com"}

结果码 请根据以下结果码进行调测，如果有疑问，可联系管理员进行确认。 表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. 响应超时。 重新发送一次请求。

响应参数 表5 响应消息参数说明 参数名称 是否必选 参数类型 默认值 说明 resultcode 是 String(1-32) 无 请求返回的结果码。 resultdesc 是 String(1-128) 无 请求返回的结果描述。 sessionId 是 String(1-256) 无 请求返回的会话sessionId，如果请求失败，则sessionId为空。 idlePort 否 Integer 无 请求参数中returnIdlePort为true时响应消息携带该参数。 该参数表示平台呼叫端口空闲可用数量，取值范围0~65535。

请求参数 表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 (Password，Nonce + 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) 无 固话号码，被叫终端上显示的主叫号码，需要提前在订购号码页面申请该号码。 号码格式（固话）：国家码+区号+固话，与号码管理页面的“号显号码”保持一致。 若该号码为“暂停”状态，语音通话平台会从该应用下随机选取一个其他可用的固话号码进行外呼。 calleeNbr 是 String(4-31) 无 被叫号码。 手机号码格式：+{国家码}{手机号码}。示例：+86134****2222。 固话格式：+{国家码}{区号}{固话号码}，其中区号需去掉首位的0。示例：国家码86，区号0755，固话号码28****01，填写为+8675528****01。 languageType 是 Integer 无 验证码播放的语言类型。 取值范围： 2：中文 preTone 是 String(1-128) 无 播放语音验证码之前需要播放的放音文件名，放音文件需要提前通过放音文件管理页面上传并审核通过才能使用。 当前系统只支持Wave格式的音频文件，文件名如“pretone.wav”。 verifyCode 是 String(2-8) 无 验证码：只支持0～9的数字，最大8位。 如“12345678”。 posTone 否 String(1-128) 无 播放语音验证码之后需要播放的放音文件名。 如果携带该参数，放音文件需要提前通过放音文件管理页面上传并审核通过才能使用。 当前系统只支持Wave格式的音频文件，文件名如“postone.wav”。 如果不携带该参数，系统将在语音验证码播放完毕后结束通话。 times 否 Integer 3 播放次数：0～9。 0表示无限循环。 如果不携带该参数，默认播放3次。 statusUrl 否 String(1-128) 无 此参数请采用BASE64编码进行加密。 此字段用于设置SP接收状态上报的URL。 语音通话平台将业务触发过程中通话的状态信息（包括呼出、振铃、摘机和挂机信息）推送至此服务器，SP根据通话状态信息确定用户状态。 URL可填写为https://IP:Port或域名，推荐使用域名。且该域名对应多个服务器，避免单点故障无法接收通知。 URL只能由大小写字母（a-z、A-Z），数字（0-9），中划线（-），英文冒号（:），英文点号（.），以及英文斜杠（/）组成，不支持其它字符。 feeUrl 否 String(1-128) 无 此参数请采用BASE64编码进行加密。 此参数用于设置SP接收话单上报的URL。 语音通话平台将业务产生的话单推送至此服务器。 URL可填写为https://IP:Port或域名，推荐使用域名。且该域名对应多个服务器，避免单点故障无法接收话单。 URL只能由大小写字母（a-z、A-Z），数字（0-9），中划线（-），英文冒号（:），英文点号（.），以及英文斜杠（/）组成，不支持其它字符。 returnIdlePort 否 String(枚举) false 指示是否需要返回空闲端口数量。 true：需要返回 false：不需要返回 如果不携带该参数，系统默认该参数为false。 userData 否 String(1-256) 无 用户附属信息，此标识由第三方服务器定义，会在后续的通知消息中携带此信息。 不允许携带以下字符：“{”，“}”（即大括号）。 不允许包含中文字符，如果包含中文字符请采用Base64编码。

API列表 API名称 API功能 语音回呼场景API 主叫用户通过应用拨打被叫用户，语音通话平台呼叫主叫和被叫，使主叫和被叫能够互相通话。 终止呼叫场景API 实现通话双方终止呼叫。 语音回呼呼叫状态通知API 语音通话平台向SP推送接收语音通话业务用户呼叫时的状态信息，如呼入、呼出、振铃、应答、挂机等状态的信息。 语音回呼话单通知API 通话结束后，语音通话平台向SP推送通话的话单信息。 获取录音文件下载地址API 获取通话后的录音文件下载地址。

API请求地址 API请求地址由“APP接入地址”和“访问URI”组成，数据来源如下： 参数 来源 示例 APP接入地址 登录管理控制台，从语音通话“应用管理”页面获取。 https://rtccall.cn-north-1.myhuaweicloud.cn:443 访问URI 从各API接口页面中的“接口类型说明”中获取。 语音回呼场景API：/rest/httpsessions/click2Call/v2.0 综上，API请求地址示例如下： 设置语音回呼： https://rtccall.cn-north-1.myhuaweicloud.cn:443/rest/httpsessions/click2Call/v2.0

概述 欢迎使用语音通话服务（VoiceCall）。语音通话服务以云服务的方式提供语音通信能力，支持语音回呼、语音验证码、语音通知。方便快捷，拨通率高；安全可靠，防盗取，防攻击；性能稳定，支持大容量、高并发 本文档提供了语音通话API的描述、参数说明及示例等内容。支持的全部操作请参见API接口使用说明。 在调用API之前，请确保已经充分了解语音通话相关概念及功能详解，详细信息请参见语音通话“产品介绍”。 录音功能涉及个人用户通信内容。建议您只有在所适用法律法规允许的目的和范围内方可启用相应的功能。在使用、存储用户通信内容的过程中，您应采取足够的措施以确保用户的通信内容受到严格保护。 录音功能会涉及用户的通信内容，请确保更换的录音提示音满足当地法律法规的要求。

接口示例 请求示例 POST /rest/httpsessions/callStop/v2.0 HTTP/1.1content-type: application/json;charset=UTF-8authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"x-aksk: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="****",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"content-length:xx { "sessionid":"1200_366_0_20161228102743@callenabler.home1.com", "signal":"call_stop" } 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "resultcode":"0", "resultdesc":"Success" }

结果码 请根据以下结果码进行调测，如果有疑问，可联系管理员进行确认。 表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所属应用状态是否正常。 1020166 The app client ip is not in ip white list. 请求发送方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. appKey无效。 检查请求携带的app_key是否填写正确，app_key从应用管理页面获取，若填写正确，请在应用管理页面检查请求携带的app_key所属应用状态是否正常。 1020152 Invalid sessionid. sessionid无效。 检查请求携带的sessionid是否填写正确。语音回呼的sessionid是调用“语音回呼场景API”的成功响应消息的sessionid参数值，也可通过呼叫状态和话单通知API获取。 1023001 Internal error. 内部错误。 请联系管理员处理。 1023002 Response timeout. 响应超时。 重新发送一次请求，若依然返回响应超时，请联系管理员处理。

请求参数 表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 (Password，Nonce + 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参数说明 参数名称 是否必选 参数类型 默认值 说明 sessionid 是 String(1-256) 无 该参数用于唯一标识一路通话。 signal 是 String(1-128) 无 该参数值指定终止呼叫的方式，目前signal的取值仅固定为“call_stop”，表示主被叫都拆线。

接口示例 请求示例 POST /rest/httpsessions/click2Call/v2.0 HTTP1.1content-type: application/json;charset=UTF-8authorization: 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" }

结果码 请根据以下结果码进行调测，如果有疑问，可联系管理员进行确认。 表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: %$. 南部网元错误。 请联系管理员处理。