华为云用户手册

  • 联动能力 标示符 AgentEvent_linkageCapability 作用 表示某个座席话机联动是否成功。 附带信息 result表示联动结果,0表示联动成功,其他表示失败。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkageCapability","workNo":"120","content":{"result":0}}} 父主题: 话机联动事件
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 service_token:****************** 请求参数 { "workNo": "", "eventList": [ { "eventType": "", "workNo": "", "content": "" }, { "eventType": "", "workNo": "", "content": "" } ] } 响应参数 { "message": "success", "retcode": "0" }
  • 请求说明 消息头 表1 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 3 service_token string False 自定义,最大长度为50,不能包含特殊字符,否则会返回100-001,建议1分钟动态刷新一次。 消息体 表2 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 workNo string True 座席工号。 2 eventList array True 事件列表。 该对象的参数说明请参见表3。 说明: 事件列表按照事件产生顺序,从左往右排列,最新的事件放在最右边。 表3 eventList对象参数说明 序号 名称 参数类型 说明 2.1 eventType string 事件类型。 2.2 workNo string 座席工号。 2.3 content object 事件内容。
  • 报文样例 请求样例 { "account":"odfs", "nonce":"*******", // 服务端提供的原始随机文本 "checksum":"0dbe11*******************0b505de" // 客户端根据nonce值及本地密钥使用HmacSHA256加密算法加密处理后的文本 } 响应样例 { "token":"2**************************d", "duration":3600 }
  • 响应参数 名称 是否必选 参数类型 长度 说明 token False String 128 认证成功必须返回,业务请求接口需要的token duration False int 4 认证成功必须返回,token有效期(秒) error False String 512 认证失败时返回错误信息,同时状态码返回401。 nonce False String 128 认证失败时返回,服务端随机生成的字符串。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 id string False 敏感词的唯一标识 1.2 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.3 resultDesc string False 返回描述 1.4 statusCode number False 状态码 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:更新敏感词的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "category_id": "894378241379274752", "sw_name": "喂喂喂", "score": -8, "exception": { "customer": ["14171"], "staff": ["14161", "14166"] }, "sw_id": "894378241626738688" } 响应参数: { "resultCode": "0401000", "id": "1071495709510864896", "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 True 操作员标识 可在登录后,进入员工管理页面,查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 sw_name string True 敏感词名称 1.2 score number False 敏感词分数 1.3 exception object False 敏感词例外状况 1.3.1 customer array[string] False 客户说的句子 1.3.2 staff array[string] False 坐席说的句子 1.4 sw_id string True 敏感词的唯一标识 1.5 category_id string True 敏感词分类的唯一标识
  • 接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/switch/{workNo} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 workNo string True 指定座席工号,取值范围:101~59999。 该座席工号必须与前面agentid为同一vdn下面的座席。
  • 响应说明 响应状态码: 200 表12 响应体参数 序号 名称 参数类型 说明 1.1 messages array[object] 已发送消息对象数组,每条消息一个对象 1.1.1 to object 消息目的地地址 1.1.1.1 phoneNumber string 目标电话号码。电话号码必须是国际格式(例如:41793026727) 1.1.2 status object status对象 1.1.2.1 groupId number 状态组id 1.1.2.2 groupName string 状态组名称 1.1.2.3 id number 状态id 1.1.2.4 name string 状态名称 1.1.2.5 description string 状态的可读描述。 1.1.2.6 action string 应采取的消除错误的操作。 1.1.3 messageId string 唯一标识已发送消息的ID 1.2 bulkId string 唯一标识请求的ID。 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 错误的请求:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:WhatsAPP发送模板消息支持oAuth认证 URL:https:// 域名 /apiaccess/rest/ccmessaging/omni/1/advanced 请求头: {"x-app-key":"268e19b9-aae6-488a-bec6-5c9a67692946", "Authorization":"Bearer 2febd549********************b9daff1", "Content-Type":"application/json" } 请求参数: { "bulkId": "2853BC8B21D23F473AB9AE41B75F34FC18D322B91B01F60FAF206ACEBA9EF7BD", "whatsApp": { "templateName": "1", "templateData": [], "language": "zh_CN" }, "destinations": [ { "messageId": "46dbab11-f9cc-4d32-852b-cbba988b7d08", "to": { "phoneNumber": "155****8467" } } ] } 响应参数: { "messages": [ { "messageId": "10011", "to": { "phoneNumber": "173****6067" }, "status": { "groupName": "send-test", "groupId": 113, "name": "sendMessage", "description": "description", "id": 1 } } ], "bulkId": "20221025" }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 2 x-app-key string True appKey字段,用户标识,在ApiFabric工具上配置 3 Content-Type string True 内容类型 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 scenarioKey string False 唯一标识发送消息时将使用的方案的方案密钥。如果未设置此字段,将使用默认方案。 AICC不会发送此字段。 1.2 bulkId string True 唯一标识请求的ID。只有当您将消息发送到多个目标地址时,才会收到批量ID。 1.3 destinations array[object] True 消息收件人列表。 1.3.1 messageId string True 唯一标识已发送消息的ID 1.3.2 to object True 消息目的地地址 1.3.2.1 phoneNumber string True 目标电话号码。电话号码必须是国际格式(例如:41793026727) 1.4 whatsApp whatsApp True 封装的whatsapp对象 1.5 sendAt string False 要发送消息的日期和时间。用于计划的OMNI消息传递(OMNI流中的第一条消息不会立即发送,但会在计划的时间发送)。 表3 whatsApp参数结构 序号 名称 参数类型 是否必选 说明 1.1 text string False 将发送的消息的文本。 1.2 imageUrl string False WhatsApp消息中发送的图像的URL。最多2048个字符。支持的图像类型:jpg、jpeg、png。最大图像大小为2MB。 1.3 audioUrl string False WhatsApp消息中发送的音频文件的URL。最多2048个字符。支持的音频类型有AAC。最大音频大小为2MB。 1.4 videoUrl string False WhatsApp消息中发送的视频的URL。最多2048个字符。支持的视频类型为MP4。最大视频大小为10MB。 1.5 locationName string False 最大长度为1000。 将发送的消息的文本。 1.6 address string False 最大长度为1000。 地址位置,可选值。 1.7 longitude number False 坐标的经度。该值必须介于-180和180之间。 1.8 latitude number False 坐标的纬度。该值必须介于-90和90之间。 1.9 templateName string False 模板名称 1.10 templateData array[string] False 按模板中注册的顺序排序的模板参数值 1.11 language string False 要使用的语言或区域设置的代码。需要与注册模板时使用的代码完全相同。 1.12 mediaTemplateData mediaTemplateData False mediaTemplateData封装对象 表4 mediaTemplateData参数结构 序号 名称 参数类型 是否必选 说明 1.1 header HeaderObject False 媒体模板标题。对于包含标题的媒体模板是必需的。 1.2 body BodyObject False 媒体模板体 1.3 buttons array[object] False 媒体模板按钮 表5 HeaderObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 textPlaceholder string False 文本占位符。对于包含文本标题的模板是必需的。 1.2 imageUrl string False 图像URL。对于包含图像标题的模板是必需的。支持的图像类型:jpg、jpeg、png。最大图像大小为2MB。 1.3 videoUrl string False 视频URL。对于包含视频标题的模板是必需的。支持的视频类型为MP4。最大视频大小为10MB。 1.4 latitude number False 位置纬度。该值必须介于-90和90之间。对于包含位置标题的模板是必需的。 1.5 longitude number False 位置经度。该值必须介于-180和180之间。对于包含位置标题的模板是必需的。 表6 BodyObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 placeholders array[string] False 媒体模板正文占位符。该值不能为空,但可以是空数组。数组中的值不能为Null或空 表7 ButtonObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 urlPlaceholder string False 要发送消息的日期和时间。用于计划的OMNI消息传递(OMNI流中的第一条消息不会立即发送,但会在计划的时间发送)。 1.2 quickReplyPayload string False 快速回复有效载荷。快速回复按钮需要 表8 destinations参数结构 序号 名称 参数类型 是否必选 说明 1.1 messageId string True 唯一标识已发送消息的ID 1.2 to toObject True 消息目的地地址 表9 MessageObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 to toObject False 消息目的地地址 1.2 status StatusObject False 指示消息是否已成功发送、未发送、已传递、未传递、正在等待传递或任何其他可能的状态。 1.3 messageId string False 唯一标识已发送消息的ID 表10 toObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 phoneNumber string True 目标电话号码。电话号码必须是国际格式(例如:41793026727)。 表11 StatusObject参数结构 序号 名称 参数类型 是否必选 说明 1.1 groupName string True 状态组名称 1.2 id integer True 状态ID 1.3 groupId integer True 状态组ID 1.4 name string True 状态名称 1.5 action string False 应采取的消除错误的操作 1.6 description string True 状态的可读描述
  • 座席类型 表1 座席类型 数值 座席类型 描述 0 AGENT_TYPE_EXTENSION 分机类型 1 AGENT_TYPE_USERLINE 用户线类型 2 AGENT_TYPE_1B1D 1B+D座席(包括TUA,长通电话座席) 3 AGENT_TYPE_SINGLE_PHONE 单非长通电话座席 4 AGENT_TYPE_PC_PHONE PC+PHONE座席 5 AGENT_TYPE_ISDN_2BD 视频座席,2B+D座席 6 AGENT_TYPE_ISDN_6BD 视频座席,6B+D座席 7 AGENT_TYPE_1B1D_PHONE 话机座席,对CTI侧,类似于1B+1D座席 8 AGENT_TYPE_MANAGER 配置管理座席 9 AGENT_TYPE_NB1D nB+D座席 10 AGENT_TYPE_NET 网络座席 11 AGENT_TYPE_PC_PHONE_VIDEO 视频座席(具有音频、视频能力) 12 AGENT_TYPE_SINGLE_PHONE_VIDEO 单电话视频座席 13 AGENT_TYPE_EMEDIA 多媒体类型坐席
  • 样例报文 请求头: 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,获取方式参见查询指定座席的私有呼叫。
  • 样例报文 请求头: 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 } ] }
  • 响应消息 表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 座席当前的私有呼叫数目
  • 请求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
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0410000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:申诉件审核 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "assignee": "1623922081217484235", "auditOperation": "pass", "callId": "fcbd13e7-ede6-4150-8f20-1867261f313c", "coment": "aaa", "taskInfoId": "16239231508327803347" } 响应参数: { "resultCode": "0410000", "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 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 auditOperation string False 审核操作类型(back=退回,pass=通过,assign = 指派其他人) 1.2 callId string False 通话质检标识 1.3 coment string False 审核备注批语 1.4 taskInfoId string False 质检件任务标识 1.5 assignee string False 被指派人(质检组长/主管指派其他人办理) 1.6 role string False 质检人员标识
  • 样例报文 请求头: 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" } ] }
  • 样例报文 请求头: 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" } ] }
  • 响应消息 表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
  • 报文样例 该接口的请求消息体举例如下: {"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" }
  • 错误结果码 表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 参数个数不能大于规定个数
  • 请求说明 表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 请求类型
共100000条