华为云用户手册

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 retCode string True 返回码，具体返回码说明请参考表4。 1.2 retMsg string False 返回描述 1.3 result object False retCode为0时，必返回 1.3.1 callSerialNo string True 呼叫流水ID 表4 返回码说明 序号 返回码 说明 1.1.1 0 成功。 1.1.2 1 有未完成的任务，请稍后重试。 1.1.3 3 创建失败，未生成呼叫流水号。 1.1.4 4 softPhone格式与规则不匹配。 1.1.5 5 called未传递，或者格式与规则不匹配。 1.1.6 6 vdn未启用。 1.1.7 7 callerPresent校验失败。 1.1.8 9 callBackUrl不符合条件。 1.1.9 10 playTimes必须大于等于1且小于等于5。 1.1.10 11 playList数组为空或者数组大小大于5。 1.1.11 12 voiceId和templateId同时为空。 1.1.12 13 单个变量长度超出32字节。 1.1.13 14 templateParams中参数值的格式不正确，包含"$”,“{”,“}"3个字符其中一个。 1.1.14 15 templateParams数组为空或者数组大小大于10。 1.1.15 16 租户为试商用状态，被叫号码不在白名单中。 1.1.16 17 语音或者TTS文件数据不存在。 1.1.17 18 录音或者TTS文本文件不属于语音通知使用场景。 1.1.18 19 录音或者TTS文本文件未提交。 1.1.19 20 录音或者TTS文本文件提交未审核。 1.1.20 21 录音或者TTS文本文件审核不通过。 1.1.21 22 templateId对应的文件类型不是文本类型。 1.1.22 23 voiceId对应的文件类型不是语音类型。 1.1.23 24 录音文件或者TTS文件数据在数据库中不存在。 1.1.24 25 templateParams数组大小和templateId对应模板中定义的变量个数不相等。 1.1.25 26 templateParams中参数值的日期格式不正确。 1.1.26 27 templateParams中参数值的时间格式不正确。 1.1.27 28 语音通知模板格式不正确。 1.1.28 29 templateParams中参数值的长度大于templateId对应模板中定义的变量的长度，比如模板定义的变量是${NUM_6}(数字6表示最大长度为6)，而对应入参值为1234567，那么会被校验住。 1.1.29 30 templateParams中参数值的字节长度大于templateId对应模板中定义的变量的长度，比如模板定义的变量是${TXT_14}(数字14表示最大字节数为14),而对应入参值为‘华为云客服’，那么会被校验住。 1.1.30 31 templateParams中对应可变变量${NUM_数字}的参数值类型只能为数字。 1.1.31 32 templateParams中对应可变变量${NUM_数字}的参数值的长度大于9。 1.1.32 33 voiceFileName不存在。 1.1.33 34 入参voiceFIleName对应的文件类型不是语音类型。 1.1.34 35 templateParams数组中元素的值不能为空。 1.1.35 36 priority字段值格式不符合要求。 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 结果返回码，0表示查询成功，-1表示查询失败，description表示失败具体原因 1.2 description string True 结果返回描述 1.3 satisfactionEvaluations object True 满意度评价 1.3.1 evaluationValue string False 满意度评价，为满意度等级配置的字典key值。 “1”表示“很不满意”， “2”表示“不满意”， “3”表示“一般”， “4”表示“满意”， “5”表示“很满意” “-1”表示“超时未回复”，指用户收到满意度评价后，评价超时， “-2”表示“评价错误”指用户回复的满意度，不在满意度配置的按键值中。 1.3.2 channel string False 渠道： audio表示音频渠道，MSG表示短信，WEB表示网页文字交谈渠道 1.3.3 evaluationTime number False 评价时间，毫秒级别Timestamp时间戳类型 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestBody object True 请求入参 1.1 callId string True 通话标识callId 1.2 beginTime number True 评价开始时间，毫秒级别Timestamp时间戳类型 1.3 endTime number True 评价结束时间，毫秒级别Timestamp时间戳类型

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "callId": "1647265024-xxxx"， "beginTime": 1647265028000， "endTime": 1647265029000 } 响应参数: { "returnCode": "0"， "satisfactionEvaluations": { "channel": "audio"， "evaluationValue": "5"， "evaluationTime": 1647265028000 }， "description": " query Success" }

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: {"locale" : "zh_CN"，"voiceType" : "0"，"fileType" : "wav"，"callBackUrl" : "http://10.130.40.194:18133/upload"，"fileInfo" : "UklGRjJ+AABXQVZFZm10IBIAAAAGAAEAQB8AAEAfAAABAAgAAABkYXRhAH4AANXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1"} 响应参数: { "returnCode": "0"， "description": "File uploaded successfully."， "fileId": "1182733043937561608"} 回调URL样例报文： //请求参数{ "fileUrl": "Y:/IVR/147/voice/0/nPqV9vU3_1666706957559.wav"， "fileId": "1323606152730207249"， "status": "2"， "comment": "审核通过"}//响应参数{ "returnCode": "0"}

