华为云用户手册

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":1, "skillIds":[11,24], "timeGrain":"15MIN", "indexIds":["IDX_COUNT_SKILL_REQUEST","IDX_COUNT_SKILL_CONNECTED"], "mediaType":53, "subMediaType":3 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": { "2020-08-24 10:30:00.0": "6", "2020-08-24 10:45:00.0": "4" }, "id": "IDX_COUNT_SKILL_CONNECTED" } ], "id": "12" }, { "idxs": [ { "val": { "2020-08-24 10:00:00.0": "16", "2020-08-24 10:15:00.0": "14" }, "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": { "2020-08-24 10:00:00.0": "5", "2020-08-24 10:15:00.0": "4" }, "id": "IDX_COUNT_SKILL_CONNECTED" } ], "id": "13" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": { "2020-08-24 10:30:00.0": "6", "2020-08-24 10:45:00.0": "4" }, "id": "IDX_COUNT_SKILL_CONNECTED" } ], "id": "12" }, { "idxs": [ { "val": { "2020-08-24 10:00:00.0": "16", "2020-08-24 10:15:00.0": "14" }, "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": { "2020-08-24 10:00:00.0": "5", "2020-08-24 10:15:00.0": "4" }, "id": "IDX_COUNT_SKILL_CONNECTED" } ], "id": "13" } ] }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID accessCode String body False 接入标识，如果不传，则系统自动生成接入标识 在Op场景下，如source参数没有值，或值为IVR时，本参数必填，且不超过20位字符。 在SaaS场景下，如果createFlag有值，则使用系统生成的accessCode，本参数可不用填 在SaaS场景下，如果createFlag没有值，则accessCode必填，且长度为9~24位字符。 domainId int body False 领域ID dialogType int body True 对话类型 1：语音导航 2：智能外呼 3：聊天机器人 4：IVR流程 flowCode String body True 流程编码 description String body False 描述 description参数和createFlag参数中有一个必填。 在saas场景下将作为流程描述使用，需要确保全局唯一，长度不超过50位 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。 source String body False 发起对话识别的源设备。 IVR：来自IVR流程 OIFDE：表示来自ODFS配置的智能化流程 不传，默认按照IVR处理 createFlag String body False 是否创建。 description参数和createFlag参数中有一个必填。 createFlag=0，添加机器人场景，添加机器人与流程的绑定关系； createFlag=1，导入流程涉及接入码导入，允许重名覆盖场景，在查询到绑定关系的情况下，先删除绑定关系，再添加绑定关系。

报文样例 请求报文 { "tenantId": "tenant001"， "accessCode": "10086" ， "domainId": 10001 ， "dialogType":1， "flowCode": "flowxxxxxx" ， "description": "" ， "authToken": "0dbe*******************b505de" } 响应报文 新增成功： 无响应体报文。 新增错误： { "errorCode" : 10000， // int， 错误码，成功通过状态码为200判断 "errorMsg" : "" }

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body False 呼叫唯一标志，与userid 取值相同，给流程使用。 不超过64位 call_sor_id String body False 用户标识。（语音导航、语音外呼场景传入用户号码，其他交互场景传入用户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值。

请求消息样例 { "userid": "1528780879-9581"， "inaction": 7， "inparams": { "call_id": "1528780879-9581"， "call_sor_id": "13500000001"， "call_dst_id": "10086"， "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian" } }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1 userNickname string 姓名 2 userId string 用户id 3 userAvatar string 用户头像 4 channel string 渠道名称，例如WEB，WECHAT，FACEBOOK 5 createTime string 创建时间 6 channelConfigId string 渠道配置id 7 userAgent string 用户代理 8 clientIp string 客户端IP 9 osName string 操作系统名称 10 borderType string 操作系统版本 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表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。取值范围：1到24位字符串。 3 tenantId string True 租户id

请求说明 表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 array 查询成功后，返回座席正在处理的呼叫callId数组。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc array 查询成功后，返回座席正在处理的呼叫callId数组。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "agentId":1099 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ "1605492949-1447" ], "resultDesc": [ "1605492949-1447" ] }

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "queryParam": { "ccId":1, "isCallin":"true", "callId":"1000000000-0001" } } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": { "vdn": 1, "callId": "1000000000-0001", "callerNo": "10000", "calleeNo": "10001", "callType": 0, "agentId ": 100, "skillId": 1, "anonyCall": 0, "queueWaitTime": 10, "ivrCallTime": 0, "ackTime": 5, "callTime": 30, "releaseCause": 0 }, "resultDesc": { "vdn": 1, "callId": "1000000000-0001", "callerNo": "10000", "calleeNo": "10001", "callType": 0, "agentId ": 100, "skillId": 1, "anonyCall": 0, "queueWaitTime": 10, "ivrCallTime": 0, "ackTime": 5, "callTime": 30, "releaseCause": 0 } }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 消息体参数说明。 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围：1～65535 2 isCallin string True 是否呼入通话。 取值范围： "true"代表呼入， "false"代表呼出 3 callId string True 呼叫ID。

