whatsAppChannels

Requires permission settings:integration:read.

Lists the WhatsApp channels on the provider account, for the channel picker. A provider that does not use channels answers that it has none. Requires permission to read integrations.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query WhatsAppChannels {
  whatsAppChannels {
    detail
    ok
    channels {
      id
      name
      source
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query WhatsAppChannels {\n  whatsAppChannels {\n    detail\n    ok\n    channels {\n      id\n      name\n      source\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "whatsAppChannels": {
      "detail": "string",
      "ok": true,
      "channels": [
        {
          "id": "string",
          "name": "string",
          "source": "string"
        }
      ]
    }
  }
}

whatsAppChannels(
  provider: WhatsAppProvider
): WhatsAppChannelsResultGql!

Arguments

whatsAppChannels.provider ● WhatsAppProvider enum

The WhatsApp provider to use. Omit it to use the organization's enabled provider, else its most recently edited one.

Type

WhatsAppChannelsResultGql object

The channels fetched from the provider.