华为云用户手册

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 sessionId String False 标识用户的ID，外呼结果中会回传用户。 最大长度为32个字符。 2 called String False 被叫号码。 最大长度为24个字符，有效字符为：0~9、*、#。 3 customField String False 用户自定义字段，删除时可根据该字段批量删除，最大长度为200个字符。 4 recycleTime String False 回收时间，格式为yyyy-mm-dd hh:mm:ss。 5 recycleType String False 回收类型。只在传入recycleTime的同时传入，该参数有效。 取值范围： 1：删除早于传入的recycleTime（精确到天）的外呼号码。 例如，传入2020-12-04 17:57:00，会将指定外呼活动下，recycleTime在12月4日及以前的外呼号码都删除 2：删除传入的recycleTime当天的外呼号码。 例如，传入2020-12-04 17:57:00，会删除指定外呼活动下，recycleTime在2020-12-04 00:00:00到2020-12-04 23:59:59之间的外呼号码 3：删除与传入的recycleTime相等的外呼号码。 6 archiveHistory int False 是否移历史表。 取值范围：0，1。 0：不移历史表，直接删除。1：移入历史表。默认为0。

报文样例 请求头： x-app-key:9******************************3 Authorization:Bearer 9******************************7 请求参数: { "callId": "1652317325-339", "userId": "1652268429538866153", "tenantId": "202205116084" } 响应参数: { "callSerialno": "1243353389979684865", "countId": "1652268429538866153", "callId": "1652317325-339", "mediaAbility": 1, "channelType": 1, "talkReason": "1300404704098042886，1300404506395329541", "beginTime": "2022-05-12 01:01:33", "callType": 1 }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId string True 呼叫id 2 userId string True 用户id 3 tenantId string True 租户id

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 callSerialno string False 呼叫流水号 2 countId string False 账号 3 callId string False 呼叫ID 4 mediaAbility number False 媒体类别：1: 语音 2:视频 5 channelType number False 多媒体渠道 6 talkReason string False 会话原因ID 7 beginTime timestamp False 开始时间 8 callType number False 呼叫类型 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 查询参数 序号 名称 参数类型 是否必选 说明 1 channel string True 接收者渠道类型（WEB） 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口生成的ccmessagign-token 2 x-app-key string True appKey字段，用户标识，在API Fabric上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 webRTCSupported boolean WebRTC是否支持 1.2 clickToCallSupported boolean 点击通话是否支持 1.3 resultCode string 响应结果码 1.4 resultDesc string 响应结果描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：检查是否支持点击通话 URL：https://域名/apiaccess/ccmessaging/v1/checkClickToCallSupport 请求头： ccmessaging-token: XXXXXXXXX x-app-key: XXXXXXXXX Authorization: XXXXXXXXX 请求参数： { "channel": "WEB" } 响应参数： { "resultCode": "0", "resultDesc": "", "webRTCSupported": true, "clickToCallSupported": true }

响应消息样例1 { "userid": "1528780879-9581"， "outaction": 9， "outparams": { "call_id": "1528780879-9581"， "prompt_type": "1"， "prompt_wav": "welcome"， "prompt_text": "查询话费"， "language": "0"， "inter_idx": "1"， "model_type":"1011201" "timeout": "10"， "tone": ""， "grammar": ""， "question_id": "Q1"， "question_name": "问题1"， "answer_id": "Y" } }

