华为云用户手册

云客服-查询满意度调查配置（getSatisfactionSurveyMode）:报文样例

报文样例场景描述：创建外呼任务请求头： { "X-APP-Key": "b*************c7b", "Authorization": "Bearer 1fea*************1d6a15", "Content-Type": "application/json" } 请求参数无。响应参数： { "satisfactionSurvey": { "surveyType": "WEB", "satisfactionLevel": [ { "satisfactionLevelDesc": "很不满意", "satisfactionLevelKey": "1" }, { "satisfactionLevelDesc": "不满意", "satisfactionLevelKey": "2" }, { "satisfactionLevelDesc": "一般", "satisfactionLevelKey": "3" }, { "satisfactionLevelDesc": "满意", "satisfactionLevelKey": "4" }, { "satisfactionLevelDesc": "很满意", "satisfactionLevelKey": "5" } ] }, "resultCode": "0", "resultDesc": "Get satisfaction survey mode success!" }

云客服
云客服-查询外呼业务结果定义列表:报文样例

报文样例该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "code": "11111", "children": [ { "code": "12324", "name": "sub02", "defLevel": "2" }, { "code": "1232", "name": "sub01", "defLevel": "2" } ], "name": "test111", "defLevel": "1" }, { "code": "test", "children": [], "name": "test0903", "defLevel": "1" }, { "code": "15105671", "children": [ { "code": "754646", "name": "通话中断", "defLevel": "2" }, { "code": "ob-12", "name": "多个地方官", "defLevel": "2" } ], "name": "失败4up", "defLevel": "1" } ], "resultCode": "0200000", "resultDesc": "queryBusinessResults Success!", "totalCount": 3, "returnDesc": "queryBusinessResults Success!" }

云客服
云客服-查询外呼业务结果定义列表:错误结果码

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

云客服
云客服-查询外呼业务结果定义列表:响应说明

响应说明表3 消息体参数说明序号参数名参数类型说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。具体见表6。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。具体见表6。 4 returnDesc String 描述。 5 data JSONArray 结果json，详见表4。 6 totalCount Long 返回列表中结果总条数。表4 data参数说明序号参数名参数类型说明 5.1 name String 业务结果名称。 5.2 code String 业务结果编码。 5.3 defLevel String 业务结果层次（1表示父业务结果，2表示子业务结果）。 5.4 children List 子业务结果。该对象的参数说明请参见表5。表5 children参数说明序号参数名参数类型说明 5.4.1 name String 子业务结果名称。 5.4.2 code String 子业务结果编码。 5.4.3 defLevel String 业务结果层次（1表示父业务结果，2表示子业务结果）。

云客服
云客服-查询外呼业务结果定义列表:接口URI

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

云客服
云客服-预览外呼:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "called": "88889039", "callcontrolid": "11776" } 响应参数 { "message": "", "retcode": "0", "result": "1455885056-1095" }

云客服
云客服-预览外呼:接口URI

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/previewCallout 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服
云客服-预览外呼:请求说明

请求说明消息头表2 请求头参数说明序号名称参数类型是否必选说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。消息体表3 消息体参数说明序号名称参数类型是否必选说明 1 called string True 被叫号码。called必须包含在预览事件的dialeddigits字段中，不在此字段中的号码，不能呼叫。 2 callcontrolid long True 预呼控制块号。callcontrolid是预览外呼事件中的controllid。

云客服
云客服-删除人工复核任务:报文样例

报文样例场景描述：删除人工复核任务。请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "qualityTaskId": "16239245027406915901" } 响应参数: { "resultCode": "0409000", "resultDesc": "操作成功" }

云客服质检任务接口 (qualitytask)
云客服-删除人工复核任务:响应说明

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

云客服质检任务接口 (qualitytask)
云客服-删除人工复核任务:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string True 操作员标识可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数序号名称参数类型是否必选说明 1.1 qualityTaskId number True 任务ID

云客服质检任务接口 (qualitytask)
云客服-主席申请延长会议时间:接口URI

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/prolongtime 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服
云客服-主席申请延长会议时间:响应说明

