华为云用户手册

云客服-查询外呼活动重试策略:错误结果码

错误结果码表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 参数个数不能大于规定个数

云客服
云客服-查询外呼活动重试策略:报文样例

报文样例该接口的请求消息体举例如下：无该接口的响应消息体举例如下： { "returnCode": "0200000", "data": { "retryPolicyId": "1871694313", "policyType": 0, "policyJson": "[{'retryTimes':1,'retryDay':2,'type':0,'policy':[]}]" }, "returnDesc": null }

云客服
云客服-查询外呼活动重试策略:接口URI

接口URI 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。

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

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

云客服对话标识绑定类接口
云客服-查询在线交谈工作台当前交谈的消息（getUserInfoBycallId）:响应说明

响应说明响应状态码: 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 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-查询在线交谈工作台当前交谈的消息（getUserInfoBycallId）:请求说明

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

云客服
云客服-查询单个业务场景:报文样例

报文样例场景描述：查询单个业务场景详情请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "group_id": "groupid_33bba990-c39e-4397-a649-1fdb46d54b17" } 响应参数: { "tenant_id": "202106114153", "silence_rules": [{ "rule_id": "920806740809748480", "rule_name": "静默规则1" }], "other": {}, "speed_rules": [], "interposal_rules": [], "create_time": 1624413549, "group_name": "业务场景1", "group_id": "groupid_48450728-6b9d-4942-9884-2c5405e974d0", "ignore_sensitive": 0, "is_enable": 0, "description": "", "rules": [] }

云客服
云客服-查询单个业务场景:响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1.1 group_id string True 业务场景标识 1.2 group_name string False 业务场景名称 1.3 is_enable number True 是否正在被启用（0 代表不启用，1 代表启用） 1.4 other object False 业务场景触发条件 1.4.1 call_end number False 通话起始时间，时间戳毫秒 1.4.2 call_from number False 通话结束时间，时间戳毫秒 1.5 create_time number False 创建时间 1.6 description string False 业务场景描述 1.7 ignore_sensitive number False 是否计入敏感词分数（0 代表计入，1 代表不计入） 1.8 rules array[string] False 对话规则，多个规则值以逗号分隔 1.9 silence_rules array[string] False 静默规则，多个规则值以逗号分隔 1.10 speed_rules array[string] False 语速规则，多个规则值以逗号分隔 1.11 interposal_rules array[string] False 抢插话规则，多个规则值以逗号分隔响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-查询单个业务场景:请求说明

请求说明表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 group_id string True 业务场景标识

云客服
云客服-取保持与会者:请求说明

请求说明消息头表2 请求头参数说明序号名称参数类型是否必选说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。消息体表3 消息体参数说明序号名称参数类型是否必选说明 1 addressType String True 地址类型。 6：电话号码 9：座席工号 2 address String True 地址标识，即电话号码或者座席工号。最大长度为24字节。

云客服
云客服-取保持与会者:接口URI

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

云客服
云客服-取保持与会者:报文样例

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

云客服
云客服-查询座席当前呼叫统计信息:接口URI

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

云客服
云客服-查询座席当前呼叫统计信息:响应说明

响应说明表3 消息体参数说明序号名称参数类型说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功非0：失败 3 result object 查询成功后，返回座席当前呼叫统计信息对象。该对象的参数说明请参见表4。表4 result对象参数说明序号名称参数类型说明 3.1 talktime long 当日总通话时长，单位 s。 3.2 answernums int 当日接听次数 3.3 noanswernums int 当日久不应答次数 3.4 calloutnums int 当日外呼次数 3.5 intercallnums int 当日内部呼叫次数 3.6 interhelpnums int 当日内部求助次数 3.7 transfernums int 当日转接次数 3.8 transferoutnums int 当日转出次数 3.9 transferivrnums int 当日转IVR次数 3.10 redirectnums int 重定向的次数 3.11 keepnums int 保持次数 3.12 busynums int 示忙次数 3.13 restnums int 请假次数 3.14 restoutnums int 超假次数 3.15 resttime long 请假时长（秒） 3.16 restouttime long 超假时长（秒） 3.17 agentrelease int 主动释放数 3.18 busytime long 示忙时长（秒）