响应消息 表3 消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 vdn int 虚拟呼叫中心编号。 2.2 callId string 呼叫ID。 2.3 callerNo string 呼叫的主叫号码。 2.4 calleeNo string 呼叫的被叫号码。 2.5 callType int 呼叫类型，请参见表1 2.6 agentId int 座席工号。 2.7 skillId int 技能队列编号。 2.8 anonyCall int 匿名呼叫标识。(只有呼入时才有值) 2.9 queueWaitTime int 队列等待时长（秒）。 2.10 ivrCallTime int IVR通话时长(秒)。 2.11 ackTime int 应答时长(秒)。 2.12 callTime int 通话时长(秒)。 2.13 releaseCause int 呼叫释放原因码，请参见呼叫释放原因码 2.14 beginTime string 呼叫开始时间(预测外呼，预占用外呼时才有值) 格式：yyyy-MM-dd HH:mm:ss 2.15 endTime string 呼叫结束时间(预测外呼，预占用外呼时才有值) 格式：yyyy-MM-dd HH:mm:ss 2.16 result string 呼叫结果(预测外呼，预占用外呼时才有值) "0000"：OBS转自动前呼出成功 "0900"：OBS转人工前呼出成功 "0101"：呼出失败 "-1"：标识当前的任务没有号码可呼 "0601"：退回 2.17 resultCode string 呼叫结果码(预测外呼，预占用外呼时才有值) 失败的原因码对应的外显结果码。外显结果码可以自定义，失败原因码与外显结果码相互关联 2.18 busiResult string 外呼业务结果编码(预测外呼，预占用外呼时才有值) isales前台页面配置，如何配置请参见操作指南 2.19 busiSubStatus string 外呼业务结果子状态编码(预测外呼，预占用外呼时才有值) isales前台页面配置，如何配置请参见操作指南

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

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

响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":113, "groupName":"ceshipostman", "groupType":3, "remark":"此为质检组", "workNos":[50041,50042] } 响应参数： { "returnCode": "0", "resultCode": "0100000", "description": "新增成功", "resultDesc": "新增成功" }

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "statDate": "2022-10-14", "failData": { "01119": 1, "01153": 4, "01169": 2 } }, { "statDate": "2022-10-18", "failData": { "00701": 1 } } ], "resultCode": "0200000", "resultDesc": "query success", "returnDesc": "query 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}/failcategorystatistics?campaignId={campaignId}&startDate={startDate}&endDate={endDate} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId String True 外呼数据ID 3 startDate String False，该字段有值，则endDate必传。 查询开始时间 格式： yyyy-MM-dd 4 endDate String False，该字段有值，则startDate必传。 查询结束时间 格式： yyyy-MM-dd 结束时间-开始时间小于等于30天，

