List Channels

Returns an array of all channels associated with your business, including both active and inactive ones. Method: GET URL: /api/v1/channels/

Headers

Header	Value
Authorization	Bearer

Response

string

required

Unique identifier for the channel (UUID).

string

required

UUID of the business that owns this channel.

string

required

The channel type. One of: webchat, widget, email, whatsapp, telegram, instagram, x, sms.

object

required

Channel-specific configuration object. Contents vary by channel type (see Create Channel for details).

boolean

required

Whether the channel is currently active.

string

required

ISO 8601 timestamp of when the channel was created.

Example

curl --request GET \
  --url https://api.pingback.live/api/v1/channels/ \
  --header 'Authorization: Bearer {token}'

const response = await fetch('https://api.pingback.live/api/v1/channels/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {token}'
  }
});

const channels = await response.json();

Response example

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "business_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "type": "whatsapp",
    "config": {
      "phone_number_id": "1234567890",
      "access_token": "EAAxxxxxxx",
      "verify_token": "my_verify_token"
    },
    "is_active": true,
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": "7cb96e12-3a4b-4c5d-8e9f-0a1b2c3d4e5f",
    "business_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "type": "widget",
    "config": {
      "widget_id": "9d8e7f6a-5b4c-3d2e-1f0a-9b8c7d6e5f4a"
    },
    "is_active": true,
    "created_at": "2024-01-10T08:00:00Z"
  }
]

Errors

Status	Meaning
401	Unauthorized — missing or invalid token

Authentication

Conversations

Channels & Widget

Team

Knowledge Base

Analytics

Headers

Response

Example

Response example

Errors

​Headers

​Response

​Example

​Response example

​Errors

Headers

Response

Example

Response example

Errors