华为云用户手册

报文样例 场景描述：根据客户输入联想常用语 请求头: ccmessaging-token： XXXXXXXXX 请求参数: { "strContent": "网格", "locale": "zh", "channel": "WEB" } 响应参数: { "question": [ "APP在哪里下载", "APP怎么登录？", "APP支持什么手机版本", "登录APP后，没有下单功能菜单权限", "PC端系统怎么登录" ], "resultCode": "0" }

报文样例 场景描述：根据账户查询客户信息。 URL：https:// 域名 /apiaccess/rest/ccmessaging/v1/itau/contas 请求头： x-app-key ：xxxx x-itau-apikey ： xxx Content-Type ：application/json userName:xxx password:xxx 请求参数： { "id_conta": "111" } 响应参数： { "data": { "id_cliente": "string", "nome": "string", "telefone": "string", "conta_corrente": "string", "agencia": "string", "email_gerente": "string", "racf_gerente": "string", "funcional_gerente": "string", "segmento": "string", "cod_carteira": "string", "plataforma": "string", "atendimento_plataforma_digital": "string", "codigo_papel": "string", "tipo_estrutura": "string", "identificado": "string" } }

响应说明 响应状态码: 200 表3 itau_response_body参数结构 序号 名称 参数类型 是否必选 说明 1.1 data object False 数据 1.1.1 id_cliente string False 客户端标识 1.1.2 nome string False 命名 1.1.3 telefone string False 手机 1.1.4 conta_corrente string False 接触 1.1.5 agencia string False 通讯 1.1.6 email_gerente string False 电子邮件 1.1.7 racf_gerente string False 管理者 1.1.8 funcional_gerente string False 功能管理者 1.1.9 segmento string False 段 1.1.10 cod_carteira string False 组合 1.1.11 plataforma string False 平台 1.1.12 atendimento_plataforma_digital string False 数字平台服务 1.1.13 codigo_papel string False 纸质代码 1.1.14 tipo_estrutura string False 结构 1.1.15 identificado string False 身份证明 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-itau-apikey string False Oauth身份验证生成的client_id，用于授权消费请求应用程序。 2 x-itau-correlationID string False 关联标识符用作审计跟踪结构中的组，并允许将在几个不同的应用程序/系统中传递的相同调用关联起来。 3 x-itau-flowID string False 流ID 4 userName string True apifabric接口认证用户名 5 password string True apifabric接口认证密码 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 id_conta string True 账户