响应说明表4 消息体参数说明序号名称参数类型说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功非0：失败 3 result map 请参考表5 表5 实际增加的时间序号名称参数类型说明 3.1 applyedTime int 实际增加的时间。单位：分钟。取值范围：1～1440。 applyedTime时间有可能小于{prolongTime}，原因是{prolongTime}加上会议已用时间大于1440分钟。

云客服
云客服-主席申请延长会议时间:请求说明

请求说明消息头表2 消息体参数说明序号名称参数类型是否必选说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。消息体表3 消息体参数说明序号名称参数类型是否必选说明 1 prolongTime Integer True 会议延长的时间。单位：分钟。取值范围：1～1440。

云客服
云客服-主席申请延长会议时间:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "prolongTime": 100 } 响应参数 { "result": { "applyedTime": 50 }, "message": "success", "retcode": "0" }

云客服
云客服-取得敏感词列表:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数序号名称参数类型是否必选说明 1.1 page number True 页码 1.2 limit number True 每页数量取值范围：5, 10, 20, 50， 100 1.3 keyword string False 敏感词名称的关键字

云客服
云客服-取得敏感词列表:报文样例

报文样例场景描述：取得敏感词列表的接口。请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "page": 1, "limit": 10, "keyword":"更改" } 响应参数: { "data": [ { "category_id": "1065038086678777856", "sw_id": "1067229455178534912", "sw_name": "更改敏感词名称766" }, { "category_id": "1071491122737451008", "sw_id": "1071495709510864896", "sw_name": "更改敏感词名称131" } ], "resultCode": "0401000", "paging": { "total": 2 }, "resultDesc": "操作成功" }

云客服
云客服-取得敏感词列表:响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1.1 paging object False 分页信息对象 1.1.1 total number False 查询结果总数 1.2 data array[object] False 查询结果记录 1.2.1 sw_id string False 敏感词唯一标识 1.2.2 sw_name string False 敏感词名称 1.2.3 category_id string False 敏感词分类的唯一标识 1.3 resultCode string False 返回码 0401000 表示成功其他表示失败 1.4 resultDesc string False 返回描述响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的路径未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-H5接入信息事件

H5接入信息事件标示符 AgentEvent_RequestConnect 作用表示上报H5接入信息事件附带信息 workNo：座席号。 content：消息对象，JSON格式。包含字段如下： callid：呼叫标识。 userId：坐席工号。 ctime：过期时间。 channelId：频道ID（房间ID）。 role：角色。 ip：媒体服务器接入点IP地址。 port：媒体服务器接入点端口。 signalingDomainIn：内侧信令domain。 signalingDomainOut：外侧信令domain。 locationId：节点。 signature：签名。 appId：用户标识。示例： {"message":"","retcode":"0","event":{"eventType":" AgentEvent_RequestConnect","workNo":"49999","content":{ "userId": "坐席工号","ctime": "过期时间","channelId": "15945185-345","appId": "8345234631", "ip": "xxx.xxx.xxx.xxx","port": "6500","role": "0","signalingDomainIn": "https: //in.isdpdomain.com","signalingDomainOut": "https: //out.isdpdomain.com","locationId": "65535","signature": "xxx","appId": "sdcp0BPcVGymItWppGX6XqrZGTCYa13d"}}} 父主题：多媒体事件

云客服多媒体事件
云客服-座席心跳接口:报文样例

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

云客服
云客服-座席心跳接口:请求说明

请求说明消息头表2 请求头参数说明序号名称参数类型是否必选说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid 动态鉴权（AUTHMODE = 2）座席心跳接口返回header中的Guid。 3 service_token string False 自定义，最大长度为50，不能包含特殊字符，否则会返回100-001，建议1分钟动态刷新一次。消息体无

