Skip to content

Connect WhatsApp

Get the Cloud API channel

Returns which connection is active (meta or scan) and, for the Cloud API, the connected numbers. Access tokens and app secrets are never returned.

GET/api/v1/channel
  • Bearer API key
  • Scope: read or write
  • or app session
  • Workspace: X-Tenant-ID (optional with a key)

Headers

  • Authorizationstringrequired

    Your API key as Bearer <key>. The word Bearer and the space are case-sensitive. Browser clients signed in to the app use the session cookie instead.

    Constraints
    Keys start with pk_live_ and are 56 characters long.
    Example
    Bearer pk_live_…
  • X-Tenant-IDuuidoptional

    Workspace id. Optional with an API key (a key always acts in its own workspace); if you send it, it must match the key’s workspace. Required with a session cookie. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Response

200 OKapplication/json

  • configuredboolean

    true when at least one Meta (Cloud API) number is connected.

  • activeenum

    meta when a Cloud API number is connected, otherwise scan.

  • iduuidmay be absent

    Id of the primary Meta channel.

  • providerstringmay be absent

    meta for the primary channel.

  • phone_idstringmay be absent

    Meta phone number id of the primary channel.

  • waba_idstringmay be absent

    WhatsApp Business Account id of the primary channel.

  • phonestringmay be absent

    Phone number of the primary channel.

  • versionstringmay be absent

    Graph API version of the primary channel.

  • webhook_pathstringmay be absent

    Callback path Meta should call, for example /api/webhooks/meta.

  • webhook_urlstringmay be absent

    Full callback URL, when the public URL is configured.

  • webhook_managedboolean

    true when whatsappx.si manages the Meta app and webhook subscription for you.

  • live_sendboolean

    Messages are sent for real (always true).

  • channelsarray<object>may be absent

    All connected Meta numbers.

    Show child attributesHide child attributes5
    • iduuid

      Channel id.

    • phone_idstring

      Meta phone number id.

    • waba_idstring

      WhatsApp Business Account id.

    • phonestring

      Display phone number saved for the channel.

    • versionstring

      Graph API version, for example v23.0.

Status codes

  • 200OK. The channel configuration.
  • 401Unauthorized. The API key is unknown, revoked or expired (invalid or expired API key), or there is no key and no signed-in session (unauthorized).
  • 402Payment required. Only when subscriptions are enforced and the workspace has no active subscription. The body includes code: "payment_required".
  • 403Forbidden. The X-Tenant-ID header or tenant query does not match the API key’s workspace (API key belongs to a different workspace), or a signed-in user is not a member of the workspace (forbidden).
  • 500Server error. Something went wrong on our side. Retry with backoff.

Response for a workspace without a Cloud API number

{
  "configured": false,
  "active": "scan",
  "webhook_path": "/api/webhooks/meta",
  "webhook_managed": true,
  "live_send": true
}