响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 说明 1 resultCode String 0表示成功，如果返回的响应状态码不是200或resultCode不为0，则表示推送消息失败。 2 resultDesc String 开发人员自定义 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头： Authorization:Bearer e******************************e x-app-key:e******************************0 Content-Type:application/json 请求参数： //1connected { "timestamp": 1625898453913, "messages": [{ "from": "202105284494222653", "channel": "WEB", "to": "44444444", "controlType": "CHAT", "mediaType": "TEXT", "content": "The call is connected to an agent.", "simQuestions": null, "senderNickname": "SYSTEM", "timestamp": 1625898453913, "sourceType": "SYSTEM", "callId": null, "messageCode": null }] } //queuing { "from": "202105284494222653", "channel": "WEB", "to": "44444444", "controlType": "CHAT", "mediaType": "TEXT", "content": "Queuing...", "simQuestions": null, "senderNickname": "SYSTEM", "timestamp": 1625898453913, "sourceType": "SYSTEM", "messageCode": null } //disconnect because of agent { "from": "202105284494222653", "channel": "WEB", "to": "44444444", "controlType": "DISCONNECT", "mediaType": null, "content": null, "simQuestions": null, "senderNickname": null, "timestamp": 1625898871961, "sourceType": "AGENT", "messageCode": null } //disconnect because of timeout, and async switch is off { "from": "202105284494222653", "channel": "WEB", "to": "44444444", "controlType": "DISCONNECT", "mediaType": null, "content": null, "simQuestions": null, "senderNickname": null, "timestamp": 1625898871961, "sourceType": "SYSTEM", "messageCode": null } //disconnect because of timeout, and async switch is on { "from": "202105284494222653", "channel": "WEB", "to": "44444444", "controlType": "DISCONNECT", "isOfflineStatus":true, "mediaType": "TEXT", "content": "{TIPS}", "simQuestions": null, "senderNickname": null, "timestamp": 1625898871961, "sourceType": "SYSTEM", "messageCode": null } //read { "from": "202105284494222653", "channel": "WEB", "to": "44444444", "controlType": "READ", "mediaType": null, "content": "messageId1,messageId2", "simQuestions": null, "senderNickname": null, "timestamp": 1625898871961, "sourceType": "AGENT", "messageCode": null } 响应参数： { "resultCode": "0", "resultDesc": "success." }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string true appKey字段，用户标识，在API Fabric上配置 2 Authorization string true 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 messages list[DownLinkMsg] True 消息和事件 2 timestamp long True 发送时间，将用于生成身份验证签名。 表3 DownLinkMsg参数结构 序号 名称 参数类型 是否必选 说明 1 channel string True 消息通道类型，如WEB。 2 isOfflineStatus Boolean False 用于客户端判断下一步是否可以发送消息。 当用户等待超时时，AICC将推送消息。 如果异步开关打开，则该值将为true。 如果异步开关关闭，则该值将为false。 3 content string True 发送给客户的MT消息的内容。 如果controlType为聊天，则 如果媒体类型为文本， 取值为文本内容。 如果mediaType为图像/视频/AUDIO，则值为资源的id，客户端应使用下载文件流API获取资源。 如果mediaType为LOCATE，则取值为位置信息，格式为纬度/经度/描述。如果controlType为读取，则该值为已读取的messageId数组。 4 from string True 消息发送者的ID。渠道ID。 5 mediaType string True 消息媒体类型，例如文本类型（TEXT）、图像（IMAGE）、视频（VIDEO）、语音（AUDIO）、位置（LOCATE）和文档（DOCUMENT）。 6 senderNickname string False 消息发送者的昵称。 7 sourceType string True 消息发送者，例如代理（代理）、机器人（机器人）和系统（系统）。 8 controlType string True 消息控制类型，如连接（连接）聊天（聊天）和断开（断开）、转人工服务（Trans2Agent）、读取报告（读取） 9 timestamp long True 消息发送时间戳。 10 to string True 用户标识 11 simQuestions string False 相似性问题内容。 12 messageCode string False 用于标识发送的消息代理的唯一值。最大长度为64。

报文样例 场景描述：根据电话查询客户信息 URL：https://域名/apiaccess/rest/ccmessaging/v1/itau/telefone 请求头： x-app-key ：xxxxxx x-itau-apikey ： 12323213 Content-Type ：application/json userName:chat_itau_oiap password:**************** 请求参数： { "telefone": "string", "tipo_estrutura": "string", "ddi": "string" } 响应参数： { "data": { "id_cliente": "b26e641a-71f5-4117-ad0d-4d753faebb16", "data_abertura_conta": "", "nome_completo": "", "nome_fantasia_apelido": "", "tipo_pessoa": "", "data_nascimento_fundacao": "", "gerentes": { "email_gerente": "gerente@itau-unibanco.com.br", "racf_gerente": "", "funcional_gerente": "", "segmento": "", "cod_carteira": "", "plataforma": "", "atendimento_plataforma_digital": "", "codigo_papel": "", "descricao_categoria": "", "tipo_estrutura": "", "telefones": { "principal": "", "celular": "", "ddi": "", "ddd": "", "numero": "", "ramal": "" } }, "identificado": "Identificado", "cpf_cnpj": "", "nome_social": "", "agencia": "1501", "conta_corrente": "098797" } }

