华为云用户手册

云客服-对话标识绑定查询接口:请求说明

请求说明表1 消息体参数参数名称数据类型参数位置必选/可选描述 tenantId String body True 租户ID accessCode String body False 接入标识,如果不传，则查询租户下所有绑定关系；如果传入，则需要传参数页码pageNum和每页条数pageSize 不超过20位 pageNum String body True 页码分页查询，查询第几页，首页为1 pageSize String body True 每页多少条 [5,10,20,50,100] authToken String body True 认证token。请参见C3 智能助手平台接口鉴权方式。 source String body False 发起对话识别的源设备。 IVR：来自IVR流程 OIFDE：表示来自ODFS配置的智能化流程如果不传该字段，默认查询IVR 不超过64位

云客服对话标识绑定类接口
云客服-连接保持:接口URI

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

云客服
云客服-静音

静音标示符 AgentEvent_linkagePhoneMute 作用表示某个呼叫被话机静音。附带信息 callId：表示被静音的呼叫的唯一标记。示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneMute","workNo":"120","content":{"callId":"1474269843-24"}}} 父主题：话机联动事件

云客服
云客服-训练模组:请求说明

请求说明表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

云客服句子、敏感词训练接口 (SemanticKeywordTraining)
云客服-训练模组:响应说明

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

云客服句子、敏感词训练接口 (SemanticKeywordTraining)
云客服-训练模组:报文样例

报文样例场景描述：训练模组请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 响应参数: { "resultCode": "0404000", "resultDesc": "操作成功" }

云客服句子、敏感词训练接口 (SemanticKeywordTraining)
云客服-查询App个人设置 (query):响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1 id string False 主键id 2 callType string False 呼叫类型 0：直呼 1：双呼 2：透显呼叫 3 callerPresent String[] False 被叫显示号码。最多5个，多个号码之间以，隔开每个号码长度限制：string（15） 4 callNumber String[] False 坐席软电话号码。最多5个，多个号码之间以，隔开每个号码长度限制：string（15） 5 userId String False 用户id t_aicc_pub_appcube_user表中SUM_USER_ID的值。 6 callNumberDefault String False 默认坐席绑定的软电话号码。长度限制：string（15） 7 callerPresentDefault String False 被叫默认显示号码。长度限制：string（15） 8 agentName String False 坐席绑定的业务帐号。 9 returnCode string True 0：成功其他值表示失败 10 returnDesc string False 响应结果描述。 11 createTime string False 配置创建时间 12 partdbId string False 分区id 13 tenantId string False 租间id 响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服 App个人设置
云客服-查询App个人设置 (query):报文样例

报文样例请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: { "userId": "10gg000000y6OOrNaUFs" } 响应头: { "connection": "keep-alive", "content-type": "application/json;charset=UTF-8" } 响应参数: { "returnCode": "0", "callNumber": [ "12323", "232343", "233", "239343" ], "callerPresent": [ "12323" ], "callNumberDefault": "23232323", "agentName": "y111", "id": "1307145259662215169", "userId": "10gg000000y6OOrNaUFs", "callerPresentDefault": "1212121212", "returnDesc": "query success", "callType": "1" }

云客服 App个人设置
云客服-查询App个人设置 (query):请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）表2 请求体参数序号名称参数类型是否必选说明 1 userId String True 用户id。 t_aicc_pub_appcube_user表中USER_ID的值。

云客服 App个人设置
云客服-删除质检评分设置档:报文样例

报文样例场景描述：删除质检评分设置档。请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "id": "1828287446" } 响应参数: { "resultCode": "0412000", "resultDesc": "操作成功" }

云客服质检评分接口 (scoresetting)
云客服-删除质检评分设置档:请求说明

请求说明表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 id string True 设置档唯一标识

云客服质检评分接口 (scoresetting)
云客服-删除质检评分设置档:响应说明

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

云客服质检评分接口 (scoresetting)
云客服-修改座席软电话号码登录密码（updateSipPhonePassword）:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 x-app-key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）表2 请求体参数序号名称参数类型是否必选说明 1 requestParam object True 请求参数 1.1 accountPwd string True 座席当前密码，修改软电话密码时需要校验座席当前密码，如果校验失败三次，会锁账号，当前会在30分钟后解锁，也可以登入租户管理员账号人工解锁。 1.2 newPhonePwd string True 新软电话密码，长度8-16位（默认密码规则组），默认需要提供以下三种的任意组合：大写字母、小写字母、数字和特殊字符。特殊字符支持 ~@^*_+.? 1.3 userAccount string True 座席账号

