文档首页/ 云客服/ API参考/ 网页客户端接入/ 更多接口参考/ 根据电话查询客户信息(chat_itau_telefone)
更新时间:2025-03-07 GMT+08:00

根据电话查询客户信息(chat_itau_telefone)

场景描述

根据电话查询客户信息。

接口方法

POST

接口URI

https://域名/apiaccess/rest/ccmessaging/v1/itau/telefone,例如域名是service.besclouds.com

请求说明

表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

数字服务

响应说明

  • 响应状态码: 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

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例

场景描述:根据电话查询客户信息

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"
  }
}