Working with channels in the WazzaBee API

GET /v1/channels

Get the list of connected channels available to the current integration.

URL

GET https://api.wazzabee.com/api-gateway/v1/channels

Headers

Authorization: Bearer YOUR_API_KEY

Query parameters

None. The endpoint takes no parameters: it returns every channel available to the current API key.

Request example

curl -X GET "https://api.wazzabee.com/api-gateway/v1/channels" \
  -H "Authorization: Bearer YOUR_API_KEY"

Successful response (200 OK)

{
  "success": true,
  "channels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "WhatsApp Main",
      "type": "whatsapp_qr",
      "status": "active"
    },
    {
      "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "name": "WhatsApp WABA",
      "type": "whatsapp_waba",
      "status": "active"
    },
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Telegram Bot",
      "type": "telegram_bot",
      "status": "active"
    }
  ]
}

Response field reference

Field	Type	Description
`channels`	array	The array of available channels
`channels[].id`	string (UUID)	The unique channel ID. Use it in other requests (`channelId`)
`channels[].name`	string	The channel name set by the user
`channels[].type`	string	Channel type (see the table below)
`channels[].status`	string	Status: `active`, `inactive`, `error`

Channel types

Type (`type`)	Description
`whatsapp_qr`	WhatsApp via QR code (personal number)
`whatsapp_waba`	WhatsApp Business API (official)
`telegram_bot`	Telegram via a bot
`telegram_personal`	Telegram via a personal account

Filtering channels by integration

In the integration settings you can choose which channels a particular API key has access to:

No channels listed: the API key sees every channel in the account
Channels listed: the API key sees only the listed channels

This is handy if you have several integrations with different access rights.

💡 Tip: Call this endpoint first to get the channel id values you need for all the other requests.

Possible errors

This endpoint can only return authorisation errors (401, 403). If there are no channels, you get an empty array, not an error.