云客服
云客服-座席心跳接口:接口URI

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/handshake 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服
云客服-创建语音外呼（V2.0.0）（createVoiceNotification）:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）表2 请求体参数序号名称参数类型是否必选说明 1 called string True 外呼被叫号码长度限制:string(32) 2 playList array[object] True 数组长度：1-5 2.1 voiceId string False 录音id（voiceId，voiceFileName，templateId必须填写1个） 2.2 voiceFileName string False 录音文件名（voiceId，voiceFileName，templateId必须填写1个） 2.3 templateId string False 模板id（voiceId，voiceFileName，templateId必须填写1个） 2.5 templateParams array[string] False 数组长度：1-10 长度限制:string(32) 3 callBackUrl string False 回调URL 长度限制:string(256) 回调URL的域名或IP端口已通过系统管理员加入手机客服回调的地址白名单中。 4 callerPresent string False 用户侧主叫外显号码长度限制:string(32) 5 playTimes number False 播放次数范围：1-5 6 priority string False 播放语音通知优先级参数。取值范围1-9整数，默认值为9。数字越小优先级越高。

云客服
云客服-创建语音外呼（V2.0.0）（createVoiceNotification）:响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1.1 retCode string False 返回码。0表示成功，其他为失败。 1.2 retMsg string False 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo string False 呼叫流水号响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-创建语音外呼（V2.0.0）（createVoiceNotification）:报文样例

报文样例请求头： x-app-key:9******************************3 Authorization:Bearer 9******************************7 请求参数: { "called": "8899", "playList": [ { "voiceId": "100001", "templateParams": [ "100", "200" ] } ], "playTimes": 1, "callerPresent": "2222201", "callBackUrl": "http://xx.xx.xx.xx:8800/callbackTest" } 响应参数: { "retMsg": "Created successfully.", "retCode": "0", "result": {"callSerialNo": "1308434073450058757"} }

云客服
云客服-删除接入码与技能队列、IVR绑定关系（deleteCalledRoute）:报文样例

报文样例请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "dnids": "1,2" } 响应参数: { "returnCode": "0", "data": { "name": "9911411,99114111", "id": "1127983948544239618,1127986019188238339", "content": "9911411,99114111" }, "description": "data delete success" }

云客服号码管理
云客服-删除接入码与技能队列、IVR绑定关系（deleteCalledRoute）:响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1.1 returnCode string False 返回码 0：成功其他：失败 1.2 description string False 描述 1.3 data object False 删除情况展示 1.3.1 id string False 删除的绑定数据id 1.3.2 name string False 删除的绑定数据"accessCode"+"extCode" 1.3.3 content string False 删除的accessCode 1、全部删除成功或者全部删除失败时，和name一样 2、部分删除成功时，字符串结构为"Success:"+"同name一样"+"，Failed:"+"同name一样" 响应状态码: 400 错误的请求：请检查请求路径及参数响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。响应状态码: 403 鉴权失败响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服号码管理
云客服-删除接入码与技能队列、IVR绑定关系（deleteCalledRoute）:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）表2 请求体参数序号名称参数类型是否必选说明 1.1 dnids string True 配置编号(查询被叫时返回的dnid); 删除多个用，隔开；最大删除数1000

云客服号码管理
云客服-第三方上传文件:接口URI

接口URI https://ip:port/CCFS/resource/ccfs/ivr/uploadFile?vdnId={vdnId} 其中，ip为CC-FS安装的服务器IP地址，port为CC-FS的HTTPS端口号。如果经过NSLB路由，ip为NSLB的服务器IP地址，port为CC-FS服务在NSLB映射的HTTPS端口号。表1 URL中携带的参数说明序号名称参数类型是否必选说明 1 vdnId int True 虚拟呼叫中心 id。

云客服数据访问接口
云客服-第三方上传文件:报文样例

报文样例请求头 POST /CCFS/resource/ccfs/ivr/upload?vdnId=xx HTTP/1.1 Authorization: auth-v2/ak/2021-08-31T09:38:50.872Z/content-length;content-type;host/c12f0ed******************941bdd106 Accept: */* Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "data":"base64" } } 响应参数 { "resultData": { "fileName": "Y:/3rdfile/53/thirdvoicebotfile/8fSsBaEb_1631869974029.wav", "locationId": [ "0", "256" ] }, "resultCode": "0", "resultDesc": "success" }

云客服数据访问接口

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线