华为云用户手册

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/retryPolicy/{campaignId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId int True 外呼活动ID

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 ret int body True 执行结果 0：成功 非0表示失败 userid String body True ODFS根据在userid内部建立呼叫实例，同一时间ODFS内部可能有多个呼叫实例，后继的交互根据userid将同一通电话关联起来。 outaction int body True 接下来接入方需要执行什么类型的操作 9：对话交互类操作 11：对话转接类操作 10：拆线操作 12：查询类操作 7：对话开启抓包录制请求 13：请求识别结果 outparams Object body True 用于知会接入方完成操作需要的详细信息，请根据具体的场景查看参数介绍。 表1 outparams参数（outaction=9：对话交互类操作） 表4 表3 表2 表2

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 userid String body True ODFS根据在Userid内部建立呼叫实例，同一时间ODFS内部可能有多个呼叫实例， 后继的交互根据Userid将同一通电话关联起来。 不超过64位 inaction int body True 接入方本次执行的是什么类型的请求： 8: 对话初始化请求 (第一次调用时) 9: 对话交互后请求 11: 对话转移后请求 注：除了第一次调用时必须为8， 后继传入值即为上次交互接收到的“outaction”即可。 seat String body False 座席类型，不填默认为vir vir：虚拟座席 ass：座席助手 inparams Object body True 用于向ODFS传递参数，告知ODFS本次操作结果的详细信息，Inaction的值不同,Inparams的参数也不相同，根据下面细分的场景详细了解参数介绍。 inaction=8 inaction=9 inaction=11 inaction=7 inaction=13 extparams Object body False 用于向ODFS传递参数，可选的扩展参数，当前只有初始化场景使用。 Inaction的值不同，extparams的参数也不相同，根据下面细分的场景详细了解参数介绍。 inaction=8 inaction=9 inaction=11 inaction=7 inaction=13

报文样例 场景描述：连接机器人 请求参数: { "content": "", "controlType": "CONNECT", "from": "session_1619573111751_user_1619573111751", "mediaType": "TEXT", "senderNickname": "user_1619573111751", "sourceType": "CUSTOMER", "timestamp": "1619573122352", "to": "1011577355744904195", "userAgent": null, "senderAvatar": null, "channel": "WEB" } 响应参数: { "resultCode": "0", "resultDesc": "connect to robot successfully." } 场景描述：与机器人交谈请求 请求参数: { "content": "版本", "controlType": "CHAT", "from": "session_1619573111751_user_1619573111751", "mediaType": "TEXT", "senderNickname": "user_1619573111751", "sourceType": "CUSTOMER", "timestamp": "1619573123199", "to": "1011577355744904195", "userAgent": null, "senderAvatar": null, "channel": "WEB" } 响应参数: { "resultCode": "0", "resultDesc": "Send message to robot successfully" } 场景描述：机器人转人工请求 请求参数: { "content": "", "controlType": "TRANS2AGENT", "from": "session_1619573111751_user_1619573111751", "mediaType": "TEXT", "senderNickname": "user_1619573111751", "sourceType": "CUSTOMER", "timestamp": "1619573129953", "to": "1011577355744904195", "userAgent": null, "senderAvatar": null, "channel": "WEB" } 响应参数: { "resultCode": "0", "resultDesc": "transfer from robot to agent success." } 场景：向座席发送文本消息 请求参数： { "content": "这是一条文字消息", "controlType": "CHAT", "from": "1678101150955228003", "mediaType": "TEXT", "senderNickname": "user_lk", "sourceType": "CUSTOMER", "timestamp": "1688038541395", "to": "202303061540344336", "userAgent": null, "senderAvatar": null, "channel": "WEB" } 响应参数 { "resultCode": "0", "resultDesc": "sendUserMessage successfully." } 场景：向座席发送图片消息 请求参数： { "content": "e31d0e44e82f", "controlType": "CHAT", "from": "lk_line_05", "mediaType": "IMAGE", "senderNickname": "lk_line_05", "sourceType": "CUSTOMER", "timestamp": "1688038541395", "to": "202303061540640554", "userAgent": null, "senderAvatar": null, "channel": "LINE" } 响应参数： { "resultCode": "0", "resultDesc": "sendUserMessage successfully." } 场景：向座席发送音频消息 请求参数： { "content": "157831a24986", "controlType": "CHAT", "from": "lk_line_05", "mediaType": "AUDIO", "senderNickname": "lk_line_05", "sourceType": "CUSTOMER", "timestamp": "1688038541395", "to": "202303061540640554", "userAgent": null, "senderAvatar": null, "channel": "LINE" } 响应参数： { "resultCode": "0", "resultDesc": "sendUserMessage successfully." } 场景：向座席发送视频消息 请求参数： { "content": "765c360ab724", "controlType": "CHAT", "from": "lk_line_05", "mediaType": "VIDEO", "senderNickname": "lk_line_05", "sourceType": "CUSTOMER", "timestamp": "1688038541395", "to": "202303061540640554", "userAgent": null, "senderAvatar": null, "channel": "LINE" } 响应参数： { "resultCode": "0", "resultDesc": "sendUserMessage successfully." } 场景：向座席发送文件消息 请求参数： { "content": "test_txt.txt,6,7d9fbcdd-e306-4b84-9831-163fb760cca9,txt", "controlType": "CHAT", "from": "1678101150955228003", "mediaType": "FILE", "senderNickname": "user_lk", "sourceType": "CUSTOMER", "timestamp": "1688038541395", "to": "202303061540344336", "userAgent": null, "senderAvatar": null, "channel": "WEB" } 响应参数： { "resultCode": "0", "resultDesc": "sendUserMessage successfully." } 场景：向座席发送文件图片消息 请求参数： { "content": "70d46bb7-2272-43b7-acad-c6f893a79848,png", "controlType": "CHAT", "from": "1678101150955228003", "mediaType": "FILE_IMAGE", "senderNickname": "user_lk", "sourceType": "CUSTOMER", "timestamp": "1688038541395", "to": "202303061540344336", "userAgent": null, "senderAvatar": null, "channel": "WEB" } 响应参数： { "resultCode": "0", "resultDesc": "sendUserMessage successfully." } 场景：向座席发送文件视频消息 请求参数： { "content": "0471a58b-0323-4b94-bc90-55ff36344471,mp4", "controlType": "CHAT", "from": "1678101150955228003", "mediaType": "FILE_VIDEO", "senderNickname": "user_lk", "sourceType": "CUSTOMER", "timestamp": "1688038541395", "to": "202303061540344336", "userAgent": null, "senderAvatar": null, "channel": "WEB" } 响应参数： { "resultCode": "0", "resultDesc": "sendUserMessage successfully." } 场景描述：向座席发送网页卡片消息 请求参数: { "content": "{\"title\":\"测试title 测试title 测试title\"，\"description\":\"测试描述 测试描述 测试描述 测试描述\"，\"mediaFileId\":\"xxxx-xxxx-xxxx-xxxx-2e171ac78313\"，\"mediaFileType\":\"img\"，\"redirectUrl\":\"https://www.****.com\"}", "controlType": "CHAT", "from": "session_1619573111751_user_1619573111751", "mediaType": "WEBCARD", "senderNickname": "user_1619573111751", "sourceType": "CUSTOMER", "timestamp": "1619573129953", "to": "1011577355744904195", "userAgent": null, "senderAvatar": null, "channel": "WEB" } 响应参数: { "resultCode": "0", "resultDesc": "sendUserMessage successfully." } 或 { "resultCode": "3", "resultDesc": "The redirection address is not in the trust list， contact operation staff to add it." } 场景描述：断连请求 请求参数: { "content": "", "controlType": "DISCONNECT", "from": "session_1619573842490_user_1619573842490", "mediaType": "TEXT", "senderNickname": "user_1619573842490", "sourceType": "CUSTOMER", "timestamp": "1619573854156", "to": "1011577355744904195", "userAgent": null, "senderAvatar": null, "channel": "WEB" } 响应参数: { "resultCode": "0", "resultDesc": "Disconnect robot successfully" }

响应说明 响应状态码: 200 表4 senMsgRsp参数结构 序号 名称 参数类型 说明 1.1 resultDesc string 返回结果码描述 根据不同的场景，返回描述不一样： CONNECT连接座席 如果resultCode返回0：成功 如果resultCode返回11：Queuing... 如果resultCode返回12：The current time is not within the working time of the service agents 如果resultCode返回13：No ccucs address available!或connect failed, none channel config found. 其他非零错误请参见《CCU CS 接口开发指南》中的错误码参考。 CONNECT连接机器人 如果resultCode返回0：connect to robot successfully或process robot multi message successfully。 如果resultCode返回11：Queuing... 如果resultCode返回13：Failed to disconnect robot或No ccucs address available!或fail to initialize robot.或connect failed, none channel config found. DISCONNECT断连座席 如果resultCode返回0：disconnect successfully 如果resultCode返回11：Queuing... 如果resultCode返回13：disconnect failed.或disconnect failed, none channel config found.或disconnect failed, session keep touch failed. DISCONNECT断连机器人 如果resultCode返回0：Disconnect robot successfully 如果resultCode返回11：Queuing... 如果resultCode返回13：Failed to disconnect robot.或disconnect failed, none channel config found.或disconnect failed, session keep touch failed. CHAT座席场景 如果resultCode返回0：sendUserMessage successfully. 如果resultCode返回3：Incorrect JSON format或content can not be empty或the content Json String must contains mediaFileId or redirectUrl或the content Json String must contains title或Incorrect mediaFileType. 如果resultCode返回11：Queuing... 如果resultCode返回13：sendUserMessage failed.或Chat failed because the content is empty.或chat failed, none channel config found.或chat failed, send too quick or session keep touch failed. CHAT机器人场景 如果resultCode返回0：Failed to disconnect robot 或Send message to robot successfully 或process robot multi message successfully 如果resultCode返回3：Incorrect JSON format或content can not be empty或the content Json String must contains mediaFileId or redirectUrl或the content Json String must contains title或Incorrect mediaFileType 如果resultCode返回11：Queuing... 如果resultCode返回13：connect failed或Chat failed because the content is empty.或chat failed, none channel config found.或chat failed, send too quick or session keep touch failed. TRANS2AGENT场景 如果resultCode返回13：转人工失败，找不到渠道配置transfer to agent failed, none channel config found. 如果resultCode返回13：转人工失败，会话已失效。fail to transfer from robot to agent,session keep touch failed. 如果resultCode返回13：转人工失败,当前已经是人工服务。fail to transfer from robot to agent,it has been agent service. 如果resultCode返回11：Queuing... 如果resultCode返回12：当前非座席工作时间！The current time is not within the working time of the service agents. 如果resultCode返回13：转人工失败, 无法连接CCUCS。fail to transfer from robot to agent,connect to ccucs failed. 如果resultCode返回13：断开机器人连接失败。Failed to disconnect robot. 如果resultCode返回13：当前无可用座席。No agents available currently. 如果resultCode返回0：transfer from robot to agent success. INPUT场景 如果resultCode返回0：sendUserMessage successfully. 如果resultCode返回11：Queuing... 如果resultCode返回13：发送输入状态失败，找不到渠道配置。send inputStatus failed, none channel config found. 如果resultCode返回13：现在是机器人服务，此条消息无法发送！This is robot service,this message is prevented! 如果resultCode返回13：发送用户消息失败！sendUserMessage failed 如果resultCode返回13: Queuing... 如果resultCode返回3：发送网页卡片消息成功，但是跳转地址未添加到白名单，座席无法跳转。 The redirection address is not in the trust list, contact operation staff to add it. 1.2 resultCode string 接口返回码，成功为0，非0失败 1.3 offlineMsg object 如果离线开关打开，则该值将为true。如果离线开关关闭，AICC将不会返回此对象。 1.3.1 isOfflineStatus boolean 用于客户端判断连接失败后用户是否可以发送消息。 在以下场景中， 1.用户发送失败（controlType=CONNECT）， 2.用户发送（controlType=CHAT）失败，没有会话， 3.用户在技能队列中等待时发送(controlType=DISCONNECT) 1.3.2 tipText string 当isOfflineStatus为true时，即触发离线模式，消息将被保存。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口生成的ccmessaging-token 2 x-app-key string True appKey字段，用户标识，在ApiFabric工具上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody sendMsgReq True 请求体 表3 sendMsgReq参数结构 序号 名称 参数类型 是否必选 说明 1.1 channel string True 客户端发送消息的所属渠道类型，如WEB(WEB客服接入渠道) 1.2 content string False 消息内容，视mediaType而定，例如： mediaType是TEXT，content就是发送的文本内容，文本内容大小不能超过1K。 mediaType是IMAGE、AUDIO、VIDEO，content是fileId，fileId为/ccmessaging/uploadFileStream接口返回的objectKey。 mediaType是FILE，content是拼接后的字符串，以英文逗号分割，固定格式如下："fileName,fileSize（单位：B）,fileId,fileType"，其中fileId为/ccmessaging/uploadFileStream接口返回的objectKey，示例："test_txt.txt,6,7d9fbcdd-e306-4b84-9831-163fb760cca9,txt"。 mediaType是FILE_IMAGE、FILE_VIDEO，content是拼接后的字符串，以英文逗号分割，固定格式："fileId,mediaType"，其中为/ccmessaging/uploadFileStream接口返回的objectKey，如图片为"objectKey,jpg"，视频为"objectKey,mp4"，音频为"objectKey,mp3"，位置为"objectKey,txt"，文件下载接口会使用此fileId做文件下载用。 如果mediaType值为WEBCARD，content的值为JSON结构转换的字符串，例如JSON固定结构如下：{"title":"卡片标题"，"description":"卡片描述"，"mediaFileId":"卡片媒体文件ID，通过upload接口返回"，"mediaFileType":"当前仅支持固定值img，img/png，img/jpg，不填类型默认按jpg"，"redirectUrl":"跳转地址"}，其中redirectUrl和mediaFileId为二选一必填项，其他项不填可以为空值。 1.3 controlType string True 消息控制类型，如连接（CONNECT），聊天(CHAT)，转人工（TRANS2AGENT），用户输入中（INPUT），断开连接(DISCONNECT)，已读（READ） 1.4 from string True 渠道下发送消息的用户ID，取值范围：1到24位字符串。 1.5 mediaType string True 消息媒体类型，如文本类型（TEXT），图片类型（IMAGE），音频类型（AUDIO），视频类型（VIDEO），文件类型（FILE），文件图片（FILE_IMAGE），文件视频（FILE_VIDEO），网页卡片消息（WEBCARD） 1.6 senderNickname string False 消息发送者的昵称 1.7 sourceType string True 消息来源类型，需配置为：CUSTOMER 1.8 timestamp string False 消息发送时间 1.9 to string True 渠道配置ID 1.10 userAgent string False 用户客户端类型，取自UserAgent 1.11 senderAvatar string False 消息发送者的头像，渠道传输头像URL，最长1024字符 1.12 messageId string False 用于标识发送的消息用户的唯一值。最大长度为32。值不能包含逗号“，”。 1.13 transData string False json格式数据，连接机器人的时候传给机器人流程。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "queryParam": { "ccId":1, "vdn":1, "agentId":101 } } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": { "workNo": 101, "vdnId": 1, "citStatus": 0, "name": "HW35154101", "phoneNumber": null, "loginDate": 4294967295000, "currentStateTime": 436879, "mediaType": 0, "status": 2 }, "resultDesc": { "workNo": 101, "vdnId": 1, "citStatus": 0, "name": "HW35154101", "phoneNumber": null, "loginDate": 4294967295000, "currentStateTime": 436879, "mediaType": 0, "status": 2 } }