报文样例 请求头 POST /CCFS/resource/ccfs/queryAgentOprInfoData HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:42:49Z/content-length;content-type;host /7a8fb9d620e******************5c5df0cce3c6a253 Accept: */* Host: 10.154.198.164 Content-Type: application/json;charset=UTF-8 Content-Length: 297 请求参数 { "request": { "version": "2.0" }, "msgBody": { "beginTime": "2018-06-29 10:42:49", "endTime": "2018-07-02 10:42:49", "accountId": "", "agentId": "", "callBackURL": "https://10.57.118.171:8000" } } 响应头 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Date: Mon, 02 Jul 2018 02:43:03 GMT 响应参数 { "response": { "version": "2.0", "resultCode": "0", "resultMsg": "success" }, "resultData": { "responseId": "9239cb50a8384bb0ab503441bf089446" }, "resultCode": "0", "resultDesc": "success" } 呼叫中心向回调地址返回的消息示例 消息头 POST / HTTP/1.1 Accept: */* Content-Type: application/json;charset=UTF-8 Authorization: auth-v2/ak/2018-07-02T02:43:03Z/content-length;content-type;host /c5bd683******************ef5747bd572c28 Host: 10.57.118.171 Content-Length: 208 消息参数 { "request": { "version": "2.0" }, "msgBody": { "responseId": "9239cb50a8384bb0ab503441bf089446", "agentOprInfoFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip" } }

响应说明 调用本接口获得响应分为两部分： （1）调用本接口立即得到响应 该响应消息参数说明详见表4。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码， 0：成功 非0：详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据,resultData参数说明详见表6-响应消息resultData参数说明。 4 response Object 请求结果对象，参数说明详见表6 不推荐使用，为兼容老版本保留字段。 表5 响应消息resultData参数说明 序号 名称 参数类型 说明 3.1 responseId String 调用本接口成功后，生成的唯一标识，是文件名称的组成部分。 表6 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码，详见错误码参考。 4.3 resultMsg String 请求结果描述。 （2）平台生成数据记录文件后回调第三方的响应。 该响应由request，msgBody两部分组成。msgBody参数说明详见表7-回调返回消息请求Body中msgBody参数说明。 request包含响应版本号version（默认2.0）。 msgBody由responseId（座席操作详单文件名组成部分），fileName（待下载座席操作详单zip名称），accountId（租间ID）组成。 表7 回调返回消息请求Body中msgBody参数说明 序号 名称 参数类型 说明 1 responseId String 调用本接口成功后，生成的唯一标识，是文件名称的组成部分。 2 fileName String 话单和录音索引文件名称。格式：yyyyMMdd_{responseId}.zip。 例如：调用本接口的日期为2018-07-02，获取到的responseId为9239cb50a8384bb0ab503441bf089446，则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。 3 accountId String 企业帐号（租间ID），请求参数中带的企业账号，用来将文件名和企业进行关联，如果请求参数中未填accountId，则不会返回该值。 若回调没有成功（ccfs没有收到回调地址的成功响应，或没有响应体），ccfs会重试，间隔10分钟重试一次，直到成功或者超过重试次数。

请求说明 表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 beginTime String True 无 座席相关操作的起始时间，为租间所在时区的时间，起始时间和截止时间需要做范围限制，最大为3天内。格式为：yyyy-MM-dd HH:mm:ss。 2 endTime String True 无 座席相关操作的截止时间，为租间所在时区的时间，起始时间和截止时间需要做范围限制，最大为3天内。格式为：yyyy-MM-dd HH:mm:ss。 3 accountId String（1-20） False 无 企业帐号（租间ID）。 4 agentId String（1-20） False 无 座席ID（座席工号）。 5 callBackURL String True 无 回调地址。平台生成数据记录文件后将fileName返回到该地址。

