华为云用户手册

错误结果码 表5 错误原因码说明 序号 错误码 说明 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 参数个数不能大于规定个数

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}?name={name}&status={status}&deviceType={deviceType}&beginTime={beginTime}&endTime={endTime}&curPage={curPage}&rowsPerPage={rowsPerPage} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 name String False 外呼活动的名称。 长度为0~30，默认值为空。 3 status int True 外呼活动的状态。 取值范围： 2：已开始 3：暂停 4：已完成 0：默认查询全部状态 4 deviceType int True 外呼设备类型。 取值范围： 1：智能外呼的IVR 2：预测外呼的技能队列 3：自动外呼的IVR 5：预览外呼的技能队列 6：预占外呼的技能队列 0：默认查询全部类型 5 beginTime String False 外呼活动的最小开始时间，格式为yyyy-MM-dd HH:mm:ss。 6 endTime String False 外呼活动的最大结束时间，格式为yyyy-MM-dd HH:mm:ss。 7 curPage int True 当前第几页。 默认值为1，输入值小于1时自动修正为1。 8 rowsPerPage int True 每页记录数。 该值不输入的时候，默认查询10条，且最大值为100。 9 ccId int False 传了就按指定的ccid过滤，不传就不过滤

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

错误结果码 表5 错误原因码说明 序号 错误码 说明 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 参数个数不能大于规定个数

请求说明 表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 blocklistNo String True 需要删除的黑名单号码。最大长度为24个字符，有效字符为：0~9、*、#

请求消息样例 如果呼叫转移成功,接入方先发起如下请求。 { "userid": "1528780879-9581", "inaction": 11, "inparams": { "call_id": "1528780879-9581", "call_dst_id": "10086", "begin_trans": "2018090407:16:24", "end_trans": "2018090407:20:24", "trans_result":"0", "input": "", "inter_idx": "1" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" } } 在收到ODFS的响应后,则再次发起如下请求。 { "userid": "1528780879-9581", "inaction": 11, "inparams": { "call_id": "1528780879-9581", "call_dst_id": "10086", "begin_trans": "2018090407:16:24", "end_trans": "2018090407:20:24", "trans_result":"0", "input": "hangup", "inter_idx": "1" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" } } 收到请求后,ODFS侧则再次返回拆线响应,接入方侧不需再调用ODFS侧接口,整个呼叫转移动作完成。 如果呼叫转移失败 传入上述参数后, 可能收到ODFS返回 outaction=9/10/11 类型的返回（由业务逻辑决定）

响应消息样例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" //扩展 } }

响应消息样例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、语音外呼问卷场景时为流程接入码； 3、其他交互场景时传入接入标识。 不超过20位 begin_trans String body True 转移开始时间。 end_trans String body True 转移结束时间。 trans_result String body True 转移结果。 0：成功 其他值：失败 auth_token String body True 授权信息,取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 record_result String body False 录音结果（仅当转接第三方号码成功时生效） 0：成功 其他值：失败 input String body False 交互结果,（此参数请参考以下场景） 当转移成功后,接入方的请求参数需要传入trans_result=0的参数,不需要input；此后接入方收到ODFS的拆线(outaction=10)的响应，需接入方再次发送此请求，且请求参数需要包含input参数，取值为hangup。 hangup：挂机 不超过1024位 inter_idx String body False(语音导航场景特有字段) 交互次数，直接取上一次ODFS返回的inter_idx值即可。 mediaType String body False 媒体类型（文本、音频、视频... 例如：audio,video...） 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 （短信）。 说明： 括号里为界面字段，区别于接口传参字段。

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

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200007 外呼活动已经不存在。 3 0200008 开始时间和结束时间不是同时存在，或者同时不存在。 4 0200009 开始时间或者结束时间的格式不正确。 5 0200010 开始时间不是早于结束时间。 6 0200011 开始时间和结束时间相差的天数超过30天。 7 02000001 参数值为空 8 02000002 参数包含非法字符 9 02000003 参数长度不能大于规定长度 10 02000004 参数长度不能小于规定长度 11 02000005 参数长度需要介于规定长度之间 12 02000006 参数值类型不正确 13 02000007 参数值大小不正确 14 02000008 参数转换异常，请检查请求参数 15 02000009 参数组合不正确，请检查请求参数 16 02000010 hour和minute必须同时存在 17 02000011 参数个数不能大于规定个数

报文样例 该接口的请求消息体举例如下： { "sessionId": "1202_test013", "pageSize": 500, "pageNum": 1 } 该接口的响应消息体举例如下： { "resultCode":"0200000", "resultDesc":"Query Success!", "returnCode":"0200000", "returnDesc":"Query Success!", "totalCount": 2, "data": [ { "campaignId": "3", "sessionId": "1202_test013", "called": "60584", "callTimeStr": "2020-08-30 20:00:00", "callStatus": 6, "failCode": "0", "resultCode": "OB99999", "vdnId": 11, "callId": "0023-134864174", "recordPath": "Y:/1/11/20200830/3408/0949218.V3" }, { "campaignId": "3", "sessionId": "1202_test013", "called": "60584", "callTimeStr": "2020-08-30 20:05:00", "callStatus": 6, "failCode": "0", "resultCode": "OB99999", "vdnId": 11, "callId": "0023-134864893", "recordPath": "Y:/1/11/20200830/3408/0942113.V3" } ] }

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

