SEsentdm
Voice

Remove a participant from a call

Changed on

Removes one participant from the conference room a live call is in, named by the participant's own call id from the participants list. Their leg ends and is reported through call.completed like any other call; everyone else stays connected. A participant who is not in this call's room answers 404. A call that has ended answers 409, as does a call that is not in a conference.

delete/v3/voice/calls/{id}/participants/{participantId}

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/voice/calls/{id}/participants/{participantId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring required

The call id from the route, as carried by call webhooks and the calls list, for example call_9f2ab000-0000-4000-8000-000000000001

participantIdstring required

The participant's own call id from the route, as listed by the participants endpoint, for example call_9f2ab000-0000-4000-8000-000000000002

Headers

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

Response

The participant has been removed from the room

Changes