华为云用户手册

报文样例 场景描述：创建外呼任务 请求头： { "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!" }

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

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

报文样例 场景描述：创建外呼任务 请求头： 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" } } }

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

响应消息 表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 指标结果，该时间为零时区时间。

样例报文 请求头： 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" } ] }

报文样例 场景描述：根据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" } }

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

请求说明 表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 客户唯一标识符。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":4, "agentIds":[11,12], "indexIds":["IDX_DURATION_AGENT_REST","IDX_COUNT_AGENT_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_AGENT_REQUEST" }, { "val": "35", "id": "IDX_DURATION_AGENT_REST" } ], "id": "11" }, { "idxs": [ { "val": "5", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "15", "id": "IDX_DURATION_AGENT_REST" } ], "id": "12" } ], "resultDesc": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "35", "id": "IDX_DURATION_AGENT_REST" } ], "id": "11" }, { "idxs": [ { "val": "5", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "15", "id": "IDX_DURATION_AGENT_REST" } ], "id": "12" } ] }

报文样例 场景描述：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" }

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

请求说明 表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 状态的可读描述

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "queryParam": { "ccId":1, "vdn":1, "skillId":1 } } 请求参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "workNo": 20011, "name": "20011", "status": 4, "ctiStatus": 1, "groupId": 1, "mediaType": 1, "vdnId": 1, "phoneNumber": "70942", "currentStateTime": 1505, "loginDate": 1501125758000 } ], "resultDesc": [ { "workNo": 20011, "name": "20011", "status": 4, "ctiStatus": 1, "groupId": 1, "mediaType": 1, "vdnId": 1, "phoneNumber": "70942", "currentStateTime": 1505, "loginDate": 1501125758000 } ] }

响应消息 表3 消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.12及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.12及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 workNo int 座席工号。 2.2 name string 座席名称。 2.3 status int 座席状态，参数说明请参考表5。 2.4 ctiStatus int 座席平台状态，参数说明请参考CTI平台座席状态码参考 2.5 groupId int 座席班组ID。 2.6 mediaType int 座席媒体类型，请参见表1 2.7 vdnId int 所属VDN ID。 2.8 phoneNumber string 座席电话号码。 2.9 currentStateTime long 当前状态时长。(秒) 2.10 loginDate long 签入时间。（毫秒级时间戳） 表5 座席状态 值 说明 0 未知。对应CTI平台状态的9。 2 表示调用该接口出现异常。 3 示忙状态。对应CTI平台状态的7。 4 空闲状态。对应CTI平台状态的1。 5 整理态。对应CTI平台状态的6。 7 通话态。对应CTI平台状态的2、3、4、5。 8 休息状态。对应CTI平台状态的8。

请求说明 表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 skillId Int True 技能队列编号。 取值范围：1～2000

更多接口参考 除了以上两类场景，其他的CC-Messaging接口请参考本章。 创建匿名通话 (createcall) 丢弃邮件（chat_dropMail） 提供whatsapp发送下行消息（sendWhatsappMessage） 查询在线交谈工作台当前交谈的消息（getUserInfoBycallId） 根据电话查询客户信息（chat_itau_telefone） 根据email查询客户信息（ chat_itau_email） 根据客户CPF或CNPJ查询客户信息（chat_itau_cpfcnpj） 调用PS7接口（chat_itau_contextos） 根据账户查询客户信息（chat_itau_contas） 根据账户查询客户信息（chat_itau_codigo） 根据clienteId查询客户数据（chat_itau_cliente） 根据投资人查询与会者（chat_itau_atendentes） 推送消息（pushMsg） 父主题： 网页客户端接入

