华为云用户手册

  • outparams参数(outaction=10:对话拆线类操作) 注:一通会话结束,都要以IVR发起inaction=9/11且input=hangup的请求后,ODFS触发拆线响应,返回给IVR后为结束标记,IVR此后不再调用ODFS的接口。 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 call_sor_id String body True 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) call_dst_id String body True 接入标识 (1、语音导航场景传入被叫号码; 2、语音外呼问卷场景时为问卷类型id; 3、其他交互场景时传入接入标识)。 start_time String body True 对话交互开始时间 end_time String body True 对话交互结束时间。 release_reason String body False odfs流程走到结束图元是否是正常流程逻辑 0、正常业务逻辑进入结束图元; 1、流程遇到异常、超时等没有容错业务逻辑处理时走到结束图元。 region_id String body False(语音导航场景特有字段) 用户归属地。 entrance_id String body False(语音导航场景特有字段) 入口维度。 exit_id String body False(语音导航场景特有字段) 出口维度,取值同入口维度。 user_type_id String body False(语音导航场景特有字段) 用户类型。 suilu_region_id String body False(语音导航场景特有字段) 呼叫接入地。
  • inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 不超过64位 call_sor_id String body True 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) 不超过64位 call_dst_id String body M 接入标识 1、语音导航场景传入流程接入码; 2、语音外呼问卷场景时为流程接入码; 3、其他交互场景时传入接入标识。 不超过20位 real_callee String body False 实际接入IVR时的被叫号码,当语音导航场景下有效 不超过32位 cti_callid String body False(语音导航场景特有字段) 华为ivr传入的实际呼叫的CTI的callid,其他场景此值为空 不超过32位 auth_token String body True 授权信息,取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 suilu_region_id String body False(语音导航场景特有字段) 呼入地。 不超过64位 entrance_id String body False(语音导航场景特有字段) 导航入口。 01:广告语 02:欢迎语 03:首层主菜单 04:人工拦截 05:人工座席 06:直接通过短号接入 07:全语音门户 08:“0”号夜间导航模式 09:夜间全语音门户 10:直接通过自助短号接入 11:人工忙碌 98:其他 99:未识别 mediaType String body False 媒体类型(文本,音频,视频...) call_media_type String body False 呼入ivr的呼叫类型,文本:0 音频:1视频:3 channelType String body False 渠道类型 WEB(Web) INSTAGRAM(Instagram) TELEGRAM(Telegram) WECHAT(微信) FACEBOOK(Facebook) TWITTER(X (Twitter)) EMAIL(邮件) LINE WHATSAPP(WhatsApp) 5G(5G消息) SMS(短信)。 说明: 括号里为界面字段,区别于接口传参字段。 responseStyle String body False 回复风格
  • ExtParams参数 参数名称 数据类型 参数位置 必选/可选 描述 transin_data String body False 由接入方跟OIAP约定的随路数据参数,例如IVR传入的数据包参数 locationid String body O 呼叫录音节点号 mediaability String body False 媒体能力 1:音频 2:视频 3:音视频 ieValue String body False 接入方跟OIAP约定的User To User类型的随路数据参数,使用场景为:在与其他的平台对接时,如果呼叫是从其他的第三方的平台转移过来的呼叫,使用该参数携带SIP Header UUI信息。该参数的取值记录日志时会匿名化处理,保存数据库时会加密处理
  • 响应说明 响应状态码: 200 表4 RspBody参数结构 序号 名称 参数类型 说明 1.1 question string 相似问问题数组。 结果最多返回5条记录, 为智能在线助手平台根据关键词匹配的置信度最高的前5条记录。 1.2 resultCode string 响应返回码,0表示成功,非0表示失败 1.3 resultDesc string 响应返回描述 0:表示成功,不返回描述信息 1:request is no exsit 或 locale is error 或Robot is no exsit 或authToken is no exsit 或doNMSRequest is error或Exception appeared!。 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:根据客户输入联想常用语 请求头: ccmessaging-token: XXXXXXXXX 请求参数: { "strContent": "网格", "locale": "zh", "channel": "WEB" } 响应参数: { "question": [ "APP在哪里下载", "APP怎么登录?", "APP支持什么手机版本", "登录APP后,没有下单功能菜单权限", "PC端系统怎么登录" ], "resultCode": "0" }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口返回的token值。 会话过程中接口Response Header中返回的ccmessaging-token的值。 2 x-app-key string False appKey字段,用户标识,在API Fabric上配置 3 Authorization string False 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody ReqBody True 请求体 表3 ReqBody参数结构 序号 名称 参数类型 是否必选 说明 1.1 strContent string True 消息内容 1.2 locale string True 语种 请使用不带国家编码的语言,例如使用zh表示 中文,en表示英语等。请参见ISO 639语言编码获取详细信息。 1.3 channel string True 渠道类型,当前固定为WEB(表示WEB渠道接入)
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ccId":1 } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": { "licenseMaxAgentNum": 4, "licenseMaxVideoAgentNum": 4294967295, "licenseMaxVdnNum": 10, "licenseMaxIvrCallNum": 4, "licenseMaxVoiceCallNum": 6, "licenseMaxWebCallNum": 4294967295, "loginAgentNum": 1, "loginVideoAgentNum": 4294967295, "vdnNum": 1, "ivrCallNum": 0, "voiceCallNum": 1, "webCallNum": 4294967295, "historyMaxAgentNum": 4294967295, "historyMaxVideoAgentNum": 4294967295, "historyMaxIvrCallNum": 4294967295, "historyMaxVoiceCallNum": 4294967295, "historyMaxWebCallNum": 4294967295, "licenseStartDate": 0, "licenseEndDate": 0 }, "resultDesc": { "licenseMaxAgentNum": 4, "licenseMaxVideoAgentNum": 4294967295, "licenseMaxVdnNum": 10, "licenseMaxIvrCallNum": 4, "licenseMaxVoiceCallNum": 6, "licenseMaxWebCallNum": 4294967295, "loginAgentNum": 1, "loginVideoAgentNum": 4294967295, "vdnNum": 1, "ivrCallNum": 0, "voiceCallNum": 1, "webCallNum": 4294967295, "historyMaxAgentNum": 4294967295, "historyMaxVideoAgentNum": 4294967295, "historyMaxIvrCallNum": 4294967295, "historyMaxVoiceCallNum": 4294967295, "historyMaxWebCallNum": 4294967295, "licenseStartDate": 0, "licenseEndDate": 0 } }
  • 请求URL https://ip:port/rest/cmsapp/v1/openapi/configures/querysystemlicensestatus 其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。 非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围:1~65535。
  • 响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 3 resultDatas object 查询成功后,返回结果信息的对象。 该数组中对象的参数说明请参见表4。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc object 查询成功后,返回结果信息的对象。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 licenseMaxAgentNum long License支持的最大签入座席数 2.2 licenseMaxVideoAgentNum long License支持的最大签入视频座席数 2.3 licenseMaxVdnNum long License支持的最大VDN个数 2.4 licenseMaxIvrCallNum long License支持的最大自动业务呼叫数 2.5 licenseMaxVoiceCallNum long License支持的最大语音呼叫数 2.6 licenseMaxWebCallNum long License支持的最大Web呼叫数 2.7 loginAgentNum long 当前签入座席数 2.8 loginVideoAgentNum long 当前签入视频座席数 2.9 vdnNum long 当前配置的VDN个数 2.10 ivrCallNum long 当前自动业务呼叫数 2.11 voiceCallNum long 当前语音呼叫数 2.12 webCallNum long 当前Web呼叫数 2.13 historyMaxAgentNum long 历史最大签入座席数 2.14 historyMaxVideoAgentNum long 历史最大签入视频座席数 2.15 historyMaxIvrCallNum long 历史最大自动业务呼叫数 2.16 historyMaxVoiceCallNum long 历史最大语音呼叫数 2.17 historyMaxWebCallNum long 历史最大Web呼叫数 2.18 licenseStartDate long License开始时间 2.19 licenseEndDate long License结束时间
  • 错误结果码 表14 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200002 外呼活动的开始时间早于今天凌晨。 3 0200005 外呼活动名称不能重复。 4 0200007 外呼活动已经不存在。 5 0200016 外呼活动已经结束。 6 0200017 技能队列ID不存在。 7 02000001 参数值为空 8 02000002 参数包含非法字符 9 02000003 参数长度不能大于规定长度 10 02000004 参数长度不能小于规定长度 11 02000005 参数长度需要介于规定长度之间 12 02000006 参数值类型不正确 13 02000007 参数值大小不正确 14 02000008 参数转换异常,请检查请求参数 15 02000009 参数组合不正确,请检查请求参数 16 02000010 hour和minute必须同时存在 17 02000011 参数个数不能大于规定个数
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 campaignId int True 外呼任务的ID。
  • 报文样例 该接口的请求消息体举例如下: { "name": "十一流量包推荐", "description": "十一流量包推荐", "strBeginTime": "2020-09-10 00:00:00", "strEndTime": "2020-10-07 23:59:59", "deviceType": 2, "callerNo": "10085", "maxAlertingTime": 20, "scheduleParam": { "workdayBeginTime1": "08:00", "workdayEndTime1": "11:30", "workdayBeginTime2": "13:00", "workdayEndTime2": "17:30", "workdayBeginTime3": "", "workdayEndTime3": "", "holidayBeginTime1": "10:00", "holidayEndTime1": "11:00", "holidayBeginTime2": "13:00", "holidayEndTime2": "17:30", "holidayBeginTime3": "", "holidayEndTime3": "" }, "skillParam": { "skillId": 5, "skillName": "Voice Skill Queue", "outBoundType": 2, "predictParam": { "predictMethod": 5, "offhookPredictParam": { "offHookRate": 100 } } }, "callBackUrl": "https://10.10.10.10/xxx/xxx/xxx" } 该接口的响应消息体举例如下: { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "" }
  • 响应消息 该接口的响应消息体举例如下: { "returnCode": "0200000", "data": { "callId": "1644464743-1388", "called": "88881955", "callEndTime": "2022-02-10 11:45:51", "vdnId": 8, "callStatus": "6", "failCode": "00000", "resultCode": "OB99999", "callBeginTime": "2022-02-10 11:45:47", "recordPath": "https://south-aicc-develop.obs.cn-south- 1.myhuaweicloud.com:443/isales/record/A68CA32800B9684811D698D1B61C1A0661511E7AD042DEE5304254DDB9DCED00/ec96a62d-f56c-4f4e-8f5e-30e7a29f38e5?AccessKeyId=ERUDBXB5GOMYURMPLKBO&Expires=1644484560&Signature=uztQO%2FxI8GOSW2GZJWCBCm8AyAg%3D", "ackBeginTime": "2022-02-10 11:45:43" }, "resultCode": "0200000", "resultDesc": "Query Success!", "returnDesc": "Query Success!" } 该接口的响应消息体参数说明如表2 响应体参数说明所示。 表3 响应体参数说明 参数名 数据类型 说明 resultCode String 原因码。0200000表示成功,其他表示失败。 resultDesc String 描述。 returnCode String 原因码。0200000表示成功,其他表示失败。 returnDesc String 描述。 data JSONObject 结果json,详见表4 表4 data参数说明 参数名称 数据类型 描述 called String 被叫号码 ackBeginTime String 外呼开始时间,即振铃开始时间,格式为:yyyy-mm-dd hh:mm:ss callBeginTime String 通话开始时间,即接通开始时间,格式为:yyyy-mm-dd hh:mm:ss callEndTime String 通话结束时间,即挂机时间,格式为:yyyy-mm-dd hh:mm:ss callStatus int 呼叫结果(5: 呼叫失败,6: 呼叫成功) failCode String 失败的原因码。 resultCode String 失败的原因码对应的外显结果码。外显结果码可以自定义,失败原因码与外显结果码相互关联。 vdnId int 外呼号码所属VDN ID。 callId String 通话记录ID,用于与CTI平台的话单等通话数据关联。 recordPath String 通话录音文件OBS的URL路径。 说明: 该字段仅在使用接续时(SAAS组网),才返回值,其他情况返回为空。 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200007 通话记录ID不存在。 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常,请检查请求参数 11 02000009 参数组合不正确,请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数
  • 报文样例 请求消息样例 { "tenantId":"202104237142", "language":"zh_CN", "pageNum":1, "pageSize":20, "authToken": "t*********************", "domainInfo":{ "domainName":"机器人", "domainId": "10149" } } 响应消息样例 { "errorMsg": "", "errorCode": 0, "intentions": [ { "intentName": "移车地址", "intentDesc": " ", "intentCmd": "移车地址" }, { "intentName": "社保业务", "intentDesc": " ", "intentCmd": "社保业务" }, { "intentName": "移车业务", "intentDesc": "移车业务", "intentCmd": "移车" }, { "intentName": "公积金问题", "intentDesc": " ", "intentCmd": "公积金问题" }, { "intentName": "是否", "intentDesc": " ", "intentCmd": "是否" }, { "intentName": "公积金业务", "intentDesc": " ", "intentCmd": "公积金" } ], "total": 6 }
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID language String body True 语言 en_US:英文 zh_CN:中文 pt_BR:葡萄牙语 th_TH:泰语 fr_FR:法语 ar:阿拉伯语 pageNum int body True 页码 分页查询,查询第几页,首页为1 pageSize int body True 每页多少条 支持每页 5、10、20、50、100条 domainInfo DomainInfo body 配置项oifde.slient.use = ipcc 时True,反之False 领域信息 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。 表2 DomainInfo 参数名称 数据类型 参数位置 必选/可选 描述 domainName String body False 领域名称 domainId int body True 领域ID language String body False 语言 tenantId String body False 租户ID
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackfile/queryDataImportTask 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 报文样例 该接口的请求消息体举例如下: { "limit":10, "offset":0, "importTaskIds":["164698362894300182038011895728"] } 该接口的响应消息体举例如下: { "result": [ { "succNum": 0, "failNum": 0, "errMsg": "", "id": "164698362894300182038011895728", "beginTime": "2022-03-11T07:27:09.000+00:00", "endTime": "2022-03-11T07:27:09.000+00:00", "repeatNum": 0, "status": "2" } ], "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success" }
  • 请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 offset int True offset用于确定查询的起始页。 offset取值为:offset=limit*(page-1) page为需要查询的起始页。 2 limit int True 表示每页的查询数量。 取值范围:1~100
  • 错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200006 参数包含非法字符 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常,请检查请求参数 11 02000009 参数组合不正确,请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数
  • 响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 1 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 skillId int 技能队列编号 2.2 maxCallNum int 最大排队呼叫数目 2.3 maxHoldCallNum int 最大保持数目 2.4 maxWaitTime long 最大等待时长(s) 2.5 maxAnswerWaitTime long 最大不应答时长(s) 2.6 maxTalkTime long 最大通话时长(s) 2.7 maxRestAgentNum int 最大允许休息人数 2.8 maxAgentWrapupTime int 最大座席整理态时长(s)
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围:1~65535。 2 vdn int True 虚拟呼叫中心编号。 取值范围:1~5000。 3 skillIds array True 技能队列ID信息的对象数组。 数组长度不大于1000。 取值范围:1~2000。
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ccId":1, "vdn":170, "skillIds":[1,2] } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "skillId": 1, "maxHoldCallNum": 5, "maxTalkTime": 86400, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "maxRestAgentNum": 2, "maxCallNum": 100, "maxAnswerWaitTime": 30 }, { "skillId": 2, "maxHoldCallNum": 5, "maxTalkTime": 86400, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "maxRestAgentNum": 2, "maxCallNum": 100, "maxAnswerWaitTime": 30 } ], "resultDesc": [ { "skillId": 1, "maxHoldCallNum": 5, "maxTalkTime": 86400, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "maxRestAgentNum": 2, "maxCallNum": 100, "maxAnswerWaitTime": 30 }, { "skillId": 2, "maxHoldCallNum": 5, "maxTalkTime": 86400, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "maxRestAgentNum": 2, "maxCallNum": 100, "maxAnswerWaitTime": 30 } ] }
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "dnids": "1,2" } 响应参数: { "returnCode": "0", "data": { "name": "9911411,99114111", "id": "1127983948544239618,1127986019188238339", "content": "9911411,99114111" }, "description": "data delete success" }
  • 请求说明 表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
  • 响应说明 响应状态码: 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 表4 RspMsg200参数结构 序号 名称 参数类型 说明 1.1 position integer 本呼叫在队列中的位置 1.2 totalWaitTime integer 本呼叫累计排队时长(秒) 1.3 currentDeviceWaitTime integer 当前技能队列的实际等待时长(秒) 1.4 configMaxcWaitTime integer 配置的最大等待时长(秒) 1.5 longestWaitTime integer 队列中正在排队呼叫的最大排队时长(秒) 1.6 estimateWaitTime integer 对应队列的预估呼叫等待时长(秒) 1.7 resultCode string 查询排队信息返回码。具体错误码信息如下: 0:正在排队,查询成功。 1:参数错误。 2:CCUCS请求失败。 3:Token错误。 4:未知错误。 5:会话已结束。 6:CCUCS会话已失效。 160001:CCUCS通信失败。 160004:会话不存在或已结束。 160021:当前会话已经转到座席,不在排队状态。 160022:当前会话已转移到IVR,不在排队状态。 160023:当前会话已转移到私有队列,不在排队状态。 160024:座席未应答。 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:查询排队信息 请求头: ccmessaging-token: xxxx x-app-key: xxxx Authorization: Bearer xxxx Content-Type: application/json 请求参数: { "userId": "xxxx", "channelConfigId": "xxxxx", "channel": "WEB" } 响应参数: { "totalWaitTime": 3, "resultCode": "0", "longestWaitTime": 3, "position": 1, "currentDeviceWaitTime": 3, "configMaxcWaitTime": 60, "estimateWaitTime": 60 }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string False applyToken接口返回的token值。 会话过程中接口Response Header中返回的ccmessaging-token的值。 2 x-app-key string False appKey字段,用户标识,在API Fabric上配置 3 Authorization string False 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody ReqBody True 请求体 表3 ReqBody参数结构 序号 名称 参数类型 是否必选 说明 1.1 userId string True 客户的唯一标识。取值范围:1到32位字符串。 1.2 channelConfigId string True 渠道配置id 1.3 channel string True 渠道类型
  • 接口URI https://ip:port/CCFS/resource/ccfs/ivr/uploadFile?vdnId={vdnId} 其中,ip为CC-FS安装的服务器IP地址,port为CC-FS的HTTPS端口号。 如果经过NSLB路由,ip为NSLB的服务器IP地址,port为CC-FS服务在NSLB映射的HTTPS端口号。 表1 URL中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心 id。
共100000条