Voice / Call Controls

Mute or unmute a call leg

Mute (on: true) or unmute (on: false) a specific leg of a call.

post/api/v1/voice/calls/{call_id}/mute

Request

  • Base URL: https://api.frejun.ai
  • URL: https://api.frejun.ai/api/v1/voice/calls/{call_id}/mute
  • Auth: API key in header x-api-key

Path parameters

call_idstring required

Request body

leg_idstring required

Leg to mute or unmute (cl_ prefix).

onboolean required

true to mute the leg, false to unmute it.

Example request

{
  "leg_id": "cl_01JQ8Z9K7M3N2P4R5S6T7V8WAB",
  "on": true
}

Response

Successful Response

request_idstring required

Identifier for this control request. Reuse it to correlate retries and webhooks.

playback_idstring nullable

Identifier of the started playback (pb_ prefix). Only returned by the play action.

Example response

{
  "request_id": "req_9f8e7d6c5b4a3f2e1d0c9b8a"
}

Changes

No recorded changes to this operation across all 1 revision of this API.