ChatMaxima Docs

Channel Accounts API - List Connected Channels

List the WhatsApp, Instagram, Messenger, Telegram, SMS, email and web chat accounts connected to your workspace, and get the account_id that every send needs.

Overview

The Channel Accounts API lists every messaging channel connected to your ChatMaxima workspace: WhatsApp numbers, Instagram accounts, Facebook pages, Telegram bots, SMS numbers, email inboxes and website chat widgets. Each one has an account_id, and that id is how you tell the Send Messages API, the WhatsApp Templates API and WhatsApp Webhooks which channel to use.

Call it once when you set up your integration, store the ids you need, and call it again whenever you connect a new channel.

Prerequisites

  • An API key on a plan with API access (Pro or higher). See ChatMaxima API.
  • At least one connected channel. See Channels.

List channel accounts

curl -G https://chatmaxima.com/api/v2/channels/accounts/ \
  -H "Authorization: YOUR_API_KEY" \
  --data-urlencode "platform=WhatsApp,Instagram"
Query parameterRequiredDescription
platformNoComma-separated channel names to filter by. Leave it out to list every channel. Not case-sensitive.

Accepted platform values: WhatsApp, Instagram, Facebook, Telegram, SMS, Email, Ticket, Web, GoHighLevel, WhatsApp Voice, Twilio Voice and Exotel. WhatsApp covers every kind of WhatsApp connection.

Response

{
  "status": "success",
  "code": 200,
  "data": [
    {
      "account_id": "a1b2c3d4e5f6",
      "account_name": "Acme Support",
      "platform_name": "WhatsApp",
      "account_identifier": "+15550000000",
      "account_status": "active",
      "account_created_datetime": "2026-01-15 09:30:00"
    },
    {
      "account_id": "g7h8i9j0k1l2",
      "account_name": "Acme Store",
      "platform_name": "Instagram",
      "account_identifier": "acmestore",
      "account_status": "active",
      "account_created_datetime": "2026-02-02 14:10:00"
    }
  ],
  "meta": { "total": 2 }
}

Response fields

FieldDescription
account_idThe id to pass as account_id in send and webhook requests.
account_nameThe name shown in ChatMaxima.
platform_nameThe channel, for example WhatsApp, Instagram or Web.
account_identifierHow customers reach this channel (see below).
account_statusactive, or pending while a channel is still being verified.
account_created_datetimeWhen the channel was connected, in UTC.

What account_identifier contains

Channelaccount_identifier
WhatsApp, SMS, voiceThe connected phone number.
InstagramThe Instagram username.
Facebook MessengerThe Facebook page name.
TelegramThe bot's username.
Email and TicketsThe connected email address.
Web chatThe website URL.

Results are sorted by account name. Every connected channel is returned in one response, with no paging.

Using the account_id

  • Sending: pass it as account_id to the Send Messages API. Only active accounts can send. A pending account returns 422 ACCOUNT_INACTIVE.
  • WhatsApp templates and session messages: pass a WhatsApp account_id when your workspace has more than one WhatsApp number.
  • Webhooks: pass it when you create a WhatsApp webhook to receive events for one number only.

Errors

This endpoint returns only the common authentication, plan and rate-limit errors listed on the API overview. An unknown platform value returns an empty list.

Next Steps

इस पृष्ठ पर