响应消息样例 { "outaction": 12， "outparams": { "call_id": "1528780879-9581"， "prompt_type": "1"， "inter_idx": "1"， "moduleName":"查询"， "xxx":"xxx" //扩展 } }

请求消息样例 { "userid": "1528780879-9581"， "inaction": 9， "inparams": { "call_id": "1528780879-9581"， "call_dst_id": "10086"， "flow_result_type":"1"， "input":"帮我查一下我的话费"， "inter_idx": "1"， "begin_play": "2018090407:16:24"， "end_play": "2018090407:16:30"， "result_time":"2018090407:16:3"， "inter_no":"0" }， "extparams": { "transin_data":"95，22714，0，，1，1，，test_gdj_01005"， "queueIndex":"2"， "agentCount":"5"， "estimateTime":"10"， "idleAgentCount":"1" } } ODFS判断如果 flow_result_type = 1 且 input = (识别结果id值) 时会调用Redis获取转写文本（key=识别结果id值中redis值编号key），获取到的识别文本格式为字符串（非JSON格式）。 Lua脚本获取Redis结果示例代码如下，示例中代码key值为“msg”字符串。

响应消息样例3 { "userid": "1528780879-9581"， "outaction": 10， "outparams": { "call_id": "1528780879-9581"， "call_sor_id": "13500000001"， "call_dst_id": "10086"， "start_time": "2018090407:16:24"， "end_time": "2018090407:30:24"， "release_reason": "0"， "region_id": "025"， "entrance_id": "03"， "exit_id": "05"， "user_type_id": "01"， "suilu_region_id":"025" } }

响应消息样例2 { "userid": "1528780879-9581"， "outaction": 11， "outparams": { "call_id": "1528780879-9581"， "call_sor_id": "13500000001"， "calling_num":"1234567890"， "trans_type": "1"， "route_value": "123456789"， "inter_idx": "1"， "trans_idx": "1"， "question_id": "Q1"， "question_name": "问题1"， "answer_id": "Y" } }

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志，与userid 取值相同，给流程使用。 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入被叫号码； 2、语音外呼问卷场景时为问卷类型id； 3、其他交互场景时传入接入标识。 不超过20位 flow_result_type String body True 结果类型。 1：语音识别输入或者文字输入 2：语音按键输入 3：正常无输入(只播放) 4：录音结束 -1：其他 input String body True 对话交互结果。 语音识别结果或者文字输入：语音识别结果为id值，格式为redis值编号key+@+inter_no；文字输入结果则直接为文字内容 语音按键结果：按键值，如"1"，"201801"等 playover：放音结束 timeout：超时 nomatch：识别或按键失败 sys_err：系统异常 hangup：挂机 recordend：录音结束 当结果为hangup时，可触发ODFS的拆线响应。 不超过1024位 auth_token String body True 授权信息，取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 recordFileName String body False(支持全流程录音的语音导航场景特有字段) 全流程录音的路径文件名，例如：Y:/record/1/20200421/xxxxxx.wav inter_idx String body False(语音导航场景特有字段) 交互次数，直接取上一次ODFS返回的inter_idx值即可。 begin_play String body False(语音导航场景特有字段) 放音开始时间 end_play String body False(语音导航场景特有字段) 放音结束时间 result_time String body False(语音导航场景特有字段) 结果产生的时间 inter_no String body False(语音导航场景特有字段) 识别标识 IACmd String body False(语音导航场景特有字段) 智能匹配和智能工单填写专用字段 智能匹配时，只支持值为match 智能工单时，可取值如下： match：请求填单 rematch：当识别的事项分类错误时，重新识别 confirm：当座席点选某字段时，告知odfs该字段已确认 TextSource String body False(语音导航场景特有字段) 当IACmd为match时，用于区分输入文本来自座席还是用户（智能匹配、智能工单相同），值为staff或customer staff：座席 customer：用户 当IACmd为confirm时，传入座席点选的字段名，如：对象二级 当IACmd为rematch时，可不填 feedback int body False 反馈的满意度: 1(满意)；0(不满意) feedbackContent String body False 反馈的不满意原因(如果反馈为满意则为空) mediaType String body False 媒体类型（文本，音频，视频... 例如：audio，video...） 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（短信）。 说明： 括号里为界面字段，区别于接口传参字段。 refeedbackContentcordFileName String body False 录音文件名

ExtParams参数 参数名称 数据类型 参数位置 必选/可选 描述 transin_data String body False 由接入方跟OIAP约定的随路数据参数，例如IVR传入的数据包参数 release_reason String body False(语音导航场景特有字段) ivr上报给odfs呼叫拆线的原因码： 0、业务流程正常拆线； 1、系统异常拆线； 2、用户拆线； queueIndex String body False(查询排队信息场景特有) 查询技能队列的排队位置 agentCount String body False(查询排队信息场景特有) 查询技能队列的在线座席数 estimateTime String body False(查询排队信息场景特有) 查询技能队列的预计等待时间 idleAgentCount String body False(查询排队信息场景特有) 查询技能队列的空闲座席数

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":1, "callId":"1453723531-574" } 响应消参数： { "result": "0", "resultCode": "0100000", "resultDatas": { "time": 1606115215000, "dsn": 0, "handle": 0, "server": 0, "keyId": "", "callingNum": "88881364", "calledNum": "650550", "mid": 5, "trunkNo": 582, "priority": 0, "deviceType": 2, "deviceNo": 1177, "callSkill": "defaultAudioSkill", "partyNum": 1, "callFeature": 0, "orgiCalledNum": "", "mediaType": 5, "place": 0, "waitTime": 0, "totalTalkingTimes": 275, "logonTimes": 284, "serviceType": 2, "callInCause": 65535, "enterReason": 0, "mediaBillType":0 }, "resultDesc": { "time": 1606115215000, "dsn": 0, "handle": 0, "server": 0, "keyId": "", "callingNum": "88881364", "calledNum": "650550", "mid": 5, "trunkNo": 582, "priority": 0, "deviceType": 2, "deviceNo": 1177, "callSkill": "defaultAudioSkill", "partyNum": 1, "callFeature": 0, "orgiCalledNum": "", "mediaType": 5, "place": 0, "waitTime": 0, "totalTalkingTimes": 275, "logonTimes": 284, "serviceType": 2, "callInCause": 65535, "enterReason": 0, "mediaBillType":0 } }

响应消息 表3 消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDatas Object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc Object 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4 表4 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 time Date 呼叫进入平台的时间。单位为毫秒。 dsn int 标识呼叫的任务号。 handle int 呼叫任务的控制块被循环使用的次数。 server int 处理呼叫的媒体服务器的标识。 keyId string 呼叫的唯一标识 callingNum string 主叫号码 calledNum string 被叫号码 mid int UAP模块号 trunkNo int 中继号 priority int 用户级别 deviceType int 正在处理的设备类型，请参见表1 deviceNo int 正在处理的设备编号。 对于业务代表设备来说，设备号即为业务代表工号。 对于队列或虚设备，设备号即为在配置台上配置的队列ID号或虚设备对应的网络共享设备ID号 对于其他设备类型，均为内部标识号 callSkill int 技能队列描述 partyNum int 呼叫轨迹经过的设备数目 callFeature int 呼叫特征，请参见表1 orgiCalledNum int 原始被叫 呼叫在进入系统前被叫发生变化，则该参数记录的是首次被呼叫方的号码。 mediaType int 媒体类型，请参见表1 place int 用户所在的位置（呼叫进入的地点） waitTime long 排队等待时间 totalTalkingTimes long 通话时长 logonTimes long 进入总时长 serviceType int 业务类型 callInCause int 呼入原因 enterReason int 进入本设备的原因，请参见表1 mediaBillType string 多媒体报表类型。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 消息体参数说明 参数名 数据类型 是否必选 说明 ccId int True 呼叫中心编号。取值范围：1～65535 vdn int True 虚拟呼叫中心编号。取值范围：1～5000 callId string True 呼叫callId，最大长度20。 参数值为时间戳-呼叫编号，其中时间戳为呼叫开始时间，必须为毫秒级时间戳。 例如：1659513159000-546750

错误结果码 表23 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200002 外呼活动的开始时间早于今天凌晨。 3 0200003 设备类型为技能队列的外呼活动已达到上限，如果需要继续新增，则先删除其他设备类型为技能队列的外呼活动。 4 0200004 设备类型为IVR的外呼活动已达到上限，如果需要继续新增，则先删除其他设备类型为IVR的外呼活动。 5 0200005 外呼活动名称不能重复。 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 参数个数不能大于规定个数

报文样例 该接口的请求消息体举例如下： { "name": "test0827shwocase1", "description": "long0825", "strBeginTime": "2021-08-27 00:00:00", "strEndTime": "2021-08-28 23:59:59", "deviceType": 2, "callerNo": [ { "accessCode": "88889527", "priority": 3 }, { "accessCode": "88880066", "priority": 4 } ], "maxAlertingTime": 20, "priority": 4, "scheduleParam": { "workdayBeginTime1": "00:00", "workdayEndTime1": "23:59", "workdayBeginTime2": "", "workdayEndTime2": "", "workdayBeginTime3": "", "workdayEndTime3": "", "holidayBeginTime1": "10:00", "holidayEndTime1": "11:00", "holidayBeginTime2": "13:00", "holidayEndTime2": "17:30", "holidayBeginTime3": "", "holidayEndTime3": "" }, "skillParam": { "skillId": 2, "skillName": "defaultAudioSkill", "outBoundType": 2, "predictParam": { "predictMethod": 1, "expPredictParam": { "maxAvgCallTime": 100, "minAvgCallTime": 50, "outBoundRate": 50 } } }, "retryPolicy": { "policyType": 1, "policyJson": "[{'dataType':'SI','type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':600}]}]" }, "callPolicy": { "callType": 1, "chooseType": 0, "turns": [ { "turnType": "SI" } ] }, "initStatus": 0, "callBackUrl": "https://10.10.10.10/xxx/xxx/xxx" } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "id": 46 } }

