Get hold configurations

Use this endpoint to retrieve multiple hold configurations based on the page number and page size parameters. <a href="https://www.infobip.com/docs/conversations/calls#call-on-hold-set-up-calls" target="_blank">More info</a>.

get/ccaas/voice/2/hold-configs-per-queue

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header Authorization
- or API key in header Authorization
- or HTTP basic
- or OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token

Query parameters

pageNumberinteger

Number of the page to show.

pageSizeinteger

Size of a single page.

sortDirectionstring

Type of sorting (ASC or DESC).

sortBystring

Field by which the sorting will be done.

Response

idstring

Unique id of the hold configuration.

namestring required

Hold configuration name.

createdAtstring

updatedAtstring

queueIdsstring[] required

Specifies which queues is the given hold config applied to. Empty list is supported for default config.

enabledboolean

defaultboolean

Example response

{
  "id": "63a99eb0b8863d4d26678000",
  "name": "Hold Config Name",
  "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": "Test",
        "gender": "FEMALE"
      },
      "speechRate": 1,
      "fileDescriptor": "eea6b505-6e67-420a-b1a2-2307fafb1125"
    },
    "fileAudioSource": {
      "fileDescriptor": "eea6b505-6e67-420a-b1a2-2307fafb116"
    },
    "duration": {
      "unit": [
        "SECONDS",
        "MINUTES",
        "HOURS"
      ],
      "value": 2
    }
  },
  "default": false,
  "enabled": true,
  "queueIds": [
    "FD80A6AA8E0DB8A5165276570943D8CF",
    "A4BBE5D92667EEAB69860D457E877A59"
  ],
  "createdAt": "2022-12-10T13:45:00.777+0000",
  "updatedAt": "2022-12-10T13:45:00.777+0000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.