List

This endpoint will retrieve the list of all the bots that are currently available in the account specified by the token.

Request

The following request will retrieve the list of chatbots:

curl --location --request GET 'https://<SERVICE ENDPOINT>/bots' \
--header 'Authorization: Bearer <ACCOUNT_AUTH_TOKEN>' \
--header 'Content-Type: application/json'

Response

If successful, the response will contain the list of all the bots available. Bots information contains all the channels that are currently online. If the bot is not using any channel, the Channels collection will be empty.

{
    "Result": [        
        {
            "Name": "WhatsApp TESTER",
            "Description": "New Bot Description",
            "APIKey": "<bot api key>",
            "APISecret": "<bot api secret>",
            "Avatar": "https://someserver/someimage.jpg",
            "Channels": [
                "WhatsApp",
                "Web"
            ]
        },
        {
            "Name": "Web Share Test",
            "Description": "New Bot Description",
            "APIKey": "<bot api key>",
            "APISecret": "<bot api secret>",
            "Avatar": "",
            "Channels": [
                "Telegram"
            ]
        }
    ]
}

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 supplied token is invalid or does not have enough permissions.
404	Not Found. The account specified by the token could not be found.