云客服
云客服-查询座席当前呼叫统计信息:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数无响应参数 { "message": "", "retcode": "0", "result": { "talktime": 4328, "answernums": 5, "noanswernums": 0, "calloutnums": 0, "intercallnums": 5, "interhelpnums": 0, "transfernums": 0, "transferoutnums": 0, "transferivrnums": 0, "redirectnums": 0, "keepnums": 0, "busynums": 0, "restnums": 0, "restoutnums": 0, "resttime": 0, "restouttime": 0, "agentrelease": 1, "busytime": 0 } }

云客服
云客服-单个创建接入码与技能队列、IVR绑定关系（createCalledRoute）:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）表2 请求体参数序号名称参数类型是否必选说明 1.1 accessCode string True 接入码；最大长度32字符 1.2 extCode string False 扩展码；最大长度12字符（如果希望一个接入码能设置多个目的设备。这种情况下可通过配置扩展码的方式来实现，例如，接入码为12345，我们可以添加扩展码1，路由到技能队列A，扩展码2，路由到技能队列B。这样客户可直接拨打123451实现直接接入技能队列A。） 1.3 mediaTypeId integer False 媒体类型；默认值：5 字段可选值：（2：语音点击通话 5：音视频 18：视频点击通话 19：视频 53：多媒体）说明： 1、传入技能队列（devicetype=1）时，mediaTypeId等于传入的技能队列绑定的mediaTypeId（没有绑定默认5） 2、接入码accessCode所属的媒体类型（查询接入码接口返回的mediaTypeId字段）和该入参mediaTypeId的对应关系如下： 5对应5和19； 53对应53； 2对应2和18 1.4 devicetype integer True 设备类型； 1：技能队列 3：IVR 说明：多媒体渠道不能选择IVR流程 1.5 deviceId integer True 目标设备id（技能队列skillId、IVR的id）说明：传入技能队列（devicetype=1）时，deviceId的对应的媒体类型要和入参mediaTypeId一致

云客服号码管理
云客服-单个创建接入码与技能队列、IVR绑定关系（createCalledRoute）:响应说明

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

云客服号码管理
云客服-单个创建接入码与技能队列、IVR绑定关系（createCalledRoute）:报文样例

报文样例请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "accessCode": "9911411", "extCode": "11", "devicetype": 1, "deviceId": 1, "mediaTypeId": 19 } 响应参数: { "returnCode": "0", "description": "data create success" }

云客服号码管理
云客服-查询签入技能队列座席详细信息:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数无响应参数 { "message": "", "retcode": "0", "result": [ { "workno": "20011", "name": "20011", "status": "4", "ctiStatus": "1", "groupid": 1, "groupname": null, "skilllist": [], "mediatype": "TTT", "vdnid": 6, "phonenumber": "70942", "currentstatetime": 1376, "logindate": 1501125758000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 } ] }

云客服
云客服-查询签入技能队列座席详细信息:响应说明

响应说明表3 消息体参数说明序号名称参数类型说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功非0：失败 3 result list 查询成功后，返回座席对象列表。该对象的参数说明请参见表4。表4 result对象参数说明序号名称参数类型说明 3.1 workno string 座席工号 3.2 name string 座席名称 3.3 status int 座席状态，参见表1 3.4 ctiStatus int 座席平台状态，请参考表2 3.5 groupid int 座席班组ID 3.6 groupname string 未使用该返回参数 3.7 skilllist list 未使用该返回参数 3.8 callids list 未使用该返回参数 3.9 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功，才能进行音视频呼叫业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.10 vdnid int 所属VDN ID 3.11 phonenumber string 座席电话号码 3.12 currentstatetime long 当前状态时长（秒） 3.13 logindate long 签入时间，时间戳（毫秒） 3.14 inMultimediaConf int 未使用该返回参数 3.15 currentStateReason int 当前状态原因码

云客服
云客服-会议申请成功

会议申请成功标示符 AgentConf_RequestSuccess 作用表示会议申请成功，同时主席已经加入会议。附带信息 confId表示会议ID。示例： {"message":"","retcode":"0","event":{"eventType":"AgentConf_RequestSuccess","workNo":"153","content":{"confId":1030400}}} 父主题：座席会议事件

云客服
云客服-释放事件回调接口:报文样例

