Entries

The Entries endpoint can be used to retrieve the full list of all conversational parts associated with a user conversation.

This endpoint is not mean to be used to continuously retrieve conversation exchange state in realtime by polling. Requests made to the same conversation id are throttled to a 2 minutes window.

Request

The following request can be used to retrieve a bot audiences:

curl --location --request GET 'https://publicapi.xenioo.com/peoples/conversations/<ID>' \
--header 'Authorization: Bearer <BOT_AUTH_TOKEN>' \

The ID parameter can be either a conversation id or a user id. For phone based channels conversations, a user phone number can also be used as an id.

Response

If the call is successful, the full list of all conversation contents will be returned. The format will be similar to standard API Channel chat responses.

[
    {
        "Id": "...",
        "Source": 0,
        "ControlType": 1,
        "Date":"...",
        "Parts":[
            {
                "Type":0,
                "Text":"hello there!"
            }
        ]
    }
]

Response Codes

This endpoint will reply with the following standard HTTP codes.

Code

Meaning

200

Ok. The request has been successfully fulfilled.

400

Bad Request. The call does not contain the data required to be fulfilled or you attempted to access the same conversation during the 2 minutes throttling.

401

Unauthorized. The account associated to the token is not authorized

Last updated