Post agent hold audio

POST

/v1/convai/agents/:agent_id/hold-audio

Sets the custom hold audio played on loop to callers waiting in the agent's concurrency wait queue. Replaces any previously uploaded clip.

agent_idstringRequired

The id of an agent. This is returned on agent creation.

This endpoint expects a multipart form containing a file.

hold_audio_filefileRequired

An MP3 or WAV file played on loop to callers waiting in the agent's concurrency wait queue. Maximum size 40 MB, maximum duration 180 seconds.

Successful Response

agent_idstring

hold_audioobject

Custom hold audio played on loop to callers waiting in the agent’s queue.

Set by uploading a file through the agent hold-audio endpoint. Values sent in agent create or update requests are ignored.

422

Hold Audio Create Request Unprocessable Entity Error

1	{
2	"agent_id": "agent_id",
3	"hold_audio": {
4	"audio_path": "audio_path",
5	"audio_url": "audio_url",
6	"original_filename": "original_filename",
7	"duration_secs": 1.1,
8	"size_bytes": 1
9	}
10	}