Skip to content

Channel


Authorization

Add this header to every request in this page

json
{
  "Authorization": "Bearer ${token}"
}

🔒 List Channels

For Channels Listing

GET

/api/v1/channels

Response

json
{
  "success": true,
  "message": "",
  "status_code": 200,
  "trace_id": "5906cfea-0328-4b19-81b7-f96a46124ed1",
  "errors": [],
  "items": [
    {
      "id": "<channel_id>",
      "name": "<channel_name>",
      "number": "<phone_number>",
      "whatsapp_account_id": "<waba>",
      "is_active": true,
      "created_at": "2024-04-01T08:38:02.269Z",
      "updated_at": "2024-05-02T14:19:55.452Z",
      "container": {
          "domain": "<domain>",
          "number": "<phone_number>"
      }
    }
  ]
}

Parameter Explanations

NameDescription
idThis is Channel Id which you are going to use while creating, getting and sending message templates
nameName of the Channel. Example HeloRobo Test Channel
numberNumber of the Channel which messages will be sending from
is_activeStatus of the Channel. If it is false you cannot send messages