响应说明 响应状态码: 200 表3 itau_response_body参数结构 序号 名称 参数类型 是否必选 说明 1.1 data object False 数据 1.1.1 id_cliente string False 客户端标识 1.1.2 emails array[object] False 邮件信息 1.1.2.1 principal string False 是否为主邮件 1.1.2.2 email string False 邮件地址 1.1.2.3 data_atualizacao string False 更新时间 1.1.3 data_abertura_conta string False 开户日期 1.1.4 nome_completo string False 完整名称 1.1.5 nome_fantasia_apelido string False 简称 1.1.6 tipo_pessoa string False 性别 1.1.7 data_nascimento_fundacao string False 出生日期 1.1.8 gerentes gerentes False 管理信息 1.1.9 telefones array[telefones] False 手机信息 1.1.10 identificado string False 识别信息 1.1.11 cpf_cnpj string False 普通编号 1.1.12 nome_social string False 合法名称 1.1.13 agencia string False 代理机构 1.1.14 conta_corrente string False 常用账户 表4 gerentes参数结构 序号 名称 参数类型 是否必选 说明 1.1 email_gerente string False 邮件地址 1.2 racf_gerente string False 管理者 1.3 funcional_gerente string False 功能管理者 1.4 segmento string False 段 1.5 cod_carteira string False 组合 1.6 plataforma string False 平台 1.7 atendimento_plataforma_digital string False 数字平台服务 1.8 codigo_papel string False 纸质代码 1.9 descricao_categoria string False 类别 1.10 tipo_estrutura string False 结构 1.11 telefones telefones False 手机信息 1.12 codigo_cargo string False 用于选择将分配到AGD/AGF媒体的技能队列。 表5 telefones参数结构 序号 名称 参数类型 是否必选 说明 1.1 principal string False 是否为主手机 1.2 celular string False 手机 1.3 ddi string False ddi 1.4 ddd string False 主叫号码前两位 1.5 numero string False 数 1.6 ramal string False 扩展 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-itau-apikey string False Oauth身份验证生成的client_id，用于授权消费请求应用程序。 2 x-itau-correlationID string False 关联标识符用作审计跟踪结构中的组，并允许将在几个不同的应用程序/系统中传递的相同调用关联起来。 3 x-itau-flowID string False 流ID 4 userName string True apifabric接口认证用户名 5 password string True apifabric接口认证密码 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 telefone string True 电话号码 1.2 tipo_estrutura string False 结构类型，例如：AP, OP, SD, CO 1.3 ddi string False 国家码 1.4 segmento string False 客户分群 1.5 servico_digital string False 数字服务

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":4, "skillIds":[11,12], "indexIds":["IDX_DURATION_SKILL_AVG_ABANDON_ACK","IDX_COUNT_SKILL_REQUEST"], "beginDayTime":"2020-08-21 00:00:00", "endDayTime":"2020-08-22 00:00:00", "mediaType":53, "subMediaType":3 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "11" }, { "idxs": [ { "val": "5", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "15", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "12" } ], "resultDesc": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "11" }, { "idxs": [ { "val": "5", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "15", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "12" } ] }

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":1, "callId":"1453723531-574" } 响应消参数： { "result": "0", "resultCode": "0100000", "resultDatas": { "time": 1606115215000, "dsn": 0, "handle": 0, "server": 0, "keyId": "", "callingNum": "88881364", "calledNum": "650550", "mid": 5, "trunkNo": 582, "priority": 0, "deviceType": 2, "deviceNo": 1177, "callSkill": "defaultAudioSkill", "partyNum": 1, "callFeature": 0, "orgiCalledNum": "", "mediaType": 5, "place": 0, "waitTime": 0, "totalTalkingTimes": 275, "logonTimes": 284, "serviceType": 2, "callInCause": 65535, "enterReason": 0, "mediaBillType":0 }, "resultDesc": { "time": 1606115215000, "dsn": 0, "handle": 0, "server": 0, "keyId": "", "callingNum": "88881364", "calledNum": "650550", "mid": 5, "trunkNo": 582, "priority": 0, "deviceType": 2, "deviceNo": 1177, "callSkill": "defaultAudioSkill", "partyNum": 1, "callFeature": 0, "orgiCalledNum": "", "mediaType": 5, "place": 0, "waitTime": 0, "totalTalkingTimes": 275, "logonTimes": 284, "serviceType": 2, "callInCause": 65535, "enterReason": 0, "mediaBillType":0 } }

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

请求说明 表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 呼叫callId，最大长度20。 参数值为时间戳-呼叫编号，其中时间戳为呼叫开始时间，必须为毫秒级时间戳。 例如：1659513159000-546750

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "skillIds":[1,2] } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "skillId": 1, "callPropertyExs": [] }, { "skillId": 2, "callPropertyExs": [ { "requestType": 0, "callPriority": 0, "waitTime": 0, "callQueueFlag": 1, "callId": "1607392439000-379", "customerLevel": 0, "calling": "1233", "called": "34565", "mediaType": "MEDIA_TYPE_PHONE", "orgiCalled": "234545", "callInTime": 1223455666 } ] } ], "resultDesc": [ { "skillId": 1, "callPropertyExs": [] }, { "skillId": 2, "callPropertyExs": [ { "requestType": 0, "callPriority": 0, "waitTime": 0, "callQueueFlag": 1, "callId": "1607392439000-379", "customerLevel": 0, "calling": "1233", "called": "34565", "mediaType": "MEDIA_TYPE_PHONE", "orgiCalled": "234545", "callInTime": 1223455666 } ] } ] }