报文样例请求参数: { agentAlertingTime=2022/02/22,10:04:29:004, agentReleaseTime=2022/02/22,10:04:29:004, agentTalkDuration=2022/02/22,10:04:29:004, agentTalkingTime=2022/02/22,10:04:29:004, alertingTime=2022/02/22,10:04:29:004, callData=null, callSerialNo=1197765398201387012, called=88880067, caller=960003, callerPresent=960003, createCallTime=2022/02/22,10:04:28:823, locationId=0, nonce=-1482421808053124529, recordfile=Y:/2/mobileAgent/20220222/1645524268-824.wav, releaseReason=0, releaseTime=2022/02/22,10:04:36:318, serviceNo=null, signature=+lk3***************************tO50=, talkDuration=0, talkingTime=2022/02/22,10:04:30:418, timestamp=1645524163326 } 响应参数: { "retCode": "0", "retMsg": "success" }

云客服
云客服-释放事件回调接口:请求说明

请求说明请求头参数：无。请求体参数：表1 请求体参数序号名称参数类型是否必选说明 1 callSerialNo string True 呼叫流水号。长度限制：string（50）。 2 serviceNo string True 座席工号等。 3 called string True 客户号码。 4 caller string False 本次呼叫的座席绑定的电话。 5 callerPresent string False 外显号码。 6 callData string False 呼叫数据。 7 createCallTime string False 发起呼叫时间。 8 alertingTime string False 用户振铃时间。 9 talkingTime string False 通话时间。 10 releaseTime string False 释放时间。 11 talkDuration string False 通话时长。 12 recordfile string False 录音路径。 13 locationId string False 录音节点。 14 releaseReason string False 释放原因码。 0：通话结束，被叫挂机 1：通话结束，主叫挂机 2：外呼主叫失败 3：外呼被叫失败 4：外呼主叫无应答 5：外呼被叫无应答 xxx：其他异常 15 agentAlertingTime string False 座席振铃时间。 16 agentTalkingTime string False 座席通话时间。 17 agentReleaseTime string False 座席释放时间。 18 agentTalkDuration string False 座席通话时长。

云客服
云客服-批量查询技能队列维度服务水平:响应消息

响应消息表3 响应消息体参数说明序号名称参数类型说明 1 resultCode string 查询结果。取值如下： "0100000"：成功其他：失败失败的原因说明请参见错误码参考。 2 resultDesc array 查询成功后，返回结果信息的对象数组。该数组中对象的参数说明请参见表4。表4 resultDesc对象参数说明序号名称参数类型说明 2.1 skillId int 技能队列编号。 2.2 statStartTime long 统计的开始时刻。（毫秒级时间戳） 2.3 inCallNum long 当前5分钟技能队列的呼入呼叫总和 2.4 connectedNum long 当前5分钟技能队列的接通呼叫总和 2.5 callLostNum long 当前5分钟技能队列呼损呼叫总和 2.6 in15sCallNum long 当前5分钟技能队列内在15S内接通呼叫总和 2.7 wait15sLostNum long 当前5分钟技能队列排队时长小于15S的呼损呼叫总和 2.8 in20sCallNum long 当前5分钟技能队列内在20S内接通呼叫总和 2.9 wait20sLostNum long 当前5分钟技能队列排队时长小于20S内呼损呼叫总和

云客服
云客服-批量查询技能队列维度服务水平:样例报文

样例报文请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":1, "skillIds":[1,2] } 响应参数： { "resultCode": "0100000", "resultDesc": [ { "in15sCallNum": 0, "skillId": 1, "wait15sLostNum": 0, "callLostNum": 0, "in20sCallNum": 0, "statStartTime": 1611714900000, "wait20sLostNum": 0, "inCallNum": 0, "connectedNum": 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 vdn int True 虚拟呼叫中心编号。取值范围：1～5000。 3 skillIds array True 技能队列ID信息的对象数组。数组长度不大于1000。取值范围：1～2000。

云客服
云客服-查询所有句子分类:报文样例

报文样例场景描述：查询所有句子分类请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 响应参数: { "data": [{ "category_id": "925086177642418176", "name": "句子类别1" }], "resultCode": "0403000", "resultDesc": "操作成功" }

云客服
云客服-查询所有句子分类:请求说明

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

云客服
云客服-查询所有句子分类:响应说明

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

云客服

共100000条

undefined

意见反馈

0/200

提交取消

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

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线