POST /communications/calls/{call-id}/participants/{participant-id}/startHoldMusic

Put a participant on hold and play music in the background.

Servers

Path parameters

Name Type Required Description
participant-id String Yes

The unique identifier of participant

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
customPrompt No
clientContext String 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.