Update transfer strategy

Use this endpoint to update an already existing Transfer Strategy. More info.

Please log in to see full path URL. Learn why.

put

/ccaas/voice/2/transfer-configs/transfer-strategy

Authorizations:

Scopes:

conversations:manage

Request Body schema:

application/json

collapse all -

musicOnHold

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

500

Internal Server Error

Request samples

Content type

application/json

Copy

Collapse all


{"id": "642bf5f4ff5dd177aeb00889",
"musicOnHold": 
{"enabled": true,
"useDefault": false,
"fileAudioSource": 
{"fileDescriptor": "f829e911-8439-4321-aa25-23b321e1a9cb"
}
},
"announcementMessage": 
{"enabled": true,
"audioSourceType": "TTS",
"ttsAudioSource": 
{"text": "You're are being transferred...",
"language": "en",
"voice": 
{"name": "Joanna",
"gender": "FEMALE"
},
"speechRate": 1
},
"fileAudioSource": null,
"repeatInterval": 
{"unit": "SECONDS",
"value": 5
}
},
"createdAt": "2023-04-04T10:03:32.729Z",
"updatedAt": "2023-04-06T11:22:18.149Z"
}

Response samples

Content type

application/json

Successful response

Copy

Collapse all


{"id": "642bf5f4ff5dd177aeb00889",
"musicOnHold": 
{"enabled": true,
"useDefault": false,
"fileAudioSource": 
{"fileDescriptor": "f829e911-8439-4321-aa25-23b321e1a9cb"
}
},
"announcementMessage": 
{"enabled": true,
"audioSourceType": "TTS",
"ttsAudioSource": 
{"text": "You're are being transferred...",
"language": "en",
"voice": 
{"name": "Joanna",
"gender": "FEMALE"
},
"speechRate": 1
},
"fileAudioSource": null,
"repeatInterval": 
{"unit": "SECONDS",
"value": 5
}
},
"createdAt": "2023-04-04T10:03:32.729Z",
"updatedAt": "2023-04-06T11:22:18.149Z"
}

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

Privacy documents Terms of use