响应说明 表21 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表23。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表23。 4 returnDesc String 描述。 5 returnObject Object 参见表22。 表22 returnObject参数说明 序号 参数名 参数类型 说明 5.1 id int 外呼活动id。

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 响应消息描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败，具体见“错误结果码”章节 3 result object 结果内容对象。该对象参数说明请参见表4。 表4 result参数说明 序号 名称 参数类型 说明 3.1 guid string 每个配置用户登录后获得唯一的Guid标识

报文样例 消息头 Content-Type:application/json; charset=UTF-8 请求参数 { "agentId": 101, "password": "******" } 响应参数 { "result": { "guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1" }, "message": "success", "retcode": "0" }

请求说明 消息头 表1 消息头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 消息体 表2 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 agentId number True 1.配置管理员登录时为座席工号。 取值的类型为整数，取值范围为1～59999。 2.VDN账号登录时为(VDN编号 + 100000)组成的数字 2 password string True 1.配置管理员登录时为工号对应的密码 2.VDN账号登录时为VDN对接密码

响应说明 响应状态码: 200 表3 pollRsp参数结构 序号 名称 参数类型 说明 1.1 resultDesc string 返回结果描述 成功时返回“query user messages success”，失败时无返回。 1.2 downlinkMessages downLIinkMsgArr 发送给用户的消息数组 1.3 resultCode string 客户端接收消息结果码，0表示成功，非0表示失败 表4 downLIinkMsgArr参数结构 序号 名称 参数类型 说明 1.1 channel string 消息渠道类型，当前固定为WEB，表示WEB渠道接入。 1.2 content string 发送给客户下行消息内容，最多500个字符。 根据mediaType不同，content有不同的格式。 如果是多媒体库文件，为多媒体库文件ID； 如果是本地文件，为obskey。 1.3 from string 消息发送方的id，一般为AICC侧渠道的“配置ID”。 1.4 mediaType string 消息媒体类型，如文本类型（TEXT）、图片（IMAGE）、视频（VIDEO）、语音（AUDIO）、位置（LOCATE）、文档（DOCUMENT） 1.5 senderNickname string 座席侧或机器人开启时配置的昵称。如果是系统消息，则返回“系统”（中文租间）或“system”（英文租间）。 1.6 sourceType string 消息发送方来源，如人工座席（AGENT）、机器人（ROBOT）、系统（SYSTEM） 1.7 timestamp string 消息发送时间戳 1.8 to string 消息接收方id，通常为企业侧客户端发送的userId。 1.9 simQuestions string 相似问内容 1.10 isOfflineStatus boolean 用于客户端判断下一步是否可以发送消息。 1.11 messageCode string 消息唯一编码，用来识别撤销或删除动作操作的消息 1.12 interIdx string 交互次数，直接取上一次ODFS返回的inter_idx值即可 1.13 contentType string 如果是多媒体库文件，返回值为null； 如果是本地文件，为"1"。 1.14 mediaFileType string 多媒体文件类型。支持jpg，png，bpm，mp3，aac，mp4，txt，csv，richtext，doc，docx，pdf，zip。 1.15 controlType string 如聊天(CHAT)，断开连接(DISCONNECT)，READ（已读） 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：主动轮询座席侧发送给用户侧的消息 URL：Domain Address/apiaccess/ccmessaging/poll?receiverId=XXXXXXXXXXXXXXXXXXXXXXXX&channel=WEB 请求头: ccmessaging-token： XXXXXXXXX 响应参数: { "resultCode": "0", "resultDesc": "query user messages success.", "downlinkMessages": [{ "from": "1011577355744904195", "channel": "WEB", "to": "session_fixed_user_fixed", "controlType": "CHAT", "mediaType": "TEXT", "content": "欢迎欢迎，热列欢迎", "simQuestions": null, "senderNickname": "test", "senderAvatar": "1", "timestamp": 1619590480756, "sourceType": "ROBOT", "callId": null, "robotGender": "MALE" }, { "from": "1011577355744904195", "channel": "WEB", "to": "session_fixed_user_fixed", "controlType": "CHAT", "mediaType": "TEXT", "content": "转人工", "simQuestions": null, "senderNickname": "test", "senderAvatar": "1", "timestamp": 1619590482098, "sourceType": "ROBOT", "callId": null, "robotGender": "MALE" }, { "from": "1011577355744904195", "channel": "WEB", "to": "session_fixed_user_fixed", "controlType": "CHAT", "mediaType": "TEXT", "content": "已接通座席。", "simQuestions": null, "senderNickname": "系统", "senderAvatar": null, "timestamp": 1619590484115, "sourceType": "SYSTEM", "callId": null, "robotGender": null }] } 多媒体库文件场景下： { "downlinkMessages": [ { "callId": null, "simQuestions": null, "senderNickname": "agent", "handlerType": null, "isOfflineStatus": null, "channel": "WEB", "senderAvatar": "", "robotGender": null, "mediaType": "IMAGE", "associationContentId": null, "content": "1179725658739559425", "receiveTime": null, "controlType": "CHAT", "sourceType": "AGENT", "queueFlag": null, "messageCode": "1e1f2bf7-fd6e-4471-a45d-2b43d1eb6272", "from": "202201077401331370", "to": "1642643982282972758", "mediaFileType": "png", "contentType": null, "interIdx": null, "timestamp": 1648102235191 } ], "resultCode": "0", "resultDesc": "query user messages success." } 发送本地文件场景下： { "downlinkMessages": [ { "callId": null, "simQuestions": null, "senderNickname": "agent", "handlerType": null, "isOfflineStatus": null, "channel": "WEB", "senderAvatar": "", "robotGender": null, "mediaType": "IMAGE", "associationContentId": null, "content": "878e7d9a-8e2f-4893-8b54-352f8ecbf86c", "receiveTime": null, "controlType": "CHAT", "sourceType": "AGENT", "queueFlag": null, "messageCode": "9374d9c4-b8ee-4035-aab9-ad5ceddbb856", "from": "202201077401331370", "to": "1642643982282972758", "mediaFileType": "png", "contentType": "1", "interIdx": null, "timestamp": 1648102054235 } ], "resultCode": "0", "resultDesc": "query user messages success." }

