华为云用户手册

报文样例 请求头: ccmessaging-token:eyJjcmVhdG*************NzIxMTc4 Authorization:Bearer dbb0*************bbb33a x-app-key:6e9d9c*************152c2f6 Content-Type:application/json 请求参数: {"channel": "WEB"，"mediaAbility": "0"} 响应参数: {"resultCode": "0"，"resultDesc:": null}

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

报文样例 请求头: ccmessaging-token: x-app-key: Authorization: 请求参数: 无 响应参数: { resultCode: "0"，resultDesc: "Call connected"，"eventId": 168101，"content": {"domain": "xxx""gwAddresses": ["xx1"， "xx2"]"accessCode": "179080000537636""clickToCallCaller": "AnonymousCard"}}

请求说明 表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 resultCode string False 响应结果码 1.2 resultDesc string False 响应结果描述。 如果resultCode返回0：Call in queue或Call connected或Call disconnected或Call queued timeout或Call failed或Call continue to poll events with unknown events或ClickToCall polled without any events 1.3 eventId string False 事件编号 1.4 content object False 事件内容 1.4.1 causeDesc string False 原因描述 1.4.2 causeId string False 原因 id 1.4.3 accessCode string False 点击通话被叫 1.4.4 domain string False WebRTC Gateway域名 1.4.5 gwAddresses array False WebRTC Gateway通信地址和端口 1.4.6 clickToCallCaller string False 点击通话主叫 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 响应结果码 1.2 resultDesc string False 响应结果描述。 如果resultCode返回0：成功 如果resultCode返回13：disconnect failed 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 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后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 channel string True 接收者渠道类型（WEB）

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

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

请求说明 表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后有空格）

