POST /communications/calls/{call-id}/recordResponse

Records a short audio response from the caller. A bot can utilize this to capture a voice response from a caller after they are prompted for a response. For further information on how to handle operations, please review commsOperation This action is not intended to record the entire call. The maximum length of recording is 2 minutes. The recording is not saved permanently by the Cloud Communications Platform and is discarded shortly after the call ends. The bot must download the recording promptly after the recording operation finishes by using the recordingLocation value that's given in the completed notification.

Servers

Path parameters

Name Type Required Description
call-id String Yes

The unique identifier of call

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
maxSilenceTimeoutInSeconds Number No
playBeep Boolean No

Default value: false

prompts[] Array No
bargeInAllowed Boolean No

Default value: false

stopTones[] Array No
maxRecordDurationInSeconds Number No
clientContext String No
initialSilenceTimeoutInSeconds Number No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.