云客服
云客服-修改座席软电话号码登录密码（updateSipPhonePassword）:响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1 schema object True 请求成功 1.1 resultCode string True 请求成功为0，请求失败为1 1.2 resultMessage string False 请求失败，resultCode为1时会携带具体原因响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-查询账号登录结果 (queryAgentLoginParams):报文样例

报文样例请求头: "x-app-key":"e******************************a" "Authorization":"Bearer e******************************8" "Content-Type":"application/json;charset=UTF-8" "Connection":"keep-alive" 请求参数： { "account": "ls120201", "password": "S*****x" } 响应参数： { "returnCode": "0", "results": { "sipServerInfo": [{ "sipServiceIp": "10.10.10.11", "sipServicePort": "33", "type": "0" }], "password": "11****8Q", "sipAccount": "88887818", "workNo": "1516" }, "message": "verify Account or password success." }

云客服
云客服-查询账号登录结果 (queryAgentLoginParams):请求说明

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

云客服
云客服-查询账号登录结果 (queryAgentLoginParams):响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1.1 message string(1024) False 账号校验信息 1.2 returnCode string(10) False 账号校验返回码 0：成功 1：失败 1.3 results object False 查询结果表4 Results参数结构序号名称参数类型是否必选说明 1.1 workNo string(5) False 座席工号 1.2 password string(100) False 座席签入登录平台的加密前密码 1.3 sipAccount string(24) False SIP软电话号码 1.4 sipPwd string(100) False SIP软电话加密前密码 1.5 sipServerInfo array[SIPServerInfo] False SIP服务信息表5 SIPServerInfo参数结构序号名称参数类型是否必选说明 1.1 sipServiceIp string(50) False 软电话注册地址 1.2 sipServicePort string(5) False 座席登录服务端口 1.3 node string(10) False sip服务节点 1.4 type string(10) False sip服务类型，默认SIP 0：SIP 1：WebRTC 响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-座席进入Talking

座席进入Talking 标示符 AgentEvent_Talking 作用表示某个座席进入Talking状态。附带信息 called：被叫号码。 caller：主叫号码。 callid：呼叫标示。 type：呼叫媒体类型，协助呼叫(assistant)和主呼叫(main)。 feature：呼叫类型，请参考呼叫类型。 mediaAbility：媒体能力，1表示语音，3表示音视频，5表示文字，6表示H5视频。示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Talking","workNo":"49999","content":{"caller":"10086","callid":"1456401416-3","called":"70092","feature":"7","type":"main","mediaAbility":"1"}}} 父主题：音视频通话事件

云客服
云客服-批量查询所有座席的呼叫信息:响应消息

响应消息表3 消息体参数说明序号名称参数类型说明 1 result String 查询结果。取值如下： 0：成功其他：失败失败的原因说明请参见错误码参考。说明：当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功其他：失败失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。该数组中对象的参数说明请参见表4。说明：当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。该数组中对象的参数说明请参见表4。表4 resultDesc/resultDatas对象参数说明序号名称参数类型说明 2.1 agentId int 座席工号。 2.2 callList array 呼叫信息数组。该对象的参数说明请参见表5 表5 callList对象参数说明序号名称参数类型说明 2.2.1 callId string 呼叫ID。 2.2.2 callStatus int 呼叫状态，表6 2.2.3 callInOut int 呼入与呼出的标记。 0：表示呼入，1：表示呼出 2.2.4 mediaType int 媒体类型，表1 表6 呼叫状态编号呼叫类型描述 0 IDLE 呼叫对象空闲（无呼叫） 1 OCCUPY 呼叫对象被占用 2 QUEUE 呼叫在技能队列排队 3 PRIVATE_QUEUE 呼叫在私有队列排队 4 ALERTING 呼叫振铃等待应答 5 TALK 呼叫各方在通话或交互中 6 HOLD 呼叫保持 7 SUSPEND 呼叫挂起 8 MUTE 呼叫被静音 9 TRITALK 三方通话

云客服
云客服-批量查询所有座席的呼叫信息:样例报文