响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 0，成功，其他为失败 1.2 description string True 描述。 1.3 fileId string False 上传后的语音文件后生成的id，用于关联云客服的录音 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 2 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 body object False - 1.1 fileInfo string True Base64编码后的录音文件信息，限制8MB。上传文件大小会相应增加上传时间 1.2 locale string True 录音文件的语种，zh_CN(中文)、en_US(英文)、pt_BR(葡萄牙语)、th_TH(泰语) 1.3 voiceType string True 语音类型，比如0 是IVR，1提示音，2故障音，3语音通知 1.4 fileType string True 文件类型，支持wav格式和MP3格式 wav格式和MP3格式均会使用ffmpeg工具转码为平台所支持的音频文件格式（A-law压缩算法、单声道、采样位数:8bit、采样频率:8000HZ），转换后音质可能会有影响，音频文件数据可能会丢失，建议使用符合平台支持的音频文件格式。 1.5 callBackUrl string False 回调URL，系统审核后，系统会通过这个url返回审核的结果信息。 回调URL为客户自定义接口，用于接收系统审核结果信息，其中请求参数与响应参数可参考表3。 1.6 voiceFileName string False IVR语音名称，长度不能超过50字符，只能包含中文、大小写字母，数字。 表3 回调URL参数说明 序号 名称 参数类型 是否必选 说明 请求参数 1.5.1 fileUrl string True 审核文件地址，文件地址全称，包括文件后缀。 1.5.2 fileId string True 审核文件ID，具体值可参考表4中的fileId字段设置。 1.5.3 status string True 文件审核状态，取值范围： 2：审核通过。 3：审核不通过。 1.5.4 comment string False 审核状态备注。 响应参数 1.5.5 returnCode string True 响应代码，取值范围： 0：审核结果接收成功。 其他：审核结果接收失败。 说明： 审核结果接收失败后会重复调用回调接口继续返回文件上传审核结果，超过6次后同一文件的上传审核结果不再继续响应。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 返回结果。 1.1 returnCode string False 返回码。0：表示成功；1：表示失败；3：表示发送消息同步表数据部分成功；4：表示时间参数小于当前时间；5：表示接收短信号码为空；8：表示短信配置为空；9：表示有收件人不存在；10：表示单位时间内短信或者邮件发送超过最大次数。 1.2 description string False 返回描述。 响应状态码: 400 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误的请求：请检查请求路径及参数。 响应状态码: 401 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 请求的内容未找到：请检查请求的路径。 响应状态码: 500 表7 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败：请依次确认您请求中各参数的取值。

请求说明 请求头参数： 无。 请求体参数： 序号 名称 参数类型 是否必选 说明 1 callSerialNo string True 呼叫序列号。 2 called string True 被叫号码 3 signature string False 签名。 当通过创建语音通知接口传入回调URL，并在回调url配置界面中“请输入共享密钥”配置了共享密钥，为必选。 4 timestamp string False 时间戳 当通过创建语音通知接口传入回调URL，并在回调url配置界面中“请输入共享密钥”配置了共享密钥，为必选。 5 nonce string False 随机数 当通过创建语音通知接口传入回调URL，并在回调url配置界面中“请输入共享密钥”配置了共享密钥，为必选。 6 callerPresent string False 主叫外显号码。 7 createCallTime string False 发起呼叫时间。例如：2022/02/17,13:10:06:836 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： 呼通后，通知播完挂机； 4： 被叫拒接、被叫振铃后超时未接； 6： 振铃前呼叫失败； 8：无资源； 9：排队机超时； 10：呼叫受限； 999：UAP拉起录音会场失败；

