The Get caller ID group endpoint returns information for a single caller ID group.

Requirements: Base URL, Authentication, Error codes

Scope: numbers.read

What this does

When you send a Get caller ID group request with a caller ID group ID,

When to use it

• Retrieve a caller ID group after you have its ID from Get caller ID groups
• Display caller ID group information in an admin tool
• Validate that a caller ID group exists and is accessible to your API key

Prerequisites

• The caller ID group must exist in the contact center.
• You must have access to the caller ID group.

Endpoint

GET /api/v4/numbers/caller_id_groups/{caller_id_group_id}

Path parameters

• caller_id_group_id
  The unique identifier of the caller ID group.

Examples

Minimal request

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

Response

If successful, the API returns a caller ID group object.

{
  "caller_id_group": {
    "id": 3,
    "name": "UK Sales"
  }
}

Notes

• To find numbers assigned to a caller ID group, use Get purchased phone numbers and filter the returned numbers[] by caller_id_groups.id.

Troubleshooting

401 Unauthorized

What to check:

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

Example response:

{ "error": "Unauthorized" }

403 Forbidden

What to check:

• The API key is valid, but does not have access to this caller ID group.

Example response:

{ "error": "Forbidden" }

404 Not found

This usually means the caller ID group ID does not exist, or you do not have access to it.

What to check:

• Confirm the caller ID group ID using Get caller ID groups.

Example response:

{ "error": "Not found" }

429 Too many requests

What to do:

• Reduce request frequency and retry with backoff.

Example response:

{ "error": "Too many requests" }