The Get list of channel profiles endpoint returns the messaging channel profiles you can access.

Requirements: Base URL, Authentication, Error codes

Scope: messaging.channels.read

What this does

When you send a Get list of channel profiles request, Voiso returns a paginated list of channel profile objects.

Channel profiles typically represent a specific messaging identity for a channel, such as a WhatsApp number.

When to use it

Populate a selector for messaging identities in an external tool
Retrieve channel profile IDs to use when configuring users or messaging workflows
Audit which messaging profiles exist in a contact center

Endpoint


GET /api/v4/messaging/channel_profiles

Query parameters

All query parameters are optional.

limit
The number of items to return. Default is 100. Maximum is 100.
offset
The number of items to skip before starting to collect the result set. Default is 0.

Examples

Minimal request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/messaging/channel_profiles" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Request the third page of results (20 per page)

curl -X GET "https://{cluster_id}.voiso.com/api/v4/messaging/channel_profiles?limit=20&offset=40" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns an array of channel profile objects and pagination metadata.

{
  "channel_profiles": [
    {
      "id": 12,
      "channel": "whatsapp",
      "identifier": "18885658889",
      "name": "WhatsApp Main (18885658889)"
    }
  ],
  "metadata": {
    "total": 100
  }
}

Troubleshooting

401 Unauthorized

What to check:

You are sending Authorization: Bearer <contact_center_api_key>.
Your Base URL includes the correct {cluster_id}.

403 Forbidden

What to check:

The API key is valid, but does not have access to messaging resources in this contact center.

429 Too many requests

What to do:

Reduce request frequency and retry with backoff.