报文样例 请求参数: { alertingTime=2022/02/22,10:04:29:004, callSerialNo=1197765398201387012, called=88880067, 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, signature=+lk************************50=, talkDuration=0, talkingTime=2022/02/22,10:04:30:418, timestamp=1645524163326 } 响应参数: { "retCode": "0", "retMsg": "success"}

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "name":"ctest1"， "scene":"3"， "volume":0， "speed":50， "voicename":"cn_kefuman_cn"， "callBackUrl" : "http://10.134.227.74:18133/upload"， "voicecontent":{ "language":"zh_CN"， "textcontent":"测试" } } 响应参数: { "returnCode": "0"， "description": "The file is uploaded successfully."， "templateId": "1249756280719641601" } 回调URL样例报文： //请求参数{ "fileId": "1323606152730207249"， "status": "2"， "comment": "审核通过"}//响应参数{ "returnCode": "0"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 2 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestBody object False - 1.1 name string True 文字转语音模板文件名称，支持填写中文，数字，大小写英文字母。长度不超过50字符。 1.2 scene string False 使用场景。 取值范围：3，表示语音通知 1.3 speed number False 转成语音的播放语速，取值范围[-200，500]，若不填则默认值：0 1.4 volume number False 转成语音的播放音量，取值范围[0，100]，若不填则默认值：50 1.5 voicename string False 转成语音的播放音色，取值范围： cn_kefuman_common，表示客服曼 cn_chengshuxing_common，表示成熟型 cn_roumeiqian_common，表示柔美倩 cn_ziranzhen_common，表示自然真 cn_tianmeiru_common，表示甜美茹 若不填则给默认值：cn_kefuman_common 1.6 voicecontent object True 需要转为语音的文本内容。 1.6.1 textcontent string True 文本内容，最大长度500字节。 具体模板内容由固定文本和变量组成。模板采用UTF-8编码格式，汉字和中文符号为3个字节，字母、数字和英文符号为1个字节。 模板内容不能以变量开头。 模板内容长度不超过500字节。 单个变量长度不超过32字节（如果单个变量长度超过32字节，建议拆分成多变量）。 支持的变量格式有： ${TXT_数字}：表示变量为定义相应长度的字符串，数字表示该字符串的最大长度，如${TXT_9}表示最大长度为9字节的字符串。 ${NUM_数字}：表示变量只能为数字（0～9）的组合，数字表示该变量的最大个数，如${NUM_6}表示最大6个数字的组合。 ${DATE}表示变量为日期，格式要求为“YYYY/MM/DD”，其中，“YYYY”代表年，“MM”代表月，“DD”代表日，如2022/07/16。 ${TIME}表示变量为时间，支持两种格式，一种格式精确到分钟，格式为“HH:MM”，“HH”代表时，“MM”代表分，如14:30；另一种格式精确到秒，格式为“HH:MM:SS”，“HH”代表时，“MM”代表分，“SS”代表秒，如：14:30:30。 模板样例： 样例一：尊敬的${TXT_8}您的初始密码为${NUM_6}。 样例二：请于${DATE}，${TIME}前领取您的快递。 说明： ${DATE}和${TIME}必须用逗号隔开。 1.6.2 language string True 语种。 zh_CN(中文) en_US(英文) pt_BR(葡萄牙语) th_TH(泰语) 1.7 callBackUrl string False 回调URL，系统审核后，系统会通过这个url返回审核的结果信息 回调URL为客户自定义接口，用于接收系统审核结果信息，其中请求参数与相应参数可参考表3。 表3 回调URL参数说明 序号 名称 参数类型 是否必选 说明 请求参数 1.7.1 fileUrl string True 审核文件地址，文件地址全称，包括文件后缀。 1.7.2 fileId string True 审核文件ID，具体值可参考表4中的templateId字段设置。 1.7.3 status string True 文件审核状态，取值范围： 2：审核通过。 3：审核不通过。 1.7.4 comment string True 审核状态备注。 响应参数 1.7.5 returnCode string True 响应代码，取值范围： 0：审核结果接收成功。 其他：审核结果接收失败。 说明： 审核结果接收失败后会重复调用回调接口继续返回文件上传审核结果，超过6次后同一文件的上传审核结果不再继续响应。

响应说明 响应码：200 表4 响应参数说明 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 0：成功，其他为失败。 1.2 description string True 描述。 1.3 templateId string False 模板ID 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