响应消息 表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 skillId int 技能队列编号 2.2 callPropertyExs array 在该技能上排队的呼叫数组。 该数组中对象的参数说明请参见表5。 表5 callPropertyExs对象参数说明 序号 名称 参数类型 说明 2.2.1 callId string 呼叫ID 2.2.2 customerLevel int 呼叫客户级别 序号从1到254，编号越大，表明客户的地位越高，越重要 2.2.3 requestType int 呼叫特征，具体请参考表1。 2.2.4 calling array 主叫号码。 2.2.5 called array 被叫号码。 2.2.6 mediaType string 呼叫的媒体类型，不支持多媒体类型呼叫查询，参考表1 2.2.7 orgiCalled string 原始被叫。 呼叫在进入系统前被叫发生变化，则该参数记录的是首次被呼叫方的号码。 2.2.8 callInTime int 进入时间。（毫秒级时间戳） 2.2.9 callPriority long 呼叫优先级（参见《(For Engineer) ICD VxxxRxxxCxx 产品文档 01 (ICD)》配置技能组） 2.2.10 waitTime long 呼叫在本队列排队时长 2.2.11 callQueueFlag long 本队列是否为该呼叫的主队列。 1：表示是主队列 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。

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

报文样例 场景描述：创建外呼任务 请求头： { "X-APP-Key": "b*************c7b", "Authorization": "Bearer 1fea*************1d6a15", "Content-Type": "application/json" } 请求参数 无。 响应参数： { "satisfactionSurvey": { "surveyType": "WEB", "satisfactionLevel": [ { "satisfactionLevelDesc": "很不满意", "satisfactionLevelKey": "1" }, { "satisfactionLevelDesc": "不满意", "satisfactionLevelKey": "2" }, { "satisfactionLevelDesc": "一般", "satisfactionLevelKey": "3" }, { "satisfactionLevelDesc": "满意", "satisfactionLevelKey": "4" }, { "satisfactionLevelDesc": "很满意", "satisfactionLevelKey": "5" } ], "satisfactionQuestion": [ "FCR", " CS AT", "NPS" ] }, "resultCode": "0", "resultDesc": "Get satisfaction survey mode success!" }

报文样例 场景描述：创建外呼任务 请求头： x-app-key : xxxxxx x-itau-apikey : 12323213 Content-Type : application/json userName:chat_itau_oiap password:**************** 请求参数 { "contextId":"123123213" } 响应参数： { "expireIn": "2021-03-21", "key": "12311", "decodedContextId": "2", "payload": { "u_cpf": "CPF", "u_cc": "13156463165468461654", "u_ag": "Agency", "u_seg": "segment", "u_dest": "IVR-30hours chosen option", "u_numA": "Customer PhoneNumber", "u_dseg": "Token", "u_dsok": "S", "u_ion": "", "u_display": "", "u_ura": "", "u_fmt": "", "u_codop": "", "u_tag": "", "u_tpid": "S", "contexto": { "u_cpf": "CPF", "u_cssc": "13156463165468461654", "u_ag": "Agency", "u_seg": "segment", "u_dest": "IVR-30hours chosen option", "u_numA": "Customer PhoneNumber", "u_dseg": "Token", "u_dsok": "S", "u_ion": "", "u_display": "", "u_ura": "", "u_fmt": "", "u_codop": "", "u_tag": "", "u_tpid": "S" } } }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 message string 请求响应消息 1.2 key string api生成的key 1.3 expireIn string 有效负载到期剩余时间 1.4 decodedContextId string 解码上下文ID 1.5 payload object 请求响应消息体 1.5.1 u_cpf string 来源于ITAU PS7系统， 自然人注册号 1.5.2 u_ag string 来源于ITAU PS7系统， 代理号 1.5.3 u_cc string 来源于ITAU PS7系统，银行账号 1.5.4 u_seg string 来源于ITAU PS7系统， 段号 1.5.5 u_dest string 来源于ITAU PS7系统，选择IVR-30小时选项 1.5.6 u_numA string 客户电话号码 1.5.7 u_id string 值来源于ITAU PS7系统，枚举值：AUT/NID/IDE 1.5.8 u_dseg string 值来源于ITAU PS7系统，枚举值：Token/CSI/none 1.5.9 u_dsok string 值来源于ITAU PS7系统，枚举值：S/N 1.5.10 u_tpid string 来源于ITAU PS7系统， 身份证 1.5.11 contexto object 来源于响应的payload字段 1.6 code string 0成功；1失败 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-itau-apikey string False Oauth身份验证生成的client_id，用于授权消费请求应用程序。 2 x-itau-correlationID string False 关联标识符用作审计跟踪结构中的组，并允许将在几个不同的应用程序/系统中传递的相同调用关联起来。 3 x-itau-flowID string False 传值则传递给下游，没有传值则生成UUID给下游 4 userName string True 接口认证的用户名 5 password string True 接口认证的密码 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 contextId string True 上下文id 1.2 encoded string False 取值范围： 0：透传contextId 非0：透传Base64编码后的contextId 不传：透传Base64编码后的contextId

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":22, "agentIds":[295], "timeGrain":"15MIN", "indexIds":["IDX_COUNT_AGENT_COLLATION","IDX_COUNT_AGENT_SET_BUSY","IDX_DURATION_AGENT_CALL_IN"], "mediaType":53, "subMediaType":3 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "11" }, { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "12" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "11" }, { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "12" } ] }

