Call Connection - Add Participant

Referencia

Servicio:: Communication

Versión de la API:: 2024-09-15

Agregue un participante a la llamada.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:add?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.
Repeatability-Request-ID		string (uuid)	Si se especifica, el cliente dirige que se puede repetir la solicitud; es decir, que el cliente puede realizar la solicitud varias veces con la misma repetibilidad:Request-Id y obtener una respuesta adecuada sin que el servidor ejecute la solicitud varias veces. El valor de repeatability-Request-Id es una cadena opaca que representa un identificador único generado por el cliente para la solicitud. Es un UUID de la versión 4 (aleatorio).
Repeatability-First-Sent		string (date-time-rfc1123)	Si se especifica repeatability-Request-ID encabezado, también se debe especificar repeatability-First-Sent encabezado. El valor debe ser la fecha y hora en que se creó la solicitud por primera vez, expresada mediante el formato IMF-fixdate de HTTP-date. Ejemplo: Sun, 06 nov 1994 08:49:37 GMT.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Usado por el cliente para enviar contexto de llamada personalizado a destinos
invitationTimeoutInSeconds		integer (int32) minimum: 0 maximum: 180	Obtiene o establece el tiempo de espera que espere el participante invitado a la recogida. El valor máximo de esto es de 180 segundos.
operationCallbackUri		string	Establezca un URI de devolución de llamada que invalide el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall para esta operación. Esta configuración es por acción. Si no se establece, se usará el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall.
operationContext		string	Lo usan los clientes al llamar a acciones de llamada intermedia para correlacionar la solicitud con el evento de respuesta.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Opcional) El nombre para mostrar del origen asociado a esta operación de invitación al agregar un usuario o participante RTC. Nota: No actualizará el nombre para mostrar en la lista.

Respuestas

Nombre	Tipo	Description
202 Accepted	AddParticipantResponse	El servicio ha aceptado la solicitud de agregar participante y comenzará a procesarla. Recibirá el evento AddParticipantSucceeded o AddParticipantFailed en el URI de devolución de llamada especificado para actualizarle el estado de la solicitud.
Other Status Codes	CommunicationErrorResponse	Error

Seguridad

Authorization

Un token de acceso de usuario de Azure Communication Services.

Tipo: apiKey
En: header

Ejemplos

CallConnection_AddParticipant

Solicitud de ejemplo

HTTP

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

{
  "participantToAdd": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationContext": "adding participant",
  "sourceCallerIdNumber": {
    "value": "+18440123456"
  },
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Respuesta de muestra

status code:: 202

{
  "operationContext": "adding participant",
  "participant": {
    "identifier": {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
      }
    },
    "isMuted": false
  },
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40"
}

Definiciones

Nombre	Description
AddParticipantRequest	Carga de solicitud para agregar participante a la llamada.
AddParticipantResponse	Carga de respuesta para agregar participantes a la llamada.
CallParticipant	Un participante de llamada.
CustomCallingContext	Contexto de llamada personalizado que se enviará al destino.

AddParticipantRequest

Object

Carga de solicitud para agregar participante a la llamada.

Nombre	Tipo	Description
customCallingContext	CustomCallingContext	Usado por el cliente para enviar contexto de llamada personalizado a destinos
invitationTimeoutInSeconds	integer (int32) minimum: 0 maximum: 180	Obtiene o establece el tiempo de espera que espere el participante invitado a la recogida. El valor máximo de esto es de 180 segundos.
operationCallbackUri	string	Establezca un URI de devolución de llamada que invalide el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall para esta operación. Esta configuración es por acción. Si no se establece, se usará el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall.
operationContext	string	Lo usan los clientes al llamar a acciones de llamada intermedia para correlacionar la solicitud con el evento de respuesta.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Opcional) El nombre para mostrar del origen asociado a esta operación de invitación al agregar un usuario o participante RTC. Nota: No actualizará el nombre para mostrar en la lista.

AddParticipantResponse

Object

Carga de respuesta para agregar participantes a la llamada.

Nombre	Tipo	Description
invitationId	string	Id. de invitación usado para agregar un participante.
operationContext	string	Contexto de operación proporcionado por el cliente.
participant	CallParticipant	Lista de participantes actuales en la llamada.

CallParticipant

Object

Un participante de llamada.

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

CustomCallingContext

Object

Contexto de llamada personalizado que se enviará al destino.

Nombre	Tipo	Description
sipHeaders	object	Encabezados SIP de contexto de llamada personalizados
voipHeaders	object	Encabezados voiP de contexto de llamada personalizados

Compartir a través de

Call Connection - Add Participant

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

Authorization

Ejemplos

CallConnection_AddParticipant

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AddParticipantRequest

AddParticipantResponse

CallParticipant

CustomCallingContext

Recursos adicionales