请求说明 表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 agentId Int True 座席工号。 取值范围：101-59999

响应消息 表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 workNo int 座席工号。 2.2 vdnId int 所属VDN ID。 2.3 citStatus Int 座席平台状态。CTI平台座席状态码参考 2.4 name String 座席名称。 2.5 phoneNumber String 座席电话号码。 2.6 loginDate long 签入时间。（毫秒级时间戳） 2.7 currentStateTime long 当前状态时长 单位秒(s)。 2.8 mediaType Int 座席媒体类型，请参见表1 2.9 status Int 座席状态。表5 表5 座席状态 值 说明 0 未知。对应CTI平台状态的9。 1 签入状态。未使用。 2 签出状态。对应CTI平台状态的0。 3 示忙状态。对应CTI平台状态的7。 4 空闲状态。对应CTI平台状态的1。 5 整理态。对应CTI平台状态的6。 6 同空闲态。未使用。 7 通话态。对应CTI平台状态的2、3、4、5。 8 休息状态。对应CTI平台状态的8。

报文样例 该接口的请求消息体举例如下： {"callerNo":[ {"accessCode":"5245241"} ]} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "delete callerNo success.num:1", "returnCode": "0200000", "returnDesc": "delete callerNo success.num:1" }

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 callerNo List True 支持多主叫号码。最多100个号码。 该对象的参数说明请参见表4 表4 callerNo参数说明 序号 参数名 参数类型 是否必选 说明 1.1 accessCode String True 主叫号码。 呼通客户后，客户的电话终端上显示的号码。 最大长度为24个字符，有效字符为：0~9。

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callerNo/{campaignId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId int True 外呼活动的ID。来源于新增外呼活动接口。

使用说明 前提条件 已调用“下载话单和录音索引”获取录音索引文件。 已通过鉴权（Authorizaton）、获取接入地址。 使用限制 开发者只能下载自己帐号下的文件，开发者帐号（appId）和录音文件名称（fileName）必须对应。 开发者账号包含在鉴权认证的字符串中，详见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 SaaS/OP集成组网下，下载的录音文件编码格式为G711.A-law，请使用合适的播放器播放。

请求说明 表1 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String（1-32） True 2.0 协议版本。当前固定值为2.0。 表3 请求Body中msgBody参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 fileName String（1-225） True 无 录音文件相对路径名称，从调用“下载话单和录音索引”时返回的录音索引文件中的 file_name 字段获取。 参数格式：/{nodeId}/{ccId}/record/{vdnId}/{yyyymmdd}/{agentid}/{原始文件主名}.wav 说明：{nodeId}节点ID，{ccId}为呼叫中心ID，{vdnId}为平台VDN的ID，{yyyymmdd}为生成录音文件的日期，{agentid}为产生该录音文件的座席ID，{原始文件主名}为录音文件的名称。例如：/10/1/record/appId/100/15362/autoTest.wav

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成录音文件，文件后缀名为.wav，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表4，resultData为保留字段，默认为空字符串。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象，参数说明详见表5 不推荐使用，为兼容老版本保留字段。 表5 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码，详见错误码参考。 4.3 resultMsg String 请求结果描述。

报文样例 请求头 POST /CCFS/resource/ccfs/downloadRecordFile HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/ eb453f68e85******************80196c509c4913 Accept: */* Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "/10/1/record/appId/100/autoTest.wav" } }

报文样例 请求消息体 { "appKey": "tenant001", "appSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } 响应消息体 { "errorCode" : 0, // int, 错误码,无错时为0 "errorMsg" : "", // String, 出错信息,无错时为空 "authToken": "2************************", "expireTime" : 3600 }

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 0：成功 非0表示失败 或可通过状态码为200判断为成功 errorMsg String body False 错误描述 authToken String body True 认证token expireTime int body False 令牌有效期，单位是秒数，默认 3600 秒； 错误码非0时，无返回。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 id string 20 True 工单id 2 ownerId string 20 True 工单的责任人，工单自动分配时可以不填写，创建工单接口中根据分配逻辑自动分配责任人 3 ownerType string - True 责任人类型： user queue 4 creatorId string 20 True 操作处理人id 5 remark string 2000 True 描述信息 如果分配工单涉及的工单类别使用了自定义的工单模板，则工单模板上扩展的字段可继续在请求消息体中继续往后添加。

消息样例 场景描述：分配工单 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/case/transfer 请求头: { "Content-Type": "application/json"， "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "id":"c6m800000142lp0xsJlI", "ownerId":"10gg0000012IpiXMqxzk", "ownerType": "queue", "creatorId": "10gg0000013wbIvo3zbk", "remark": "10330013wbIvo30bk" } 响应头： { "connection": "keep-alive"， "Content-Length": "16"， "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： {"resCode": "0","resMsg": "成功"}

座席监控指标 表1 座席历史监控指标 编码 指标名 说明 IDX_COUNT_AGENT_SIGN_IN 签入次数 座席签入的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_CONNECTED 呼入通话次数 人工呼入的通话次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_CALL_OUT 呼出通话次数 呼出的通话次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_COLLATION 话后整理次数 通话后的整理次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_COLLATION_CALL_IN 呼入话后整理次数 呼入通话后的整理次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_COLLATION_CALL_OUT 呼出话后整理次数 呼出通话后的整理次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_REST 休息次数 座席休息次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_HOLD 保持次数 座席执行保持操作的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_SET_BUSY 示忙次数 座席执行示忙操作的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_MOVE_INSIDE 内部转移次数 座席执行内部呼叫转移的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_MOVE_OUT 转出次数 座席将呼叫转出的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_MOVE_IVR 挂起转IVR次数 座席挂起转IVR的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_3WC 三方通话数 座席执行三方通话的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_INSIDE_CALL 内部呼叫数 座席执行内部呼叫的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_INSIDE_HELP_SEEKING 内部求助数 座席执行内部求助的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_REQUEST 请求数 人工呼入的请求数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_ABANDON 呼损数 人工呼入呼损数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_WAIT_ANS 振铃待通话数 人工呼入振铃待通话的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_LOST_RING 振铃无通话数 人工呼入振铃但无通话的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_NO_ACK 座席久不应答数 人工呼入座席久不应答次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_HANG_UP 挂机数（应答时） 人工呼入应答时座席挂机的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_CONNECTED_IN_(N) n秒内人工接通数 其中N=3、5、10、15、20、25、30、35、40、45、50、55、60（不支持分钟粒度查询，即接口入参不要带timeGrain） 查询当天（入参不带“timeGrain”）指标为实时指标。 例如：N=20时，指标编码为IDX_COUNT_AGENT_CONNECTED_IN_20。 IDX_COUNT_TOTAL_AGENT_CALL_OUT 呼出总次数 呼出总次数，包括呼出通话次数和呼出未接通次数 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标 IDX_DURATION_AGENT_SIGN_IN 签入时长 座席执行签入操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_CALL_IN 呼入通话时长 人工呼入的通话时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_AVG_CALL_IN 呼入通话均长 人工呼入通话的平均时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_CALL_OUT 呼出通话时长 呼出的通话时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_AVG_CALL_OUT 呼出通话均长 呼出的通话平均时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_COLLATION 话后整理时长 通话结束后的整理时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_COLLATION_CALL_IN 呼入话后整理时长 呼入通话结束后的整理时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_COLLATION_CALL_IN 呼入话后整理均长 呼入通话结束后的整理平均长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_COLLATION_CALL_OUT 呼出话后整理时长 呼出通话结束后的整理时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_COLLATION_CALL_OUT 呼出话后整理均长 呼出通话结束后的整理平均长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_COLLATION 话后整理均长 通话结束后的整理平均长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_REST 休息时长 座席执行休息操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_REST 休息均长 座席执行休息操作的平均时长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_HOLD 保持时长 座席执行保持操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_HOLD 保持均长 座席执行保持操作的平均时长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_SET_BUSY 示忙时长 座席执行示忙操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_SET_BUSY 示忙均长 座席执行示忙操作的平均时长。（不支持按分钟粒度统计） 查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_RING 应答时长 人工呼入应答的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_FREE 空闲时长 座席执行空闲操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_AVG_RING 应答均长 人工呼入应答的平均时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_MAX_CALLING 最大通话时长 人工呼入最大的通话时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_DURATION_AGENT_MIN_CALLING 最小通话时长 人工呼入最小的通话时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_AGENT_CONNECTED 通话率 人工呼入通话成功次数占呼入请求次数的比率。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_RATE_AGENT_SUCC_CALL_OUT 呼出成功通话率 呼出通话次数占呼出总次数的比率。 分钟粒度或查询当天（入参不带“timeGrain”）指标为实时指标。 IDX_COUNT_AGENT_ARRANGE 整理次数 座席执行整理操作的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_ARRANGE 整理时长 座席执行整理操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_COUNT_AGENT_PLAY 放音次数 座席执行放音操作的次数。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 IDX_DURATION_AGENT_PLAY 放音时长 座席执行放音操作的时长。 分钟粒度或查询当天（入参不带“timeGrain”）指标为非实时指标。 表2 座席实时监控指标 编码 指标名 说明 IDX_AGENT_PHONE 电话号码 座席电话号码。需要签入座席 IDX_AGENT_CURRENT_STATE 座席状态 座席状态。CTI平台座席状态码参考 IDX_DURATION_AGENT_CURRENT_STATE 当前状态持续时长 座席当前状态持续时长（秒）。 IDX_AGENT_ LOG IN_SKILLS 签入或者拥有的技能列表 技能队列ID的数组。 表3 座席定制指标 编码 指标名 说明 IDX_AGENT_RESERVED_COL(N) 座席定制指标N 取值范围：1～20 父主题： 指标编码参考

ExtParams参数 参数名称 数据类型 参数位置 必选/可选 描述 transin_data String body False 由接入方跟OIAP约定的随路数据参数,例如IVR传入的数据包参数 locationid String body False 呼叫录音节点号 mediaability String body False 媒体能力 1：音频 2：视频 3：音视频 ieValue String body False 接入方跟OIAP约定的User To User类型的随路数据参数，使用场景为：在与其他的平台对接时，如果呼叫是从其他的第三方的平台转移过来的呼叫，使用该参数携带SIP Header UUI信息。该参数的取值记录日志时会匿名化处理，保存数据库时会加密处理

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

响应消息样例5 { "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" } }

请求消息样例1 { "userid": "1528780879-9581", "inaction": 8, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian", "suilu_region_id": "025", "entrance_id": "03" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" } }

响应消息样例4 { "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" } }

响应消息样例2 { "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" } }

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志，与userid 取值相同,给流程使用。 不超过64位 call_sor_id String body True 用户标识。（语音导航、语音外呼场景传入用户号码，其他交互场景传入用户id） 不超过64位 call_dst_id String body True 接入标识 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） INSTAG RAM （Instagram） TELEGRAM(Telegram) WECHAT(微信) FACEBOOK（Facebook） TWITTER（X (Twitter)） EMAIL（邮件） LINE WHATSAPP（WhatsApp） 5G（5G消息） SMS （短信）。 说明： 括号里为界面字段，区别于接口传参字段。 responseStyle String body False 回复风格

呼叫媒体类型说明 表1 呼叫媒体类型 编号 媒体类型 描述 1 MEDIA_TYPE_CHAT 文字交谈 2 MEDIA_TYPE_WEBPHONE 点击通话 3 MEDIA_TYPE_ESCORT 护航浏览、表单共享 4 MEDIA_TYPE_CALLBACK 回呼请求呼叫 5 MEDIA_TYPE_PHONE 普通语音电话 6 MEDIA_TYPE_EMAIL 电子邮件呼叫 7 MEDIA_TYPE_FAX 传真呼叫 8 MEDIA_TYPE_VIDEO IP视频呼叫(H.323) 9 MEDIA_TYPE_WB 电子白板 10 MEDIA_TYPE_APP_SHARE 应用程序共享 11 MEDIA_TYPE_FILE_TRANSFER 文件传输 12 MEDIA_TYPE_VIDEO_2B1D 2B+D ISDN视频呼叫 13 MEDIA_TYPE_VIDEO_6B1D 6B+D ISDN视频呼叫 14 MEDIA_TYPE_OPS OPS呼叫 15 MEDIA_TYPE_PREDICT_OUTBOUND 预测呼出 16 MEDIA_TYPE_PREVIEW_OUTBOUND 预浏览呼出 17 MEDIA_TYPE_MSG 消息媒体 18 MEDIA_TYPE_WEBPHONE_VIDEO 视频点击通话 19 MEDIA_TYPE_PHONE_VIDEO 视频普通呼叫 20 MEDIA_TYPE_WEB_LEAVE_MESSAGE 非实时呼叫 21 MEDIA_TYPE_DESKTOP_SHARE 桌面共享媒体类型 22 MEDIA_TYPE_VC_CALL 技能队列呼入主叫号码功能 23 CLASSIC_MEDIA_TYPE_NUM 接触媒体类型总数 50 MEDIA_TYPE_MULTI_MEDIA_EMAILCHAT 邮件交谈 51 MEDIA_TYPE_MULTI_MEDIA_WEBCHAT 网络交谈 52 MEDIA_TYPE_MULTI_MEDIA_SMSCHAT 短信交谈 53 MEDIA_TYPE_MULTI_MEDIA_SOCIALCHAT 文字交谈 54 MEDIA_TYPE_MULTI_MEDIA_FAXCHAT 传真交谈 55 MEDIA_TYPE_MULTI_MEDIA_H5CHAT H5视频 父主题： 参考说明