SEsentdm
Voice

List the participants of a call

Changed on

Lists who is in the conference room one of your live calls is in: each participant's own call id, who they are, whether the room mutes them, and how long they have been connected. The call itself is one of the participants. Use a participant's id to mute or remove them; it is also a call id, so GET /v3/voice/calls/{id} accepts it. A call that has ended answers 409, as does a call that is not in a conference.

get/v3/voice/calls/{id}/participants

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/voice/calls/{id}/participants
  • 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

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.

Response

The participants of the room the call is in; empty once everyone has left

successboolean

Indicates whether the request was successful

Changes