响应说明 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc object 查询成功后，返回结果信息的对象。 该对象中的参数说明请参见表4 5 count int 当前查询VDN下座席总数。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 onRestAgentNum int 正在休息人数。 2.2 allowRestAgentNum int 已经允许休息人数，但是座席仍然未休息的座席人数。 2.3 waitRestAgentNum int 申请休息人数。 2.4 details Array 座席休息详情，该对象数组的参数说明具体见表5。 表5 座席休息详情 序号 名称 参数类型 媒体类型描述 2.4.1 agentId int 座席工号。 2.4.2 cantRestCause int 座席不允许休息的原因，此参数仅对于等待休息的座席有效。 该对象的参数说明请参见表6 2.4.3 vdnId int 虚拟呼叫中心编号。 2.4.4 ccId int 呼叫中心编号。 2.4.5 beginTime long 开始时间（若正在休息指休息开始时间，若还未休息指申请或批准休息开始时间），时间格式：时间戳。 2.4.6 applyRestLength int 申请休息时长（单位：秒）。 2.4.7 name String 座席姓名。 2.4.8 reqRestDura long 休息持续时长（正在休息的座席已经休息的时长），单位：秒 2.4.9 skillIds String 等待休息的座席签入的技能队列，仅当cantRestCause等于4时才有值返回。 表6 不允许休息原因 不允许休息原因值 如何理解 0 等待批准 1 座席示忙 2 VDN 休息人数已满。 3 座席不接来话，未签入任何技能队列。 4 签入队列休息人数已满。

样例报文 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "offset":0, "limit":3} 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": { "onRestAgentNum": 2, "allowRestAgentNum": 0, "details": [ { "agentId": 1034, "cantRestCause": 2, "vdnId": 170, "ccId": 1, "beginTime": 1602830642000, "applyRestLength": 600, "name": "zhang1130user" }, { "agentId": 1039, "cantRestCause": 0, "vdnId": 170, "ccId": 1, "beginTime": 1602830613000, "applyRestLength": 600, "name": "HW285601039", "reqRestDura": 238 }, { "agentId": 1099, "cantRestCause": 0, "vdnId": 170, "ccId": 1, "beginTime": 1602830638000, "applyRestLength": 600, "name": "HW285601099", "reqRestDura": 213 } ], "waitRestAgentNum": 1 }, "resultDesc": { "onRestAgentNum": 2, "allowRestAgentNum": 0, "details": [ { "agentId": 1034, "cantRestCause": 2, "vdnId": 170, "ccId": 1, "beginTime": 1602830642000, "applyRestLength": 600, "name": "zhang1130user" }, { "agentId": 1039, "cantRestCause": 0, "vdnId": 170, "ccId": 1, "beginTime": 1602830613000, "applyRestLength": 600, "name": "HW285601039", "reqRestDura": 238 }, { "agentId": 1099, "cantRestCause": 0, "vdnId": 170, "ccId": 1, "beginTime": 1602830638000, "applyRestLength": 600, "name": "HW285601099", "reqRestDura": 213 } ], "waitRestAgentNum": 1 }, "count": 30}

响应说明 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 1 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 3 count int 当前查询VDN下座席总数。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 agentId int 座席工号。 2.2 currentState int 座席当前状态。CTI平台座席状态码参考 2.3 currentStateTime long 当前状态持续时长（单位：秒）。 2.4 locationId int 所属分布式接入节点。 CTI保留字段，无实际意义。

报文样例 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "offset":0, "limit":2} 响应参数： { "result": "0", "resultCode": "0100000", "count": 30, "resultDatas": [ { "agentId": 55002, "locationId": 65535, "currentStateTime": 153282, "currentState": 0 }, { "agentId": 833, "locationId": 65535, "currentStateTime": 153293, "currentState": 0 } ], "resultDesc": [ { "agentId": 55002, "locationId": 65535, "currentStateTime": 153282, "currentState": 0 }, { "agentId": 833, "locationId": 65535, "currentStateTime": 153293, "currentState": 0 } ]}

报文样例 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "vdn":170} 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "acId": 289, "mediatypeId": 5, "accessCode": "650114", "codeDescription": "语音接入" }, { "acId": 288, "mediatypeId": 5, "accessCode": "650115", "codeDescription": "语音接入" } ], "resultDesc": [ { "acId": 289, "mediatypeId": 5, "accessCode": "650114", "codeDescription": "语音接入" }, { "acId": 288, "mediatypeId": 5, "accessCode": "650115", "codeDescription": "语音接入" } ]}