响应消息 表3 响应消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 返回值为空时，表示当前座席未签入。 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 返回值为空时，表示当前座席未签入。 表4 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 id String 座席工号。 idxs array 指标结果集。 该对象的参数说明请参见表5。 表5 idx对象参数说明 参数名 数据类型 说明 id String 指标ID。 val Object 指标结果，该时间为零时区时间。

报文样例 场景描述：根据email查询客户信息 URL：https://域名/apiaccess/rest/ccmessaging/v1/itau/email 请求头： x-itau-apikey ： 12323213 Content-Type ：application/json userName:chat_itau_oiap password:**************** 请求参数： { "email":"94****396@qq.com", "tipo_estrutura": "string" } 响应参数： { "data": { "id_cliente": "b26e641a-71f5-4117-ad0d-4d753faebb16", "data_abertura_conta": "", "nome_completo": "", "nome_fantasia_apelido": "", "tipo_pessoa": "", "data_nascimento_fundacao": "", "gerentes": { "email_gerente": "gerente@itau-unibanco.com.br", "racf_gerente": "", "funcional_gerente": "", "segmento": "", "cod_carteira": "", "plataforma": "", "atendimento_plataforma_digital": "", "codigo_papel": "", "descricao_categoria": "", "tipo_estrutura": "", "telefones": { "principal": "", "celular": "", "ddi": "", "ddd": "", "numero": "", "ramal": "" } }, "identificado": "Identificado", "cpf_cnpj": "", "nome_social": "", "agencia": "1501", "conta_corrente": "098797" } }

响应说明 响应状态码: 200 表3 itau_response_body参数结构 序号 名称 参数类型 是否必选 说明 1.1 data object False 数据 1.1.1 id_cliente string False 客户端标识 1.1.2 emails array[object] False 邮件信息 1.1.2.1 principal string False 是否为主邮件 1.1.2.2 email string False 邮件地址 1.1.2.3 data_atualizacao string False 更新时间 1.1.3 data_abertura_conta string False 开户日期 1.1.4 nome_completo string False 完整名称 1.1.5 nome_fantasia_apelido string False 简称 1.1.6 tipo_pessoa string False 性别 1.1.7 data_nascimento_fundacao string False 出生日期 1.1.8 gerentes gerentes False 管理信息 1.1.9 telefones array[telefones] False 手机信息 1.1.10 identificado string False 识别信息 1.1.11 cpf_cnpj string False 普通编号 1.1.12 nome_social string False 合法名称 1.1.13 agencia string False 代理机构 1.1.14 conta_corrente string False 常用账户 表4 gerentes参数结构 序号 名称 参数类型 是否必选 说明 1.1 email_gerente string False 邮件地址 1.2 racf_gerente string False 管理者 1.3 funcional_gerente string False 功能管理者 1.4 segmento string False 段 1.5 cod_carteira string False 组合 1.6 plataforma string False 平台 1.7 atendimento_plataforma_digital string False 数字平台服务 1.8 codigo_papel string False 纸质代码 1.9 descricao_categoria string False 类别 1.10 tipo_estrutura string False 结构 1.11 telefones telefones False 手机信息 1.12 codigo_cargo string False 用于选择将分配到AGD/AGF媒体的技能队列。 表5 telefones参数结构 序号 名称 参数类型 是否必选 说明 1.1 principal string False 是否为主手机 1.2 celular string False 手机 1.3 ddi string False ddi 1.4 ddd string False 主叫号码前两位 1.5 numero string False 数 1.6 ramal string False 扩展 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-itau-apikey string False Oauth身份验证生成的client_id，用于授权消费请求应用程序。 2 x-itau-correlationID string False 关联标识符用作审计跟踪结构中的组，并允许将在几个不同的应用程序/系统中传递的相同调用关联起来。 3 x-itau-flowID string False 流ID 4 userName string True apifabric接口认证用户名 5 password string True apifabric接口认证密码 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 email string True 邮件地址 2 servico_digital string False 数字服务 3 segmento string False 客户分群 4 tipo_estrutura string False 结构类型，例如：AP, OP, SD, CO

