华为云用户手册

  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accessCode string True 接入码;最大长度32字符 1.2 extCode string False 扩展码; 最大长度12字符(如果希望一个接入码能设置多个目的设备。这种情况下可通过配置扩展码的方式来实现,例如,接入码为12345,我们可以添加扩展码1,路由到技能队列A,扩展码2,路由到技能队列B。这样客户可直接拨打123451实现直接接入技能队列A。) 1.3 mediaTypeId integer False 媒体类型;默认值:5 字段可选值:(2:语音点击通话 5:音视频 18:视频点击通话 19:视频 53:多媒体) 说明: 1、传入技能队列(devicetype=1)时,mediaTypeId等于传入的技能队列绑定的mediaTypeId(没有绑定默认5) 2、接入码accessCode所属的媒体类型(查询接入码接口返回的mediaTypeId字段)和该入参mediaTypeId的对应关系如下: 5对应5和19; 53对应53; 2对应2和18 1.4 devicetype integer True 设备类型; 1:技能队列 3:IVR 说明:多媒体渠道不能选择IVR流程 1.5 deviceId integer True 目标设备id(技能队列skillId、IVR的id) 说明:传入技能队列(devicetype=1)时,deviceId的对应的媒体类型要和入参mediaTypeId一致
  • 报文样例 请求头: Content-Type:application/jsonX-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXXAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "limit": "10", "offset": 0} 响应参数: { "returnCode": "0", "total": 1, "data": [ { "skillId": 1, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "name": "defaultVideoSkill", "mediaTypeId": 19, "description": "2021ok", "maxWaitNum": 100, "skillParam": { "noAgents": { "transferType": "Release" }, "busy": { "transferType": "Release" }, "answerFunction": "0", "timeOut": { "transferType": "Release" }, "waitVoice": { "parameterType": "Voice" } } } ], "description": "success"}
  • 报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "accessCode": "9911411", "mediatypeId": 5, "description": "接入码", "limit":10, "offset":0} 响应参数: { "returnCode": "0", "data": { "total": 1, "calledRouteList": [ { "id": "1124167935465633793", "accessCode": "9911411", "mediatypeId": 5, "n400Number": null, "description": null, "numCallAttr": 3 } ] }, "description": "success"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accessCode string False 接入码 支持模糊查询 1.2 mediatypeId integer False 媒体类型 2:点击通话 5:音视频 53:多媒体 1.3 description string False 接入码描述 支持模糊查询 1.4 limit integer False 表示每页的查询数量,0-100,默认100,如果输入超过100,将默认查询100条 1.5 offset integer False offset用于确定查询的起始页。offset取值范围为:offset=limit*(page-1),page为需要查询的起始页。offset默认值0,最大值100
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data array[object] False - 1.1.1 id string False 接入码ID 1.1.2 accessCode string False 接入码 1.1.3 mediatypeId integer False 媒体类型: 2:语音点击通话 5:音视频 18:视频点击通话 19:视频 53:多媒体 1.1.4 n400Number string False 接入码页面配置的服务号码,通常为核心网映射的400号码 1.1.5 description string False 接入码描述 1.1.6 numCallAttr number False 号码属性(3:呼入和呼出;2:呼出;1:呼入) 1.2 returnCode string False 返回码 0:成功 其他:失败 1.3 description string False 描述 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "id": "1125397061153369092", "devicetype": 1, "deviceId": 1} 响应参数: { "returnCode": "0", "description": "data update success"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0:成功 其他:失败 1.2 description string False 描述 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 id string True 被叫配置ID 1.2 devicetype integer True 设备类型;1:技能队列 3:IVR 1.3 deviceId integer True 目前设备id(技能队列skillId、IVR的id)
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 dnids string True 配置编号(查询被叫配置时返回的dnid); 删除多个用,隔开;最大删除数1000
  • 报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "dnids": "1,2"} 响应参数: { "returnCode": "0", "data": { "name": "9911411,99114111", "id": "1127983948544239618,1127986019188238339", "content": "9911411,99114111" }, "description": "data delete success"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0:成功 其他:失败 1.2 description string False 描述 1.3 data object False 删除情况展示 1.3.1 id string False 删除的绑定数据id 1.3.2 name string False 删除的绑定数据"accessCode"+"extCode" 1.3.3 content string False 删除的accessCode 1、全部删除成功或者全部删除失败时,和name一样 2、部分删除成功时,字符串结构为"Success:"+"同name一样"+",Failed:"+"同name一样" 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0:成功 其他:失败 1.2 description string False 描述 1.3 data object False - 1.3.1 total integer False 总数 1.3.2 calledRouteList array[object] False 被叫配置列表 1.3.2.1 extCode string False 扩展码 1.3.2.2 editable string False 0或null:可编辑和删除 1:不可编辑,可删除 2:不可删除 3:不可编辑和删除 1.3.2.3 accessCode string False 接入码 1.3.2.4 dnid number False 配置编号 1.3.2.5 id string False 被叫配置ID(表主键id) 1.3.2.6 deviceId number False 目前设备id 1.3.2.7 devicetype number False 设备类型 1:技能队列 3:IVR 1.3.2.8 deviceDesc string False 目的设备描述 1.3.2.9 mediatypeId number False 媒体类型 2:语音点击通话 5:音视频 18:视频点击通话 19:视频 53:多媒体 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "accessCode": "9911411", "extCode": "11", "devicetype": 1, "deviceDesc": "defaultVideoSkill", "mediatypeId": 19, "limit":10, "offset":0} 响应参数: { "returnCode": "0", "data": { "total": 3, "calledRouteList": [ { "id": "1125397061153369092", "dnid": 3, "accessCode": "9911411", "mediatypeId": 19, "extCode": "11", "devicetype": 1, "deviceId": 1, "deviceDesc": "defaultVideoSkill", "editable": "0" }, { "id": "1127983948544239618", "dnid": 1, "accessCode": "9911411", "mediatypeId": null, "extCode": "", "devicetype": 1, "deviceId": 1, "deviceDesc": "defaultVideoSkill", "editable": "0" }, { "id": "1127986019188238339", "dnid": 2, "accessCode": "9911411", "mediatypeId": 19, "extCode": "1", "devicetype": 1, "deviceId": 1, "deviceDesc": "defaultVideoSkill", "editable": "0" } ] }, "description": "success"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accessCode string False 接入码 1.2 extCode string False 扩展码 1.3 devicetype integer False 设备类型 1:技能队列 3:IVR 1.4 deviceDesc string False 设备名称(技能队列/IVR名称)支持模糊匹配 1.5 mediaTypeId integer False 媒体类型 2:语音点击通话 5:音视频 18:视频点击通话 19:视频 53:多媒体 1.6 limit integer False 表示每页的查询数量,0-100,默认100,如果输入超过100,将默认查询100条 1.7 offset integer False offset用于确定查询的起始页。offset取值范围为:offset=limit*(page-1),page为需要查询的起始页。offset默认值为0,如果输入负数,将按照0查询
  • 报文样例 请求头: Content-Type: application/jsonX-APP-KEY: **************************************Authorization: Bearer ************************************** 请求参数: {"phoneNo":"13020017****"} 响应参数: { "returnCode": "0", "data": { "areaCode": "110100", "province": "北京", "city": "北京", "cityCode": "010", "isp": "联通", "postCode": "100000", "phoneNo": "1302001" }, "description": "success"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码,0成功,非0失败 1.2 description string False 返回描述 1.3 data object False 手机号码归属地信息 1.3.1 areaCode string False 地区码 1.3.2 province string False 省 1.3.3 city string False 城市 1.3.4 cityCode string False 城市编码,可能多个,"/"分隔,如果查询的是固话,城市编码可能为空 1.3.5 isp string False 运营商:电信、移动、联通。 如果是固话查询则返回未知 1.3.6 postCode string False 邮政编码,可能多个,"/"分隔,如果查询的是固话,邮政编码可能为空 1.3.7 phoneNo string False 手机号码前7位,或者固话区号 响应状态码: 401 授权失败:1. 参数是否正确有效。 2. 请确认是否购买了相关服务。 3. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求路径可能不对。 响应状态码: 500 参数不对导致业务失败或者服务端内部异常。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 phoneNo string True 查询的11位手机号码,或者带区号固话。
  • 报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 响应参数: { "result": [ { "isLoad": 1, "accessCode": "90500", "maxCallNum": null, "description": "异常处理", "id": 1, "flowFileName": "defaultIVR.GSL", "flowType": 1 }, { "isLoad": 1, "accessCode": "90501", "maxCallNum": null, "description": "1015", "id": 2, "flowFileName": "defaultIVR.GSL", "flowType": 1 } ], "retCode": "0", "message": "success"}
  • 响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 result array[object] False IVR信息 1.1.1 isLoad number False 流程是否加载 0:否 1:是 1.1.2 accessCode string False 流程接入码 1.1.3 maxCallNum integer False 流程最大并发呼叫数 1.1.4 description string False 流程描述 1.1.5 id number False 流程编号 1.1.6 flowFileName string False 流程文件名 1.1.7 flowType number False 流程类型 0:未明确的业务类型 1:GSL业务文件类型 2:VoiceXML业务文件类型 3:第三方IVR的业务类型 4:CCIVR支持的VXML流程 5:CCXMLL流程 6:WaitScript流程 1.2 retCode string False 返回码 0:成功 其他:失败 1.3 message string False 返回信息 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: {"caller": "88889050","called": "88889060", "agentWorkNo": "", "callData": "333333","callerPresent": "640003","agentPresent": "640060","callBackUrl": ""} 响应头: {"connection": "keep-alive","content-type": "application/json;charset=UTF-8"} 响应参数: {"retMsg": "Add CallOutInfo in DB successfully","retCode": "0"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 0:成功,其他为失败 1 :添加外呼任务失败,外呼数据库中可能已存在相同外呼任务 2 :呼叫数据信息 3 :未查询出呼叫流水号字段 5 :主被叫或外显号码格式不符 6 :VDN不可用 8 :主叫号码不在租户所分配的移动座席使用的软电话号码范围内 16 :试用租户的座席侧号码未在白名单内 21 :试用租户一键双呼超过每天10次限制 针对ITA双呼还有一些retCode,请参见表4 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo number False 呼叫流水号 表4 针对ITA双呼的retcode说明 retcode retMsg 说明 90100100 Invalid Input Parameter 请求报文不正确。如缺少参数或者不支持的参数 90100200 Auth Failed 请求的来源或者请求的签名未通过校验 90100300 Bad Request 错误请求 90100400 Not found 请求资源不存在 90100600 Internal Server Error 系统内部错误 90102001 Insufficient Balance 额度不足 90102002 Request Restriction 请求限制 90104001 Insufficient Permission 权限不足 90104003 Request Forbidden 请求被禁止 90104004 Service Unavailable 不支持的业务功能或者未实现 90104008 Service Process Failure 业务处理超时或者处理失败 90104029 Too Many Requests 请求过多 90106001 Binding relationship already exists 小号绑定关系已存在 90106002 Binding relationship not exists 小号绑定关系不存在 90106003 Insufficient Number resources 小号号码池资源不足 90106004 No corresponding number found 未找到可用小号 90106005 Inconsistent binding data 小号绑定数据不一致 90106006 Other Error 小号其他原因导致错误 90106010 Policy Forbid 策略禁止 90106011 Caller Forbid 主叫限制 90106012 Callee forbid 被叫限制 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string False 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 caller string True 主叫号码,客户经理手机号码,或是软电话号码 长度限制:string(32) 2 called string True 被叫号码 长度限制:string(32) 3 agentWorkNo decimal False 发起双呼的座席的工号。 长度限制:decimal(5) 4 callData string False 呼叫数据 长度限制:string(1024) 说明: ITA双呼不支持callData字段。 5 callerPresent string False 用户侧主叫显示号码,用户看到的主叫号码,不携带的情况下默认采用租间的接入码,携带的情况下该号码必须传接入码。如果需要传非接入码号码,请联系运维人员开通主叫透显特性,该特性开通后号码校验规则为:接入码或者11-14位的数字。 说明: ITA双呼不支持callerPresent字段。 6 agentPresent string False 座席侧主叫显示号码,客户经理看到的主叫号码,不携带的情况下默认采用租间的接入码,携带的情况下该号码必须传接入码。如果需要传非接入码号码,请联系运维人员开通主叫透显特性,该特性开通后号码校验规则为:接入码或者11-14位的数字。 说明: ITA双呼不支持agentPresent字段。 7 callBackUrl string False 此参数请采用BASE64编码进行加密。 此字段用于设置客户接收状态上报的挂机回调URL。 云客服CEC平台将业务触发过程中通话的状态信息推送至此服务器,客户服务器根据通话状态信息确定用户状态。 URL可填写为https://IP:Port或域名,推荐使用域名,支持http和https。http为不安全协议,请谨慎使用。且该域名对应多个服务器,避免单点故障无法接收通知。 URL只能由大小写字母(a-z、A-Z),数字(0-9), - : . / _ # ? &组成,不支持其它字符。
  • 响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 返回码,0成功,非0失败 1.2 description string False 返回描述 1.3 enabled boolean True 是否开启满意度调查。true:已开启,false:未开启。未开启时data为空。 1.4 data array[object] False 目前只返回一个数据。 1.4.1 ivrId string False IVR流程ID 1.4.2 feedbackType string False IVR:表示是IVR类型的流程,目前只有一个值。 1.4.3 channelType string False audio:音频 media:多媒体 目前取值只有audio 1.4.4 accessCode string False 流程接入码 响应状态码: 401 授权失败:1. 参数是否正确有效。 2. 请确认是否购买了相关服务。 3. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求路径可能不对。 响应状态码: 500 参数不对导致业务失败或者服务端内部异常。
  • 报文样例 请求头: X-APP-KEY: ****************************Authorization: Bearer ******************************* 响应参数: { "returnCode": "0", "data": [ { "accessCode": "6001", "channelType": "audio", "feedbackType": "IVR", "ivrId": "1239554736420597767" } ], "description": "success", "enabled": true}
  • 报文样例 请求头: x-app-key:9******************************3Authorization:Bearer e******************************eContent-Type:application/json 请求参数: {"startTime": "1562786332000","endTime": "1563391072000","taskType": "0","offset": 0,"limit": 10} 响应头: {"connection": "keep-alive","content-type": "application/json;charset=UTF-8"} 响应参数: {"result": {"total": 11,"callInfo": [{"releaseTime": 1621577022000,"called": "88889060","callerPresent": "640003","agentAlertingTime": 1621576992000,"agentPresent": "640060","talkingTime": 1621576995000,"alertingTime": 1621576994000,"caller": "88889050","agentTalkingTime": 1621576994000,"agentReleaseTime": 1621577022000,"agentTalkDuration": 27,"callSerialNo": "1037058396471308289","startTime": 1621576992000,"endTime": 1621577022000,"talkDuration": 26,"state": 3,"reasonCode": 1}]},"retCode": "0","retMsg": "Query call detail record successfully"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 body body False 请求体参数 表3 body参数结构 序号 名称 参数类型 是否必选 说明 1.1 endTime string True 结束时间,开始时间到结束时间不超过7天,时间戳,如1572794607000 1.2 offset string False 分页查询偏移量,默认值0,即不需要偏移 ,非必选 1.3 limit string False 分页查询时单页最多的记录条数,默认值100,即每页显示100条,非必选 1.4 startTime string True 起始时间,时间戳,如1572794607000 1.5 caller string False 主叫号码,可选,不填写默认查询所有 长度限制:string (32) 1.6 taskType string False 0:全部类型任务(除ITA双呼) 1:云客服双呼任务 2:查询匿名外呼任务 3:语音通知 4:ITA双呼
  • 响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 0 :成功,其他为失败 1 :未查询到数据 2 :起止时间格式不符 4: limit或offset分页数据格式不符 12: 主叫号码不可用 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 total number False 总记录数 1.3.2 callInfo array[object] False 记录列表 1.3.2.1 callSerialNo string False 呼叫序列号,唯一标识一次外呼呼叫 长度限制:string (50) 1.3.2.2 caller string False 主叫号码 长度限制:string (32) 1.3.2.3 called string False 被叫号码 长度限制:string (32) 1.3.2.4 startTime string False 外呼开始时间,时间戳,如1572794607000 1.3.2.5 endTime string False 通话结束时间,时间戳,如1572794607000 1.3.2.6 state number False 呼叫状态: 0:待呼叫 1:正在呼叫 2:通话中 3:通话结束 长度限制:number(1) 1.3.2.7 reasonCode number False 通话结束原因码: 0~65535, 0: 被叫挂机,通话结束 1:主叫挂机,通话结束 2:外呼主叫失败 3:外呼被叫失败 4:外呼主叫无应答 5:外呼被叫无应答 6:启动呼叫失败 xxx:其他异常 长度限制:number(5) 针对ITA双呼还有一些reasonCode,请参见表5 1.3.2.8 callData string False 第三方自定义的呼叫数据信息 长度限制:string(1024) 1.3.2.9 callerPresent string False 外显号码,来电显示的号码 长度限制:string(32) 1.3.2.10 alertingTime string False 客户振铃时间,时间戳,如1572794607000 1.3.2.11 talkingTime string False 客户通话时间,时间戳,如1572794607000 1.3.2.12 releaseTime string False 客户释放时间,时间戳,如1572794607000 1.3.2.13 talkDuration string False 用户通话时长(秒) 1.3.2.14 agentAlertingTime string False 座席振铃时间,时间戳,如1572794607000 1.3.2.15 agentTalkingTime string False 座席通话时间,时间戳,如1572794607000 1.3.2.16 agentReleaseTime string False 座席释放时间,时间戳,如1572794607000 1.3.2.17 agentTalkDuration string False 座席通话时长(秒) 1.3.2.18 taskType string False 0:全部类型任务(除ITA双呼) 1:云客服双呼任务 2:查询匿名外呼任务 3:语音通知 4:ITA双呼 1.3.2.19 agentPresent string False 外显号码,客户经理来电显示的号码 长度限制:string(32) 表5 针对ITA双呼的reasonCode说明 retCode 原因值描述 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 未指定的交互 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-key:9******************************3Authorization:Bearer 9******************************7Content-Type:application/json 请求参数: { "caller": 8888888,"softPhone": 66666666 "called": 6666614} 响应参数: {"retMsg": "Called is not configured","retCode": "5"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string False 0:成功,其他为失败 1 :添加外呼任务失败,外呼数据库中可能已存在相同外呼任务 2 :呼叫数据信息 3 :未查询出呼叫流水号字段 5 :主被叫或外显号码格式不符 6 :VDN不可用 8 :主叫号码不在租户所分配的移动座席使用的软电话号码范围内 16 :试用租户的座席侧号码未在白名单内 21 :试用租户一键双呼超过每天10次限制 针对ITA双呼还有一些retCode,请参见表4 1.2 retMsg string False 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo string False 呼叫序列号,唯一标识一次外呼呼叫 长度限制:string(50) 表4 针对ITA双呼的retcode说明 retcode retMsg 说明 90100100 Invalid Input Parameter 请求报文不正确。如缺少参数或者不支持的参数 90100200 Auth Failed 请求的来源或者请求的签名未通过校验 90100300 Bad Request 错误请求 90100400 Not found 请求资源不存在 90100600 Internal Server Error 系统内部错误 90102001 Insufficient Balance 额度不足 90102002 Request Restriction 请求限制 90104001 Insufficient Permission 权限不足 90104003 Request Forbidden 请求被禁止 90104004 Service Unavailable 不支持的业务功能或者未实现 90104008 Service Process Failure 业务处理超时或者处理失败 90104029 Too Many Requests 请求过多 90106001 Binding relationship already exists 小号绑定关系已存在 90106002 Binding relationship not exists 小号绑定关系不存在 90106003 Insufficient Number resources 小号号码池资源不足 90106004 No corresponding number found 未找到可用小号 90106005 Inconsistent binding data 小号绑定数据不一致 90106006 Other Error 小号其他原因导致错误 90106010 Policy Forbid 策略禁止 90106011 Caller Forbid 主叫限制 90106012 Callee forbid 被叫限制 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string False 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 caller string False 主叫号码,客户经理手机号码,或是软电话号码 长度限制:string(32) 1.2 softPhone string True 软电话号码(座席对应) 长度限制:string(32) 1.3 called string True 被叫号码 长度限制:string(32) 1.4 callData string False 呼叫数据 长度限制:string(1024) 说明: ITA双呼不支持callData字段。 1.5 callerPresent string False 用户侧主叫显示号码,用户看到的主叫号码,不携带的情况下默认采用租间的接入码,携带的情况下该号码必须传接入码。如果需要传非接入码号码,请联系运维人员开通主叫透显特性,该特性开通后号码校验规则为:接入码或者11-14位的数字。 说明: ITA双呼不支持callerPresent字段。
共100000条