响应说明 表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 acId int 接入码编号。 2.2 mediatypeId int 媒体类型。该对象请参考表1 2.3 accessCode String 接入码值 2.4 codeDescription String 接入码描述

请求说明 表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 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 1 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 3 count int 当前查询VDN下座席总数。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 agentId int 座席工号。 2.2 phone string 座席电话号码。

报文样例 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "offset":0, "limit":4} 响应参数 { "result": "0", "resultCode": "0100000", "count": 30, "resultDatas": [ { "agentId": 55002, "phone": 620001 }, { "agentId": 833, "phone": 620002 }, { "agentId": 834, "phone": 620003 }, { "agentId": 835, "phone": 620004 } ], "resultDesc": [ { "agentId": 55002, "phone": 620001 }, { "agentId": 833, "phone": 620002 }, { "agentId": 834, "phone": 620003 }, { "agentId": 835, "phone": 620004 } ]}

报文样例 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "offset":0, "limit":4} 响应参数： { "result": "0", "resultCode": "0100000", "count": 30, "resultDatas": [ { "agentId": 55002, "state": 0 }, { "agentId": 833, "state": 0 }, { "agentId": 834, "state": 0 }, { "agentId": 835, "state": 0 } ], "resultDesc": [ { "agentId": 55002, "state": 0 }, { "agentId": 833, "state": 0 }, { "agentId": 834, "state": 0 }, { "agentId": 835, "state": 0 } ]}

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 5 count int 当前查询VDN下座席总数。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 agentId int 座席工号。 2.2 state int 座席状态。CTI平台座席状态码参考

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

响应消息 表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 callId string 呼叫ID 2.2 customerLevel int 呼叫客户级别 序号从1到254，编号越大，表明客户的地位越高，越重要。 2.3 requestType int 呼叫特征 该对象请参考表1

样例报文 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "offset":0, "limit":100} 响应参数： { "result": "0", "resultCode": "0100000", "count": 30, "resultDatas": [ { "agentId": 1086, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601086", "realFlag": 1 }, { "agentId": 1087, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601087", "realFlag": 1 } ], "resultDesc": [ { "agentId": 1086, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601086", "realFlag": 1 }, { "agentId": 1087, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601087", "realFlag": 1 } ]}

请求说明 表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 offset int True 分页offset参数 取值范围：大于等于0 4 limit int True 分页limit参数 取值范围：1～100

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 5 count int 当前查询VDN下座席总数。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 agentId int 座席工号 2.2 groupId int 所属班组ID，目前该字段取-1值 班组：为了方便对业务代表进行管理，通常对虚拟呼叫中心的业务代表进行分组。分为一组的业务代表形成一个班组（目前AICC不支持该字段只返回-1 ，即没有所属班组） 2.3 rights string 座席的权限值。0表示没有权限，1表示有权限。角色权限位说明如表5 2.4 name string 座席姓名 2.5 realFlag int 是否为网络座席。取值：0表示网络座席，1表示普通座席。AICC当前均为普通座席 表5 座席权值 位数 描述 1 示忙/示闲 2 静音/结束静音 3 保持/取保持 4 连接保持 5 普通呼出 6 内部呼叫 7 内部转移 8 接转接来话 9 三方通话 10 转出 11 人工转移自动 12 不接来话 13 监听/监听插入/耳语 14 拦截 15 强制签出/强制示忙/强制示闲 16 质检录音/质检放音 17 质检监视 18 考评管理员 19 普通考评员 20 告警台 21 报表处理员 22 未使用，平台保留值 23 监控台 24 配置管理员 25 报表管理员 26 国内长途呼出 27 国际长途呼出 28 本呼叫中心接入码呼出 29 全屏质检 30 同组代答 31 未使用，平台保留值 32 配置业务代表 33 技能配置 34 不可填写外呼主叫 35 配置审计 36~128 未使用，平台保留值

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 3 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 表4 resultDesc/resultDatas数组中对象参数说明 序号 名称 参数类型 说明 2.1 id int IVR流程ID 2.2 serviceNo int 业务类型编号 2.3 realFlag int 虚实队列 1-实队列 2-虚队列 2.4 accessNo string 接入码 2.5 description string 接入码功能描述