使用说明 前提条件 开发者环境已经构建，座席正常签入并进行相关操作，开发者有独立服务器并且已经绑定回调地址（callBackURL）。 企业帐号（accountId：租间ID）、座席ID（agentId），可自由组合生成座席操作详单索引文件。如果均没有传入，则生成指定时间段内该appId下相应的数据记录。 已通过鉴权（Authorization）、获取接入地址。 请检查CC-FS配置文件“/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties”的“aicc.ssl.trustAll”是否配置为false，请配置为false，然后参考下面步骤放置证书。 以运维用户登录CC-FS的服务器，切换到root用户下。 su - root 将CC-FS生成索引文件通知回调地址加载的第三方证书上传至AICC的truststore.jks证书的同一目录中，目录为：“$HOME/conf”，具体目录请以实际环境为准。 修改上传的第三放证书的属组。 chown ccfsapp:ccfsapp XXX.jks 执行下面的命令将第三方证书导入到truststore.jks中。 keytool -import -alias xxx -file XXX.jks -keystore truststore.jks 请依据界面提示输入truststore.jks证书密码。 在环境上删除XXX.jks证书。 重启CC-FS。 进入“/home/ccfsapp/bin”目录，执行如下命令。 ./shutdown.sh;./startup.sh 使用限制 开发者只能访问该帐号下的数据信息，开发者帐号（appId）和企业帐号（accountId）必须对应。 开发者账号包含在认证字符串中，详见C2 监控/系统外呼/话单/知识库类接口鉴权方式。

基本信息 给第三方接入方调用，实现文本分类、实体识别能力，可应用于智能座席助手的智能工单分类、智能填单场景。智能座席助手，通过调用文本分类接口进行完整的工单分类；通过调用实体识别接口，提取工单信息中的工单实体，完善工单；进一步增强智能座席助手的能力。 对接Customer Service Platform系统时，采取Headers头部的userName+token组合鉴权方式，其中userName为ipcc，token获取方式参见C3 智能助手平台接口鉴权方式。 对接其他第三方系统，采取请求体的authToken鉴权方式。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "EID": "8888*", "limit":"100", "offset":"0" } 响应参数： { "resultCode": "0100000", "resultDesc": { "data": { "10.xx.xx.xx#1": [ { "socketStatus": "uninstall", "terminationType": "sip", "ipAndPort": "0.0.0.0:0", "ccuModuleNumber": "56", "registerStatus": "not register", "monitorFlag": "unstarted", "protocolType": "invalid protocol", "equipmentId": "88881757", "roamIpAndPort": "0.0.0.0:0", "tlsStatus": "uninstall", "ipType": "IPv4" } ], "10.xx.xx.xx#2": [ { "socketStatus": "uninstall", "terminationType": "sip", "ipAndPort": "0.0.0.0:0", "ccuModuleNumber": "56", "registerStatus": "not register", "monitorFlag": "unstarted", "protocolType": "invalid protocol", "equipmentId": "88881757", "roamIpAndPort": "0.0.0.0:0", "tlsStatus": "uninstall", "ipType": "IPv4" } ] }, "count": 1 } }

响应消息 表3 响应消息体参数说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDesc List 查询成功后，返回结果信息的对象列表。 该数组中对象的参数说明请参见下表。 10.xx.xx.xx#1 String 10.xx.xx.xx：UAP IP “#”：固定分隔符 “1”：UAP编号 表4 resultDesc对象参数说明 参数名 数据类型 说明 data list 数据结果集 count int 总记录数 表5 data对象参数说明 参数名 数据类型 说明 ccuModuleNumber string CCU模块号 terminationType string 终端类型 equipmentId string 设备标识 registerStatus string 注册状态：registered 已注册 not register 未注册 socketStatus string SOCKET状态： fault 故障 normal 正常 connecting 连接中 uninstall 未配置 ipAndPort string ip和Port monitorFlag string 座席状态监控标志： unstarted 未启动 started已启动 protocolType string 协议类型 roamIpAndPort string 漫游ip地址和端口 tlsStatus string TSL状态：unconnect 未连接 connect 连接 uninstall 未配置 ipType string ip类型

报文样例 场景描述：连接机器人 请求参数: { "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": "{\"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. 其他非零错误请参见《CCUCS接口开发指南》中的错误码参考。 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；如果是音视频等媒体，content是fileId，mediaType，fileId为/ccmessaging/uploadFileStream接口返回的objectKey，具体入参为"field，mediaType"，如图片为"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格式数据，连接机器人的时候传给机器人流程。