v2

latestSwagger 2.02026-07-13153840.2 KB

CallConnection

Play audio in the call.

post/calling/callConnections/{callConnectionId}/:playAudio

Path parameters

callConnectionIdstring required

The call connection id.

Query parameters

api-versionstring required

Version of API to invoke.

Request body

audioFileUristring

The media resource uri of the play audio request. Currently only Wave file (.wav) format audio prompts are supported. More specifically, the audio content in the wave file must be mono (single-channel), 16-bit samples with a 16,000 (16KHz) sampling rate.

loopboolean

The flag indicating whether audio file needs to be played in loop or not.

operationContextstring

The value to identify context of the operation.

audioFileIdstring

An id for the media in the AudioFileUri, using which we cache the media resource.

callbackUristring

The callback Uri to receive PlayAudio status notifications.

Response

Returns the play audio response.

operationIdstring

The operation id.

status'notStarted' | 'running' | 'completed' | 'failed' required

The status of the operation

operationContextstring

The operation context provided by client.