华为云用户手册

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":1, "callId":"1453723531-574" } 响应参数： { "result": "0", "resultDatas": { "trunkNo": 582, "deviceType": 2, "deviceNo": 1177, "dsn": 49, "callData": "", "totalTalkingTimes": 116, "cb": 1, "keyId": "", "callingNum": "88881363", "calledNum": "650550", "orgiCalledNum": "", "callDataLen": 0, "callSkill": "defaultAudioSkill", "partyNum": 2, "callFeature": 0, "place": 0, "waitTime": 0, "logonTimes": 127, "handle": 0, "time": 1606120429, "mediaType": "MEDIA_TYPE_PHONE", "server": 0, "mid": 5, "priority": 0 }, "resultDesc": { "trunkNo": 582, "deviceType": 2, "deviceNo": 1177, "dsn": 49, "callData": "", "totalTalkingTimes": 116, "cb": 1, "keyId": "", "callingNum": "88881363", "calledNum": "650550", "orgiCalledNum": "", "callDataLen": 0, "callSkill": "defaultAudioSkill", "partyNum": 2, "callFeature": 0, "place": 0, "waitTime": 0, "logonTimes": 127, "handle": 0, "time": 1606120429, "mediaType": "MEDIA_TYPE_PHONE", "server": 0, "mid": 5, "priority": 0 } }

响应消息 表3 消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDatas Object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc Object 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4 表4 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 cb long 内部标识。 time long 呼叫进入平台的时间。 dsn int 标识呼叫的任务号。 handle int 呼叫任务的控制块被循环使用的次数。 server int 处理呼叫的媒体服务器的标识。 keyId string 呼叫的业务标识。 callingNum string 主叫号码。 calledNum string 被叫号码 mid int 模块号。 trunkNo int 中继号。 priority int 用户级别 deviceType int 设备类型，请参见表1 deviceNo int 设备号码。 对于业务代表设备来说，设备号即为业务代表工号。 对于队列或虚设备，设备号即为在配置台上配置的队列ID号或虚设备对应的网络共享设备ID号 对于其他设备类型，均为内部标识号 callData string 呼叫数据。 callDataLen int 呼叫数据的有效长度。 callSkill string 呼叫技能描述 partyNum int 呼叫轨迹经过的设备数目。 callFeature string 呼叫特征，请参见表1 orgiCalledNum string 原始被叫 呼叫在进入系统前被叫发生变化，则该参数记录的是首次被呼叫方的号码。 mediaType string 呼叫的媒体类型，请参见表1 place int 用户所在的位置（呼叫进入的地点）。 waitTime long 排队等待时间，单位秒(s) totalTalkingTimes long 通话时长，单位秒(s) logonTimes long 进入总时长，单位秒(s)

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 消息体参数说明 参数名 数据类型 是否必选 说明 ccId int True 呼叫中心编号。取值范围：1～65535 vdn int True 虚拟呼叫中心编号。取值范围：1～5000 callId string True 呼叫ID，为指定座席的私有呼叫callId，最大长度20，获取方式参见查询指定座席的私有呼叫。