报文样例 场景描述：创建外呼任务 请求头: {"X-APP-Key": "b*************c7b"，"Authorization": "Bearer 1fea*************1d6a15"，"Content-Type": "application/json"} 请求参数: {"called": "88884432"，"callData": "1"，"callerPresent": "95599"} 响应头: connection: keep-alive content-encoding: gzip content-length: 130 content-type: application/json;charset=UTF-8 date: Wed， 12 May 2021 08:52:40 GMT server: openresty 响应参数: {"resultCode": "0"，"resultDesc": "Success"，"resultData": {"sipServiceAddress": "10.137.203.215:5063"，"accesscode": "179080024609291"}}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string True 接口返回码。 0：成功，其他为失败 30010000001：没有开通此特性，无法使用 30010000002：没有查到SIP Server 信息 30010000003：入参校验失败 30010010001：添加外呼任务失败 30010010002：VDN不可用 30010010003：VDN配置异常，Record Path生成失败 30010019999：CCM其他异常 30011010001：创建呼叫失败，未等到呼叫建立成功事件 30011019999：CCUCS其他异常 30010009999：Chat模块异常 1.2 resultDesc string False 失败原因描述 1.3 resultData object False 响应消息结构体 1.3.1 callSerialNo string(50) False 呼叫流水号 1.3.2 sipServiceAddress string True sip服务地址，ip:port 1.3.3 accesscode string True 用于VOIP匿名呼叫，接入码+uvid 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 called string(32) True 被叫号码 1.2 callData string(1，024) False 呼叫数据 1.3 callerPresent string(32) True 主叫显示号码，用户和客户经理看到的主叫号码，不携带的情况下，采用平台默认的主叫号码

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string True appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody object True - 1.1 offset integer False 起始游标，即分页查询时的起始记录行号。 首次查询传入“0”。 后续查询其他分页时传入该分页的第一条记录的序号。返回记录中第一条记录序号为“0”，后续依次排序。例如每页为50条录，查询第二页时应传入“50”。 不传时默认0，无最大值限制 1.2 limit integer False 分页查询时的每页记录数，正整数，不传时默认100，最大值100，传入超过100的值也会转换为100 1.3 type integer False 录音文件类型 0：音频，2：text文本

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 返回码，0：成功，其他失败（1：请求参数type不正确） 1.2 description string False 返回描述 1.3 voiceInfo object False 录音信息 1.3.1 tenant_id string True 租户id 1.3.2 uploaddate number True 上传时间，格式为timestamp 1.3.3 voice_id string True 录音id 1.3.4 name string True 录音名称 1.3.5 voicecontent string False 语音内容 1.3.6 type number True 类型 0：音频，2：text文本 1.3.7 tenantSpaceName string False 租户名称 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: {"Content-Type": application/json"x-app-key": ********************"Authorization": Bearer ************************} 请求参数: { "offset":0， "limit":10， "type":2} 响应参数: { "returnCode": "0"， "description": "query success"， "voiceInfo": [ { "tenant_id": "20******234"， "uploaddate": 163*****4000， "voice_id": "113379*********9999"， "name": "welcome"， "voicecontent": "{\"0\":{\"languageId\":\"0\"，\"textcontent\":\"欢迎光临\"}}"， "type": 2， "tenantSpaceName": "************" }， ]}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string True 响应返回码 1.2 resultDesc string False 响应返回描述。 如果resultCode返回0：无返回或Save leaveMessage success! 如果resultCode返回3：the leaveMessageParams is error. 如果resultCode返回13：Exception appeared!或Save leaveMessage failed! 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: ccmessaging-token: x-app-key: Authorization: 请求参数: {"callId": "111111222111"，"caller": "138****7777"，"leaveMessage": "请回复电话"，"channel": "WEB"} 响应参数: {"resultCode": "0"，"resultDesc": "Save leaveMessage success!"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 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后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 callId string True 用户ID 1.2 caller string True 留言号码 1.3 leaveMessage string True 留言信息 1.4 channel string True 渠道名称，WEB

报文样例 请求头: {"ccmessaging-token": "eyJjcmVhdGV*************2hhbm5lbElkIjoiMjAyMTAyMTkzMTk2ODY5NzA4In0%3D"，"x-app-key": "ea5c29a3*************a3dbeb4c32c"，"Authorization": "Bearer 57042f*************968c4e0"，"Content-Type": "application/json"} 请求参数: {"feedback": 0，"feedbackContent": "dissatisfied"，"from": "1111111"，"interIdx": "2"} 响应参数: {"resultCode": "0"，"resultDesc": "Send message to robot successfully"}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string True 0：成功 30000000008：满意度调查时，不满意情况下，feedbackContent不允许未空 10010000002：接口流控失败 30010009999：Chat模块异常 30000000019：当前会话不是机器人会话或当前没有会话时不支持评价机器人 10010000001：接口认证失败 1.2 resultDesc string False 失败原因描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 ccmessaging-token string True applyToken接口生成的ccmessagign-token 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 feedback integer True 反馈的满意度。 1：满意，0：不满意 1.2 feedbackContent string(64) False 当为0，不满意时，不允许为空，最大长度限制64字符 1.3 from string True 消息发送方的id 1.4 interIdx string True 交互次数，直接取上一次ODFS返回的interidx值即可。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 retCode string True 返回码。 0 成功 1 有未完成的任务，请稍后重试 2 callData长度超出1024 3 创建失败，未生成呼叫流水号 4 softPhone格式与规则不匹配 5 caller或者called未传递，或者格式与规则不匹配 6 vdn未启用 7 callerPresent或者agentPresent校验失败 8 voiceContent为空或者超出限制或者不存在该录音数据 9 callBackUrl不符合条件 16 租户为试商用状态，被叫号码不在白名单中。 36 priority字段值格式不符合要求 1.2 retMsg string False 返回描述 1.3 result object False retCode为0时，必返回 1.3.1 callSerialNo string True 呼叫流水ID 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string True appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody object True - 1.1 voiceContent string True 总长度限制1000字符。 支持传录音id，录音id以"~"分隔，录音id可以通过/rest/voiceNotification/v1/queryVoiceNotificationRecording接口查询。若您是通过客户服务云界面上传的语音文件，录音id即为IVR语音界面的“语音标识”。 支持传纯文本，格式为：$文本$，以"~"相连，例如："$李先生$~$王先生$"。 支持传录音id与文本混合，格式为：录音id~$文本$~录音id，例如："1133*********999~$李先生$~2225*********149"。 1.2 callerPresent string False 用户侧主叫显示号码，用户看到的主叫号码，不携带的情况下默认采用租间的接入码，携带的情况下该号码必须传接入码。如果需要传非接入码号码，请联系运维人员开通主叫透显特性，该特性开通后号码校验规则为：接入码或者11-14位的数字。 1.3 called string True 被叫号码 1.4 callBackUrl string False 此参数请采用BASE64编码以UTF_8标准字符集进行编码。 此字段用于设置客户接收状态上报的URL。 云客服CEC平台将业务触发过程中通话的状态信息推送至此服务器，客户服务器根据通话状态信息确定用户状态。 URL可填写为https://IP:Port或域名，推荐使用域名，支持http和https。该域名可以对应多个服务器，避免单点故障无法接收通知。 http有安全风险，不推荐使用。 URL只能由大小写字母（a-z、A-Z），数字（0-9）， - : . / _ # ? &组成，不支持其它字符。 1.5 priority string False 播放语音通知优先级参数。 取值范围1-9，默认值为9。 数字越小优先级越高。

报文样例 请求头: {"Content-Type": application/json"x-app-key": *****"Authorization": Bearer ****} 请求参数: { "voiceContent": "1133*********999~$李先生$~2225*********149", "callerPresent": null, "called": "88880000"} 响应参数: { "result": { "callSerialNo": "11827********7090" }, "retCode": "0", "retMsg": "Created successfully."}

响应消息 该接口的响应消息体举例如下： { "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，详见表3 data参数说明 表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 错误原因码说明 错误码 说明 0200001 参数异常，异常详情在resultDesc中描述。 0200007 通话记录ID不存在。

报文样例 场景描述：查询历史消息 URL：请求成功报文 请求头: {"ccmessaging-token": "eyJjcmVhdGVUaW1lIjoxNjIyNjI2Mjc3NDA4LCJ0ZW5hbnRJZCI6IjIwMjEwMjE5MzE5NiIsInJhbmRvbU51bWJlciI6IjZDRjEyOTE0OTQ3QzY1NzUwRUI4RDRBNENDODZEQTJGRTE4RjhBOTVERjcwMzA1QyIsIm1hcFNlcnZpY2UiOiJudWxsIiwidXNlck5hbWUiOiIyMzEyMzIxIiwibG9jYWxlIjoiemgiLCJ1c2VySWQiOiIxMTExMTExIiwiY2hhbm5lbElkIjoiMjAyMTAyMTkzMTk2ODY5NzA4In0%3D","x-app-key": "ea5c29a3-ea45-4b79-a449-2a3dbeb4c32c","Authorization": "Bearer 57042f85aeabd63562f2e8339968c4e0","Content-Type": "application/json"} 请求参数: { "channelId":"202207292843442389", "userId":"1659490221026188522", "limit":"1", "offset":"0", "startTime":"1659910093000", "endTime":"1659938956000", "channel":"WEB"} 响应参数: { "messageList": [ { "id": "10113293212986888", "channel": "WEB", "senderNickname": "wangming77", "senderAvatar": "../../image/user1.png", "sendTime": 1659938956000, "receiveTime": 1659938956000, "controlType": "CHAT", "sourceType": "USER", "mediaType": "FILE", "content": "diaoyu.aac,26964,fee53aad-94a0-4dc2-b7ff-fd8c2e2496f2,aac", "callId": "1659938875-16806492", "messageCode": "67A257B0DB5EFBC08C9F2BD612443F09BBF858570A62CCAAB8D3CE45B7C0EFD0", "associationContentId": null, "sendStatus": null, "errorMsg": null, "isForwarded": false, "forwardTime": null, "contentDealType": null } ], "resultCode": "0", "resultDesc": "success"}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 messageList array True 查询到的历史消息集合 1.1 resultCode string True 0：成功 1：失败 1.2 resultDesc string True 响应返回描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 ccmessaging-token string True applyToken接口生成的ccmessaging-token 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 channelId string True 渠道标识 1.2 userId string True 渠道下发送消息的用户ID 1.3 startTime string False 查询历史消息开始时间 1.4 endTime string False 查询历史消息结束时间 1.5 limit string True 分页参数，查询历史消息数量 1.6 offset string True 分页参数，偏移量

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string False 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accountCode string(64) True 登录账号，最长64个字符串 1.2 password string(64) False 鉴权用户密码，最长64个字符串 1.3 username string(64) False 鉴权用户名，最长64个字符串