Log inTry for free
Back to all APIs

Update hold configuration

Use this endpoint to update an already existing hold configuration. More info.

Please log in to see full path URL. Learn why.
put
/ccaas/voice/2/hold-configs-per-queue/{id}
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
conversations:manage
path Parameters
id
required
string

Id of the Hold Configuration being updated.

Request Body schema:
application/json
collapse all -
name
required
string [ 1 .. 128 ] characters

Hold configuration name.

onHoldMusic
object

File audio source information.

enabled
boolean
useDefault
boolean
Default: true

Use system default music.

fileAudioSource
object

File audio source information.

fileDescriptor
string [ 0 .. 128 ] characters

File audio source descriptor.

announcementMessage
object

File audio source or TTS audio source information with repeat interval.

enabled
boolean
Audio source type
string
Enum: "TTS" "FILE"

Specifies whether the audio is from a file source or text-to-speech

ttsAudioSource
object

Text-to-speech audio source information.

text
required
string [ 0 .. 1400 ] characters

Text to convert using text-to-speech. This field supports usage of placeholders. Use the following endpoint to find which placeholders are supported: Get supported TTS placeholders for purpose. Placeholders are used to dynamically insert values into the text. For example, you can use placeholders to insert the customer's position in queue as part of announcement message in waiting strategy.

language
required
string [ 1 .. 36 ] characters

If the message is in text format, the language in which the message is written must be defined for correct pronunciation. In the Languages section, you can find the list of languages that we support: Voice Text-To-Speech Languages.

isLanguageSelectedManually
boolean

This option controls whether automatic language detection will be performed on provided text.

voice
required
object

Used to define voice in which text will be synthesized. To get a list of the supported voices for chosen language use Get voices.

name
required
string [ 1 .. 36 ] characters

Name of the voice.

gender
required
string [ 1 .. 36 ] characters

Gender of the voice. Can be MALE or FEMALE.

speechRate
required
number <double> [ 0.5 .. 2 ]

Text-to-speech speech rate.

fileAudioSource
object

File audio source information.

fileDescriptor
string [ 0 .. 128 ] characters

File audio source descriptor.

repeatInterval
object

Duration information.

unit
required
string
Enum: "SECONDS" "MINUTES" "HOURS"
value
required
integer <int32> >= 1
queueIds
required
Array of strings

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

enabled
boolean
default
boolean

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Request samples

Content type
application/json
Copy
 Collapse all
{
  • "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"
}

Response samples

Content type
application/json

Successful response

Copy
 Collapse all
{
  • "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"
}

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