报文样例 场景描述：根据电话查询客户信息 URL：https://域名/apiaccess/rest/ccmessaging/v1/itau/cliente 请求头： x-app-key ：xxxxxx x-itau-apikey ： 12323213 Content-Type ：application/json userName:chat_itau_oiap password:**************** 请求参数： { "id_cliente":"123123213" } 响应参数： { "data": { "id_cliente": "b26e641a-71f5-4117-ad0d-4d753faebb16", "data_abertura_conta": "", "nome_completo": "", "nome_fantasia_apelido": "", "tipo_pessoa": "", "data_nascimento_fundacao": "", "gerentes": { "email_gerente": "gerente@itau-unibanco.com.br", "racf_gerente": "", "funcional_gerente": "", "segmento": "", "cod_carteira": "", "plataforma": "", "atendimento_plataforma_digital": "", "codigo_papel": "", "descricao_categoria": "", "tipo_estrutura": "", "telefones": { "principal": "", "celular": "", "ddi": "", "ddd": "", "numero": "", "ramal": "" } }, "identificado": "Identificado", "cpf_cnpj": "", "nome_social": "", "agencia": "1501", "conta_corrente": "098797" } }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-itau-apikey string False Oauth身份验证生成的client_id，用于授权消费请求应用程序。 2 x-itau-correlationID string False 关联标识符用作审计跟踪结构中的组，并允许将在几个不同的应用程序/系统中传递的相同调用关联起来。 3 x-itau-flowID string False 流ID 4 userName string True apifabric接口认证用户名 5 password string True apifabric接口认证密码 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 id_cliente string True 客户唯一标识符。

响应说明 响应状态码: 200 表3 itau_response_body参数结构 序号 名称 参数类型 是否必选 说明 1.1 data object False 数据 1.1.1 id_cliente string False 客户端标识 1.1.2 emails array[object] False 邮件信息 1.1.2.1 principal string False 是否为主邮件 1.1.2.2 email string False 邮件地址 1.1.2.3 data_atualizacao string False 更新时间 1.1.3 data_abertura_conta string False 开户日期 1.1.4 nome_completo string False 完整名称 1.1.5 nome_fantasia_apelido string False 简称 1.1.6 tipo_pessoa string False 性别 1.1.7 data_nascimento_fundacao string False 出生日期 1.1.8 gerentes gerentes False 管理信息 1.1.9 telefones array[telefones] False 手机信息 1.1.10 identificado string False 识别信息 1.1.11 cpf_cnpj string False 普通编号 1.1.12 nome_social string False 合法名称 1.1.13 agencia string False 代理机构 1.1.14 conta_corrente string False 常用账户 表4 gerentes参数结构 序号 名称 参数类型 是否必选 说明 1.1 email_gerente string False 邮件地址 1.2 racf_gerente string False 管理者 1.3 funcional_gerente string False 功能管理者 1.4 segmento string False 段 1.5 cod_carteira string False 组合 1.6 plataforma string False 平台 1.7 atendimento_plataforma_digital string False 数字平台服务 1.8 codigo_papel string False 纸质代码 1.9 descricao_categoria string False 类别 1.10 tipo_estrutura string False 结构 1.11 telefones telefones False 手机信息 表5 telefones参数结构 序号 名称 参数类型 是否必选 说明 1.1 principal string False 是否为主手机 1.2 celular string False 手机 1.3 ddi string False ddi 1.4 ddd string False 主叫号码前两位 1.5 numero string False 数 1.6 ramal string False 扩展 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。