报文样例 请求头: { "ccmessaging-token": "eyJjcmVhdGV*************2hhbm5lbElkIjoiMjAyMTAyMTkzMTk2ODY5NzA4In0%3D", "x-app-key": "ea5c29a3*************a3dbeb4c32c", "Authorization": "Bearer 57042f*************968c4e0", "Content-Type": "application/json" } 请求参数: { "feedback": 0, "feedbackContent": "dissatisfied", "from": "1111111", "interIdx": "2" } 响应参数: { "resultCode": "0", "resultDesc": "Send message to robot successfully" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 resultCode string 0：成功 30000000008：满意度调查时，不满意情况下，feedbackContent不允许未空 10010000002：接口流控失败 30010009999：Chat模块异常 30000000019：当前会话不是机器人会话或当前没有会话时不支持评价机器人 10010000001：接口认证失败 1.2 resultDesc string 失败原因描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 ccmessaging-token string True applyToken接口生成的ccmessagign-token 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 feedback integer True 反馈的满意度。 1：满意，0：不满意 1.2 feedbackContent string(64) False 当为0，不满意时，不允许为空，最大长度限制64字符 1.3 from string True 消息发送方的id 1.4 interIdx string True 交互次数，直接取上一次ODFS返回的interidx值即可。

报文样例 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "vdn":159, "offset":0, "limit":3, "beginTime":"2022-11-17 00:13:43", "endTime":"2022-11-17 23:44:13" } 响应参数： { "returnCode": "0", "total": 2, "missedCalls": [ { "callId": "1668048253-16797218", "callerNo": "1659960139858526939", "calleeNo": "6300111010", "waitBegin": "2022-11-17 23:44:13", "callEnd": "2022-11-17 23:44:25", "mediaType":53, "subMediaType":1 }, { "callId": "1668050023-1859", "callerNo": "88880990", "calleeNo": "31045665", "waitBegin": "2022-11-17 00:13:43", "callEnd": "2022-11-17 00:13:47", "mediaType":53, "subMediaType":1 } ], "returnDesc": "query success" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 vdn int True 虚拟呼叫中心编号。取值范围：1～5000 2 offset Number True offset用于确定查询的起始页偏移量。 offset取值范围为：offset=limit*(page-1) 3 limit Number True 查询条数，单次最大5000 4 beginTime String false 开始查询时间，零时区时间。 日期格式为：yyyy-MM-dd HH:mm:ss 5 endTime String false 结束查询时间，零时区时间。 日期格式为：yyyy-MM-dd HH:mm:ss

响应说明 表3 响应参数说明 参数名称 数据类型 是否必选 描述 returnCode String True 查询结果。取值范围： 0：成功 其他失败 total Number True 查询未接来电总条数。 missedCalls MissedCall[] True 未接来电详情列表，详细结果请参考表4。 returnDesc String false 查询结果描述。 表4 MissedCall参数说明 参数名称 数据类型 是否必选 描述 callId String M 呼叫id。 callerNo String M 主叫号码。 calleeNo String M 被叫号码。 waitBegin Datetime M 呼叫开始等待时间。 callEnd Datetime M 呼叫结束时间。 mediaType Int N 媒体类型，具体请参见表1。 subMediaType Int N 子媒体类型，具体请参见表3。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "callId": "1678978542-92", "logDate": "1615717765000" } 响应参数： { "resultCode":"0100000", "resultDesc": [{ "callId": "1678978542-92", "mediaType": "1", "subMediaType|: "1", "callIdNum": "-1", "callerNo": "80000888", "calleeNo": "624192", "waitBegin": "1615717765000",// 呼叫等待开始时间 "ackBegin": "1615717765000",// 呼叫应答时间 "callBegin": "1615717765000",// 通话开始时间 "callEnd": "1615717765000",// 通话结束时间 "subCcNo": "0", "deviceType": "1"， "deviceNo": "1", "deviceIn": "1", "callType": "1", "releaseCause": "1", // callIdNum=-1时有意义 "EnterReason": "11", "LeaveReason": "11", "CurrentSkillID": "0"， // 当前处理呼叫的技能队列编号 "mediaType":53, // 媒体类型 "subMediaType":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 callId string True 呼叫ID 4 logDate long True 查询时间，用于解析月份，查询指定表；毫秒级时间戳

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口返回的token值。 会话过程中接口Response Header中返回的ccmessaging-token的值。 2 x-app-key string True appKey字段，用户标识，在API Fabric上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody ReqBody True 请求体 表3 ReqBody参数结构 序号 名称 参数类型 是否必选 说明 1.1 fileType string True 文件类型，支持jpg，png，bmp，mp3，aac，mp4，txt，csv。 1.2 fileStream string True Base64编码后的文件流。 1.3 channel string True 发送文件流渠道，当前只支持WEB。