Log inTry for free
Back to all APIs

Get hold configurations

Use this endpoint to retrieve multiple hold configurations based on the page number and page size parameters. More info.

Please log in to see full path URL. Learn why.
get
/ccaas/voice/2/hold-configs-per-queue
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
conversations:manage
query Parameters
pageNumber
integer <int32>

Number of the page to show.

pageSize
integer <int32>

Size of a single page.

sortDirection
string

Type of sorting (ASC or DESC).

sortBy
string

Field by which the sorting will be done.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

500

Internal Server Error

Request samples

Example
cURL
Copy
curl -L -g 'https://{baseUrl}/ccaas/voice/2/hold-configs-per-queue' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type
application/json

Successful Response

Copy
 Collapse all
{
  • "elements":
    [
    • {
      • "id": "63a99eb0b8863d4d26678000",
      • "name": "Hold Config Name1",
      • "onHoldMusic":
        {
        • "enabled": true,
        • "useDefault": false,
        • "fileAudioSource":
          {
          • "fileDescriptor": "eea6b505-6e67-420a-b1a2-2307fafb1124"
          }
        },
      • "announcementMessage":
        {
        • "audioSourceType": "TTS",
        • "ttsAudioSource":
          {
          • "text": "Hello this a text to speech message",
          • "language": "English",
          • "voice":
            {
            • "name": "Name1",
            • "gender": "FEMALE"
            },
          • "speechRate": 1,
          • "fileDescriptor": "eea6b505-6e67-420a-b1a2-2307fafb1125"
          },
        • "fileAudioSource":
          {
          • "fileDescriptor": "eea6b505-6e67-420a-b1a2-2307fafb116"
          },
        • "duration":
          {
          • "unit": "MINUTES",
          • "value": 2
          }
        },
      • "default": false,
      • "enabled": true,
      • "queueIds":
        [
        • "FD80A6AA8E0DB8A5165276570943D8CF",
        • "A4BBE5D92667EEAB69860D457E877A59"
        ],
      • "createdAt": "2022-12-10T13:45:00.000Z",
      • "updatedAt": "2022-12-10T13:45:00.000Z"
      },
    • {
      • "id": "63a99eb0b8863d4d26678001",
      • "name": "Hold Config Name2",
      • "createdAt": "2022-12-12T13:45:00.000Z",
      • "updatedAt": "2022-12-12T13:45:00.000Z",
      • "onHoldMusic":
        {
        • "enabled": true,
        • "useDefault": false,
        • "fileAudioSource":
          {
          • "fileDescriptor": "eea6b505-6e67-420a-b1a2-2307fafb1135"
          }
        },
      • "announcementMessage":
        {
        • "audioSourceType": "TTS",
        • "ttsAudioSource":
          {
          • "text": "Hello this a text to speech message",
          • "language": "Spanish",
          • "voice":
            {
            • "name": "Name2",
            • "gender": "Male"
            },
          • "speechRate": 1,
          • "fileDescriptor": "eea6b505-6e67-420a-b1a2-2307fafb1132"
          },
        • "fileAudioSource":
          {
          • "fileDescriptor": "eea6b505-6e67-420a-b1a2-2307fafb136"
          },
        • "duration":
          {
          • "unit": "MINUTES",
          • "value": 4
          }
        },
      • "default": false,
      • "enabled": true,
      • "queueIds":
        [
        • "FD80A6AA8E0DB8A5165276570943D8CF",
        • "A4BBE5D92667EEAB69860D457E877A59"
        ]
      }
    ],
  • "total": 8,
  • "totalPages": 10
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.

Privacy documentsTerms of use