请求说明 表1 查询参数 序号 名称 参数类型 是否必选 说明 1 receiverId string True 接收者Id，即applyToken里面的userId。 2 channel string True 接收者渠道类型，缺省值为WEB，且必须为WEB。 3 isNeedRead string False 是否需要READ座席已读用户消息的提示消息，true为需要，其余或者为空不需要该消息 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口返回的token值。 会话过程中接口Response Header中返回的ccmessaging-token的值。 2 x-app-key string True appKey字段，用户标识，在API Fabric上配置 3 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 totalCount int OBS外呼服务器的结果码的总数 4 obsCodes LIST 外呼结果码集合 5 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 6 returnDesc String 描述。 表4 obsCodes 序号 参数名 参数类型 说明 1 obsCodeDesc String OBS外呼结果码描述 2 obsCode String OBS外呼结果码。

报文样例 该接口的响应消息体举例如下： { "obsCodes": [ { "obsCodeDesc": "The switch is busy.", "obsCode": "00605" }, { "obsCodeDesc": "The call is rejected.", "obsCode": "00604" }, { "obsCodeDesc": "The called party does not answer the call.", "obsCode": "00603" }, { "obsCodeDesc": "No resource available on the ACD.", "obsCode": "00602" }, { "obsCodeDesc": "The ACD times out.", "obsCode": "00606" } ], "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "query queryOBSResultCode Success!", "totalCount": 120, "returnDesc": "query queryOBSResultCode Success!" }

错误结果码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常，请检查请求参数 10 02000009 参数组合不正确，请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/queryOBSResultCode?pageSize={pageSize}&pageNum={pageNum} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 pageNum int True 页码，取值大于0 3 pageSize int True 表示每页的查询数量。 取值范围：1～50