报文样例 请求头 POST /CCFS/resource/ccfs/downloadRecord HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:44:42Z/content-length;content-type;host /f18f6dd19******************6b8ff99f6c5884 Accept: */* Host: 10.154.198.164 Content-Type: application/json;charset=UTF-8 Content-Length: 185 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/autoTest.V3", "callId": "autoTest-1", "ccId": "1" } }

响应说明 当调用本接口响应成功，则从httpresonse消息中获取文件的二进制数据生成录音文件，文件后缀名为.wav，通过callid下载多个录音文件后缀名为.zip，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表4，resultData为保留字段，默认为空字符串。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象，参数说明详见表5 不推荐使用，为兼容老版本保留字段。 表5 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码，详见错误码参考。 4.3 resultMsg String 请求结果描述。

请求说明 表1 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String（1-32） True 2.0 协议版本。当前固定值为2.0。 表3 请求Body中msgBody参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 fileName String（1-225） False 无 录音文件名，从调用“下载话单和录音索引”时返回的录音索引文件中的original_file_name 字段获取 比如:“X:/4/0/20180416/512/1629533.V3”。注：fileName和callId参数值必须至少选填一个。 2 callId String（1-25） False 无 呼叫标识Id。注：fileName和callId参数值必须至少选填一个，callid 对应多个录音文件会下载 zip 压缩包。 3 ccId String（1-64） False 无 呼叫中心Id。当前环境默认为“1”。

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

报文样例 请求报文 { "tenantId": "tenant001"， "accessCode": "10086" ， "pageNum": "1" ， "pageSize": "10" ， "authToken": "0dbe1**************b505de" ， "source": "OIFDE" } 响应报文 { "total": 2， // long， 总条数 "accessInfoList" : [{ // Object Array， 对话绑定关系列表 "accessId":"100001"， // String， 内部序号 "tenantId": "tenantId001"， // String， 租户 "accessCode": "10086"， // String， 接入标识ID "domainId":10001， // int， 领域ID "dialogType ":1， // int， 对话类型 "flowCode" : "flowxxxxxx"，// String， 流程编码 "description" : ""，// String， 发起对话识别的源设备 "source":"OIFDE"，// String， 描述 "chatBotName":"10086"， // String， 机器人名称 "usingRecordService":0 // int，关闭宇高录制 }，{ …… }] }

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

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "agentIds":[1031,1099] } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "prevState": 1, "agentId": 1031, "logonTime": 4294967295000, "agentRelease": 0, "locationId": 65535, "currentPrivateCallNum": 0, "currentStateTime": 2224439, "currentStateReason": 65535, "prevStateTime": 4294967295, "currentState": 0 }, { "prevState": 1, "agentId": 1099, "logonTime": 4294967295000, "agentRelease": 0, "locationId": 65535, "currentPrivateCallNum": 0, "currentStateTime": 230703, "currentStateReason": 258, "prevStateTime": 4294967295, "currentState": 0 } ], "resultDesc": [ { "prevState": 1, "agentId": 1031, "logonTime": 4294967295000, "agentRelease": 0, "locationId": 65535, "currentPrivateCallNum": 0, "currentStateTime": 2224439, "currentStateReason": 65535, "prevStateTime": 4294967295, "currentState": 0 }, { "prevState": 1, "agentId": 1099, "logonTime": 4294967295000, "agentRelease": 0, "locationId": 65535, "currentPrivateCallNum": 0, "currentStateTime": 230703, "currentStateReason": 258, "prevStateTime": 4294967295, "currentState": 0 } ] }

请求URL https://ip:port/rest/cmsapp/v1/openapi/agentgroup/agentstatusinfobyagentids 其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。 非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。

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

响应消息 表3 消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 agentId int 座席工号。 2.2 locationId int 所属分布式接入节点 2.3 currentStateReason int 当前状态原因，目前只有在休息态时才有意义 2.4 prevState int 前一个状态，参数说明请参考CTI平台座席状态码参考。 2.5 prevStateTime long 前一个状态持续时间 单位秒（s）。 2.6 currentState int 当前状态，参数说明请参考CTI平台座席状态码参考。 2.7 currentStateTime long 当前状态持续时间 单位秒（s）。 2.8 logonTime long 签入时间（毫秒级时间戳） 说明： 如果查询结果中涉及的座席处于未签入状态，该字段显示的时间是未来时间（2106年），不是座席实际签入的时间。 2.9 agentRelease int 座席主动收线次数 2.10 currentPrivateCallNum int 座席当前的私有呼叫数目

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas long CTI平台所在服务器UTC的时间戳。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc long CTI平台所在服务器UTC的时间戳。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": 1605057110000, "resultDesc": 1605057110000 }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围：1～65535。

响应说明 响应状态码: 200 表4 RspMsg参数结构 序号 名称 参数类型 说明 1.1 resultCode string 响应返回码 0：成功 13：呼叫信息获取失败，或提交满意度结果失败。 1.2 resultDesc string 响应返回描述 如果响应码为0，返回可能是“Save satisfaction success!” 有时也会返回“Exception appeared!” 如果响应码为13，则返回“The callIdString obtained failed!”或“Save satisfaction failed”。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "MODTYP":"CCU", "PID":"CCB", "MN":"56", "ccId":1 } 响应参数： { "resultCode": "0100000", "resultDesc": { "10.xx.xx.xx#0": { "Alerting CB number": "0", "Null after combine CB number": "0", "IDC switch index": "1", "Wait tone CB number": "0", "Release guard CB number": "0", "Release waiting CB number": "0", "Booked CB number": "0", "Temply hold CB number": "0", "Active CB number": "0", "Info receiving status number": "3", "Call park CB number": "0", "Null CB number": "9997", "Overlap transmit number": "0", "Call proceeding number": "0", "Wait overlap CB number": "0", "Connection request CB number": "0" } } }

响应消息 表3 响应消息体参数说明 参数名 数据类型 说明 resultCode String 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDesc List 查询成功后，返回结果信息的对象列表。 该数组中对象的参数说明请参见下表。 10.xx.xx.xx#0 String 10.xx.xx.xx：UAP IP “#”：固定分隔符 “0”：UAP编号 表4 resultDesc对象参数说明（设置“模块类型”为“CCU”，“CCU模块ID”为“CCB”，“CCU模块号”为“57”） 参数名 数据类型 说明 IDC switch index String 在线指示 Null CB number String 处于NULL状态的控制块个数 Booked CB number String 忙电路数 Info receiving status number String 处于信息接收的控制块个数 Wait overlap CB number String 处于WAITOVERLAP状态的个数 Overlap transmit number String 处于Overlap transmit的个数 Call proceeding number String 处于CALLPROCEEDIN的个数 Alerting CB number String 处于ALERTING状态的个数 Connection request CB number String 处于连接请求的个数 Active CB number String 处于激活状态的个数 Release guard CB number String 处于Release guard的个数 Release waiting CB number String 处于释放等待的个数 Temply hold CB number String 处于Temply hold状态的个数 Wait tone CB number String 处于等待tone音的个数 Null after combine CB number String 处于NULLAFTERCOMBINE的个数 Call park CB number String 处于Call park的控制块个数 表5 resultDesc对象参数说明（设置“模块类型”为“CCU”，“CCU模块ID”为“INTESS”，“CCU模块号”为“56”） 参数名 数据类型 说明 Last allocated INTESS number String 上次分配的INTESS控制块号 Error stat flag String 错误原因统计开关 Error stat interval String 错误原因统计周期 Message statistics flag String 消息统计开关 Message statistics interval String 消息统计周期 Message statistics mask String 消息统计掩码 Idle CB number String 处于IDLE状态的控制块个数 Overlap CB number String 处于OVERLAP状态的控制块个数 Call delivered CB number String 处于CALLDELIVERED状态的控制块个数 Call present CB number String 处于CALLPRESENT状态的控制块个数 Call received String 处于CALLRECEIVED状态的控制块个数 Connection request CB number String 处于连接请求状态的控制块个数 Active CB number String 处于ACTIVE状态的控制块个数 SPACTIVE CB number String 处于SPACTIVE状态的控制块个数 CB number in INTESS_spy state String 处于INTESS_SPY状态的控制块个数 Wait REL CB number String 处于WAITREL状态的控制块个数 表6 resultDesc对象参数说明（设置“模块类型”为“MSU”，“PIDMSU模块ID”为“BSI”，“MSUMN模块号”为“472”） 参数名 数据类型 说明 Total number of connections String 连接总数 Total no of connection in IDLE state String 空闲状态连接总数 Total no of connection in CREATE CONNECT state String 正在创建状态的连接总数 Total no of connection in CONNECT state String 已经连接状态连接总数 Total no of connection in DELETE CONNECT state String 删除状态连接总数 Total no of connection in MODIFY CONNECT state String 修改状态连接总数 Total no of connection having service type as IVR String IVR业务连接总数 Total no of connection having service type as CONF String 会场业务连接总数 Total no of connection having service type as CONF CHAN String 会场通道业务连接总数 Total no of conf connection in IDLE state String 空闲状态会场连接总数 Total number of Conf connections String 会场连接总数 Total no of conf connection in CREATE CONF state String 正在创建状态会场连接总数 Total no of conf connection in CONF USING state String 使用状态会场连接总数 Total no of conf connection in CONF DELETE state String 删除状态会场连接总数

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "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 } ] }

响应消息 表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 未使用，平台保留值

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

报文样例 请求消息样例 { "tenantId":"123456"， "params":{ "userMobile": "180****9999" }， "authToken":"n******************************" } 响应消息样例 { "rtnCode": 0，//接口成功失败标识 "rtnMsg": "成功"，//接口成功失败描述 "beans": [{ "interNo":"1"， //序号 "userSaying":"我有多少话费"， //语音转写结果 "intention":"查询话费"， //用户意图 "systemReply":"您好，您当月累计消费100元，话费余额100元"， //系统回复 "type":"TTS"， //回复类型 "timestamp":"2019-04-25 17:42:10.0"， //系统回复时间 "responseSource":"0" //机器人回复 }]， "object": null， "bean": null， "callId": "xytest02131110"， "callSorId": "18019919999" }

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdnIds":[29,30], "indexIds":["IDX_COUNT_TOTAL_CALL","IDX_COUNT_CONNECTED_CALL"], "timeGrain":"15MIN", "anonyCall":1, "calleeNo":"640001", "mediaType":53, "subMediaType":3 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "29" }, { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "30" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "29" }, { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "30" } ] }

响应消息 表2 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 description array 查询成功后，返回结果信息的对象数组。 该对象的参数说明请参见表3 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc array 查询成功后，返回结果信息的对象数组。 该对象的参数说明请参见表3 表3 消息体参数说明 参数名 数据类型 说明 groupName String 用户组名称 groupType int 用户组类型 remark String 备注信息 id String 用户组主键id

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 无请求消息 响应参数： { "returnCode": "0", "resultCode": "0100000", "description": [ { "groupName": "ceshi001", "groupType": 3, "id": "159253664007418170345218084185" }, { "groupName": "ceshi002", "groupType": 2, "id": "159253664765739060254053779940" }, { "groupName": "ceshi003", "groupType": 3, "id": "159253666192354492596520647666" }, { "groupName": "ceshi004", "groupType": 2, "id": "159253667128968076722272915560" }, { "groupName": "ceshi005", "groupType": 3, "id": "159289723573509154577931092749" }, { "groupName": "ceshi445566", "remark": "此为质检组", "groupType": 3, "id": "159832671551117675139418726647" } ], "resultDesc": [ { "groupName": "ceshi001", "groupType": 3, "id": "159253664007418170345218084185" }, { "groupName": "ceshi002", "groupType": 2, "id": "159253664765739060254053779940" }, { "groupName": "ceshi003", "groupType": 3, "id": "159253666192354492596520647666" }, { "groupName": "ceshi004", "groupType": 2, "id": "159253667128968076722272915560" }, { "groupName": "ceshi005", "groupType": 3, "id": "159289723573509154577931092749" }, { "groupName": "ceshi445566", "remark": "此为质检组", "groupType": 3, "id": "159832671551117675139418726647" } ] }

报文样例 该接口的请求消息体举例如下： {"limit": 10,"offset": 0,"beginTime": "2022-08-20 15:55:55","endTime": "2022-08-23 15:55:55","url":""} 该接口的响应消息体举例如下： { "result": [ { "request": "{\"defId\":\"456\",\"vdnId\":2}", "httpStatus": 200, "resultCode": "0200000", "id": "166088991109059950708365448582", "resultDesc": "queryObsResultDetail success", "url": "/rest/isales/v1/openapi/campaigns/2/456/queryObsResultDetail", "operTime": "2022-08-19T14:18:31.000+00:00", "type": "GET" } ], "returnCode": "0200000", "resultCode": "0200000", "count": 1, "resultDesc": "queryCalllogs success", "returnDesc": "queryCalllogs success" }

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 offset int True offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。 2 limit int True 表示每页的查询数量。取值范围：1～100 3 url String False 调用url 该参数有值，查询当前url的调用记录。 该参数为空时，查询所有接口调用记录。 4 beginTime String True 开始时间 格式：yyyy-MM-dd HH:mm:ss 5 endTime String True 结束时间 格式：yyyy-MM-dd HH:mm:ss 结束时间和开始时间间隔不大于7天

响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见下表6 错误原因码说明 2 resultDesc String 描述。 3 result OpenapiLog 场景类型列表 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表6。 5 returnDesc String 描述。 表5 OpenapiLog 序号 参数名 参数类型 说明 1 id String 日志id 2 operTime Datetime 日志时间 3 url String 调用url 4 request Object 输入参数 5 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表6。 6 resultDesc String 描述。 7 httpStatus int 接口调用状态码 8 type String 请求类型

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