Data

The Conversation Data URL endpoint can be used to retrieve all conversation variables and tags information about a specific conversation by either unique id, user id or user phone number.

Request

The following request will generate a new Share URL:

curl --location --request GET 'https://<NODE>.xenioo.com/conversation/data/<query>' \
--header 'Authorization: Bearer <BOT_AUTH_TOKEN>' \

The mode parameter can have the following values

ValueDescription

query

It can be either the unique id of the conversation, the user id or the user phone number

Response

If the call is successful, a payload containing all conversation variables and tags will be returned:

{
    "Id": "<unique conversation id>",
    "UserId": "<unique user id>",
    "Variables": [
        
        {
            "Name": "first_name",
            "Value": "Mario"
        },
        {
            "Name": "last_name",
            "Value": "Rossi"
        }
        [...]
    ],
    "Tags": [
        "some_vip_tag",
        [...]
    ]
}

Response Codes

This endpoint will reply with the following standard HTTP codes.

Code

Meaning

200

Success. The conversation exist and data has been retrieved.

400

Bad Request. The supplied token is not authorized to this request.

401

Unauthorized. The account associated to the token is not authorized

404

Not Found. The specified conversation has not been found

Last updated