文档首页/ 云客服/ API参考/ 网页客户端接入/ 更多接口参考/ 调用PS7接口(chat_itau_contextos)
更新时间:2025-03-07 GMT+08:00

调用PS7接口(chat_itau_contextos)

场景描述

调用PS7接口。

接口方法

POST

接口URI

https://域名/apiaccess/rest/ccmessaging/v1/itau/ps7/contextos,例如域名是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

传值则传递给下游,没有传值则生成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

响应说明

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