Help Center/ Cognitive Engagement Center/ API Reference/ Web Client Access Interface Reference/ Additional API References/ Invoking the PS7 System (chat_itau_contextos)
Updated on 2025-03-31 GMT+08:00
View PDF
Share

Invoking the PS7 System (chat_itau_contextos)

Scenario

This interface is invoked to invoke the PS7 system.

Method

POST

URI

https://Domain name/apiaccess/rest/ccmessaging/v1/itau/ps7/contextos (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

x-itau-apikey

String

No

Value of client_id generated during OAuth identity authentication, which is used to authorize the customer to consume the requested application

2

x-itau-correlationID

String

No

Correlation ID, which identifies a group in the audit trail structure and correlates the same calls passed in several different applications/systems

3

x-itau-flowID

String

No

If a value is transferred, it is passed to the downstream system. If no value is transferred, a UUID is generated and passed to the downstream system.

4

userName

String

Yes

Interface authentication username

5

password

String

Yes

Interface authentication password
Table 2 Request body parameter

No.

Parameter

Type

Mandatory or Not

Description

1.1

contextId

String

Yes

Context ID

1.2

encoded

String

No

The options are as follows:

  • 0: The contextId value is transparently transmitted.
  • Other values: The contextId value encoded using Base64 is transparently transmitted.
  • If no value is passed, the contextId value encoded using Base64 is transparently transmitted.

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Description

    1.1

    message

    String

    Response message

    1.2

    key

    String

    Key generated by the API

    1.3

    expireIn

    String

    Remaining time before the payload expires

    1.4

    decodedContextId

    String

    Decoding context ID

    1.5

    payload

    Object

    Response message body

    1.5.1

    u_cpf

    String

    Natural person registration number, which is obtained from the Itau PS7 system

    1.5.2

    u_ag

    String

    Agent number, which is obtained from the Itau PS7 system

    1.5.3

    u_cc

    String

    Bank account, which is obtained from the Itau PS7 system

    1.5.4

    u_seg

    String

    Segment number, which is obtained from the Itau PS7 system

    1.5.5

    u_dest

    String

    IVR-30 hours option, which is obtained from the Itau PS7 system

    1.5.6

    u_numA

    String

    Customer phone number

    1.5.7

    u_id

    String

    The value is obtained from the Itau PS7 system. The options are AUT, NID, and IDE.

    1.5.8

    u_dseg

    String

    The value is obtained from the Itau PS7 system. The options are Token, CSI, and none.

    1.5.9

    u_dsok

    String

    The value is obtained from the Itau PS7 system. The options are S and N.

    1.5.10

    u_tpid

    String

    ID card number, which is obtained from the Itau PS7 system.

    1.5.11

    contexto

    Object

    The value is obtained from the payload field in the response.

    1.6

    code

    String

    The options are 0 (success) and 1 (failure).
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

  • Scenario: Create an outbound call task.
  • Request header 
    x-app-key : xxxxxx
x-itau-apikey : 12323213 
Content-Type : application/json
userName:chat_itau_oiap
password:****************
  • Request parameters 
    {
    "contextId":"123123213" 
}
  • Response parameters 
    {
    "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"
         }
    }
}