Call Connection - Get Participants

Servicio:

Communication

Versión de la API:

2024-09-15

Obtener participantes de una llamada. Los bots de grabación y transcripción se omiten de esta lista.

GET {endpoint}/calling/callConnections/{callConnectionId}/participants?api-version=2024-09-15

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
callConnectionId	path	True	string	Identificador de conexión de llamada
endpoint	path	True	string url	Punto de conexión del recurso de Comunicación de Azure.
api-version	query	True	string	Versión de la API que se va a invocar.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Un token de acceso de usuario de Azure Communication Services.

Respuestas

Nombre	Tipo	Description
200 OK	GetParticipantsResponse	Devuelve la respuesta obtener participantes.
Other Status Codes	CommunicationErrorResponse	Error

Seguridad

Authorization

Un token de acceso de usuario de Azure Communication Services.

Tipo: apiKey
En: header

Ejemplos

CallConnection_GetParticipants

Solicitud de ejemplo

HTTP

GET https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants?api-version=2024-09-15

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "identifier": {
        "kind": "communicationUser",
        "communicationUser": {
          "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
        }
      },
      "isMuted": true
    }
  ],
  "nextLink": "string"
}

Definiciones

Nombre	Description
CallParticipant	Un participante de llamada.
GetParticipantsResponse	Carga de respuesta para obtener participantes de la llamada.

CallParticipant

Un participante de llamada.

Nombre	Tipo	Description
identifier	CommunicationIdentifierModel
isMuted	boolean	¿Está silenciado el participante?
isOnHold	boolean	Es participante en espera.

GetParticipantsResponse

Carga de respuesta para obtener participantes de la llamada.

Nombre	Tipo	Description
nextLink	string	Continuar con la lista de participantes
value	CallParticipant[]	Lista de los participantes actuales en la llamada.