get
https://{defaultHost}/api/v4/messaging/channel_profiles/
Returns detailed information about a specific channel profile.
The Get channel profile endpoint returns information for a single messaging channel profile.
Requirements: Base URL, Authentication, Error codes
Scope: messaging.channels.read
What this does
When you send a Get channel profile request with a channel profile ID,
Voiso
returns the channel profile object for that profile.
When to use it
- Retrieve a channel profile after you have its ID from Get list of channel profiles
- Display channel profile information in an admin tool
- Validate that a channel profile exists and is accessible to your API key
Prerequisites
- The channel profile must exist in the contact center.
- You must have access to the channel profile.
Endpoint
GET /api/v4/messaging/channel_profiles/{channel_profile_id}
Path parameters
- channel_profile_id
The unique identifier of the channel profile.
Examples
Minimal request
curl -X GET "https://{cluster_id}.voiso.com/api/v4/messaging/channel_profiles/12" \
-H "Authorization: Bearer <contact_center_api_key>" \
-H "Content-Type: application/json"Response
If successful, the API returns a channel profile object.
{
"channel_profile": {
"id": 12,
"channel": "whatsapp",
"identifier": "18885658889",
"name": "WhatsApp Main (18885658889)"
}
}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 this channel profile.
404 Not found
This usually means the channel profile ID does not exist, or you do not have access to it.
What to check:
- Confirm the ID using Get list of channel profiles.
429 Too many requests
What to do:
- Reduce request frequency and retry with backoff.