样例报文请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "agentIds":[1031,1099] } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "agentId": 1034, "callList": [] }, { "agentId": 1099, "callList": [ { "callId": "1605494261-1449", "callStatus": 5, "callInOut": 0, "mediaType": 5 } ] } ], "resultDesc": [ { "agentId": 1034, "callList": [] }, { "agentId": 1099, "callList": [ { "callId": "1605494261-1449", "callStatus": 5, "callInOut": 0, "mediaType": 5 } ] } ] }

云客服
云客服-批量查询所有座席的呼叫信息:请求说明

请求说明表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 agentIds array True 座席工号的数组，数组最大长度为3000。取值范围：101-59999

云客服
云客服-修改质检件评分结果:响应说明

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

云客服质检申诉接口 (qualityitem)
云客服-修改质检件评分结果:报文样例

报文样例请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "qualityItemId": 16239231508327803347, "qualityItemType": 2, "isGroup": false, "ruleType": 11, "uuid": "fcbd13e7-ede6-4150-8f20-1867261f313c", "ruleInfo": { "reviseId": "silenceRule2ad54b75-7823-45f6-8117-d920510f7195", "revise": 0, "description": "111" } } 响应参数: { "resultCode": "0410000", "resultDesc": "操作成功" }

云客服质检申诉接口 (qualityitem)
云客服-修改质检件评分结果:请求说明

请求说明表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 isGroup boolean False 是否为关联通话，true.关联通话，false.普通通话 1.2 qualityItemId string False 质检件标识 1.3 qualityItemType number False 质检件类型（1 问题件，2 申诉件） 1.4 ruleInfo object False 规则信息 1.4.1 reviseId string False 修正质检评分结果标识 1.4.2 revise number False 修正类型（1合规，0违规） 1.4.3 description string False 修正描述 1.5 ruleType number False 规则类型，10=对话规则;11=静音规则;12=语速规则;13=抢插话规则;60=敏感词;70=人工质检规则， 1.6 uuid string False 通话质检的内部标识

云客服质检申诉接口 (qualityitem)
云客服-查询外呼黑名单:报文样例

报文样例该接口的请求消息体举例如下： {"limit":10,"offset":0} 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "validityExpirationTime": "2022-02-18T17:56:14.000+00:00", "blockNum": "111" }, { "validityExpirationTime": "2022-02-23T09:10:07.000+00:00", "blockNum": "34234" }, { "validityExpirationTime": "2022-02-23T09:11:13.000+00:00", "blockNum": "321" }, { "validityExpirationTime": "2022-03-03T02:01:40.000+00:00", "blockNum": "321" } ], "resultCode": "0200000", "resultDesc": "query BlockList Success", "returnDesc": "query BlockList Success" }

云客服
云客服-查询外呼黑名单:接口URI

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

云客服
云客服-查询外呼黑名单:请求说明

请求说明表2 请求消息头参数序号名称参数类型是否必选说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。表3 请求消息体参数说明序号参数名参数类型是否必选说明 1 blocklist List False 查询黑名单号码列表，最多20条。号码最大长度为24个字符，有效字符为：0~9、*、# 注意：如果传了该字段，则响应只返回该列表的黑名单号码，即响应结果为请求传入的黑名单列表是否在黑名单中，如果在，则返回黑名单号码相关信息，如到期时间、有效时长。 2 offset int False offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。 3 limit int False 表示每页的查询数量。取值范围：1～100 注意： limit offset和blocklist存在且仅存在其一。

云客服
云客服-查询外呼黑名单:响应说明

响应说明表4 消息体参数说明序号参数名参数类型说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。具体见错误结果码。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。具体见错误结果码。 4 returnDesc String 描述。 5 data Object 参见表5。表5 data参数说明序号参数名参数类型说明 5.1 validityExpirationTime String 到期时间 5.2 blockNum String 黑名单号码 5.3 flag Boolean 黑名单有效标识，true：有效；false：无效须知：入参传入了blocklist才会返回该参数

云客服
云客服-查询外呼黑名单:错误结果码

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

云客服
云客服-查询满意度调查配置（getSatisfactionSurveyMode）:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 X-APP-Key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 ccmessaging-token string True applyToken接口生成的ccmessagign-token

云客服

共100000条

undefined

意见反馈

0/200

提交取消

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

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线