响应说明 表4 响应体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 4 returnDesc String 描述。 5 totalCount int 外呼结果总数 6 data JSONArray 结果json，详见表5。 表5 data参数说明 序号 参数名称 参数类型 描述 6.1 campaignId String 外呼任务的id 6.2 sessionId String 标识用户的ID 6.3 called String 被叫号码 6.4 callTimeStr String 呼叫时间，格式为：yyyy-mm-dd hh:mm:ss 6.5 callStatus int 呼叫结果（5: 呼叫失败，6: 呼叫成功） 6.6 failCode String 失败的原因码。 6.7 resultCode String 失败的原因码对应的外显结果码。外显结果码可以自定义，失败原因码与外显结果码相互关联。 6.8 vdnId int 外呼号码所属VDN ID。 6.9 callId String 通话记录ID，用于与CTI平台的话单等通话数据关联。 6.10 recordPath String 通话录音文件的存储路径。 说明： 该字段仅在使用接续时（SAAS组网），才返回值，其他情况返回为空。

报文样例 该接口的请求消息体举例如下： { "serverId":"164690088271159234793429225848", "filePath":"/isales/upload", "fileName":"demogl50w.xlsx" } 该接口的响应消息体举例如下： { { "returnCode": "0200000", "importTaskId": "164870990605164487770867067540", "resultCode": "0200000", "resultDesc": "数据导入中，请通过“导入结果”查看详细信息。", "returnDesc": "数据导入中，请通过“导入结果”查看详细信息。" }

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

响应说明 表7 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 importTaskId String 文件导入任务ID 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表8 5 returnDesc String 描述。

错误结果码 表8 错误原因码说明 序号 错误码 说明 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 参数个数不能大于规定个数

外呼数据导入模板 请参考表1创建Excel模板文件。 表1 外呼数据模板 sessionId(非必填) called必填 caller(非必填) callData(非必填) customField（非必填） recycleTime(非必填) - [{'calledNo':1234566}] - - - - 表2 外呼数据模板参数说明 序号 参数名 参数类型 是否必选 说明 1.1 sessionId String False 标识用户的ID，外呼结果中会回传用户。 最大长度为32个字符。 1.2 called String True JSON数组 客户号码信息。 1.3 caller String False 主叫号码。 最大长度为24个字符。 1.4 customField String False 用户自定义字段，最大长度200。 1.5 recycleTime String False 回收时间，格式为yyyy-mm-dd hh:mm:ss。 1.6 callData String False 随路数据，最大长度1024，建议JSON格式。 注意： 当自动外呼涉及到智能IVR流程时，该参数格式只支持JSON格式。 智能IVR流程使用JSON格式调用图元对JSON格式的随路数据进行解析和赋值操作，图元的具体实现和使用方式请参见JSON数据调用图元。 JSON格式参考如下： {\\\"iSales\\\":{\\\"ServiceID\\\":\\\"1164541685\\\",\\\"fullName\\\":\\\"林子航\\\",\\\"date\\\":\\\"二零二二年三月三十一日\\\",\\\"riskName\\\":\\\"交强险\\\"}} 表3 called参数说明 序号 参数名 参数类型 是否必选 说明 1.2.1 calledNo String True 客户被叫号码。 最大长度为24个字符，有效字符为：0~9、*、#。 1.2.2 delayTime String False 客户每个号码呼叫的间隔时间，单位秒，范围0~7200，默认值0。 1.2.3 type String False 客户号码类型。

座席来电提醒 标示符 AgentEvent_Ringing 作用 座席来电提醒，提醒用户需要手工应答呼叫。 附带信息 caller：文本型，主叫号码，如果为座席，则首字符为a或者A。 transfer: 文本型，表示当前通话是否通过呼叫转移建立。"yes" 表示通过呼叫转移建立，"no" 表示非呼叫转移建立。 called：文本型，被叫号码，如果为座席，则首字符为a或者A。 transFrom：文本型，如果是通过转移建立的通话，转移的来源是什么，如果非呼叫转移建立，则该字段为空。 callid：文本型，呼叫所属于的CallId（呼叫标示）。 type：文本型，协作呼叫(assistant)或主呼叫(main)。 feature：呼叫类型，例如0普通呼入，7普通外呼。 mediaAbility：媒体能力，1表示语音，2表示视频，3表示音视频，5表示文字，6表示H5视频。 mediaType：媒体类型，其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Ringing","workNo":"49999","content":{"caller":"49997","transfer":"no","callid":"1456404043-37","transfrom":"","called":"49999","type":"main","mediaAbility":"1","feature":"0","mediaType": "5"}}} 父主题： 音视频通话事件

报文样例 该接口的请求消息体举例如下： 可以根据业务需要选择不同的策略组合。 全局策略+普通策略policyType=0，type=0。 { "policyJson":"[{'type':0,'retryTimes':1,'retryDay':1}]", "policyType": 0 } 全局策略+结果策略policyType=0，type=1。 { "policyJson":"[{'type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]", "policyType": 0 } 号码类型匹配策略+普通策略policyType=1，type=0。 { "policyJson" : "[{'dataType':'ST','type':0,''policy':{'retryTimes':2,'retryDay':1}}]", "policyType": 1 } 号码类型匹配策略+结果策略policyType=1，type=1。 { "policyJson":"[{'dataType':'ST','type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]", "policyType": 1 } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "" }

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

接口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 } }