Recurso de participante de la conferencia
El recurso de participantes de la API de Voice de Twilio representa a un participante que se conecta activamente a una conferencia dada.
El recurso de participante te permite realizar las siguientes acciones:
- Manipular a los participantes actuales de una conferencia, es decir, podrás silenciarlos o eliminarlos de la conferencia.
- Mostrar a todos los participantes en una conferencia activa.
- Obtener información sobre un participante en particular en una conferencia activa.
- Agregar participantes a una conferencia.
El seguimiento de las actualizaciones de todos los participantes de la conferencia durante el transcurso de esta se puede realizar medianteel webhookstatusCallback
de la conferencia.
Participant properties
Resource Properties in REST API format | |
---|---|
account_sid
|
SID de la Cuenta que creó el recurso de participante. |
call_sid
|
SID de Llamada al que está asociado el recurso de participante. |
label
|
La etiqueta especificada por el usuario de este participante, si se proporcionó una cuando se creó el participante. Se puede utilizar para recuperar, actualizar o eliminar al participante. |
call_sid_to_coach
|
El SID del participante al que se está “entrenando”. El participante que se está el formando es el único participante que puede oír al participante que está “entrenando”. |
coaching
|
Si el participante está brindando entrenamiento en otra llamada. Puede ser: “true” (verdadero) o “false” (falso). Si no está presente, el valor predeterminado es “false” a menos que esté definido “call_sid_to_coach”. Si es “true”, se debe definir “call_sid_to_coach”. |
conference_sid
|
El SID de la conferencia en la que se encuentra el participante. |
date_created
|
La fecha y hora en GMT en que se creó el recurso, especificadas en formato RFC 2822. |
date_updated
|
La fecha y hora en GMT en que se actualizó el recurso por última vez, especificadas en el formato RFC 2822. |
end_conference_on_exit
|
Si la conferencia finaliza cuando el participante se va. Puede ser: “true” o “false” y el valor predeterminado es “false”. Si es “true”, la conferencia termina y todos los demás participantes la abandonan cuando el participante se va. |
muted
|
Si el participante está silenciado. Puede ser “true”o “false”. |
hold
|
Si el participante está en espera. Puede ser “true”o “false”. |
start_conference_on_enter
|
Si la conferencia comienza cuando el participante se une a esta, si aún no se ha iniciado. Puede ser: “true” o “false” y el valor predeterminado es “true”. Si es “false” y la conferencia no ha comenzado, el participante se silencia y oye música de fondo hasta que otro participante inicie la conferencia. |
status
|
El estado de la llamada del participante en una sesión. Puede ser: “queued”, “connecting”, “ringing”, “connected”, “complete” o “failed”. |
uri
|
La URL del recurso, referente a “https://api.twilio.com”. |
Crear un participante
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json
Crear un recurso de participante con ConferenceSid
o FriendlyName
inicia una llamada saliente y agrega un nuevo participante a la conferencia activa con ConferenceSid
o FriendlyName
.
Si no existe una conferencia activa con tu FriendlyName
, creamos una nueva conferencia con ese nombre y agregamos al participante.
Si una conferencia especificada por ConferenceSid
no está activa, la solicitud falla.
No utilices información personal identificable (PII) como números de teléfono, direcciones de correo electrónico, el nombre de una persona o cualquier otra información confidencial a la hora de asignar un FriendlyName
a tus conferencias.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
El SID de la Account que creará el recurso. |
conference_sid
Path
|
El SID de la conferencia del participante. |
from
Required
|
El número de teléfono, identificador de cliente o parte del nombre de usuario de la dirección SIP que realizó esta llamada. Los números de teléfono están en formato E.164 (por ejemplo, +16175551212). Los identificadores de cliente tienen el formato “client:nombre”. Si utilizas un número de teléfono, debe ser un número de Twilio o un identificador de agente de llamada saliente verificado para tu cuenta. Si el parámetro “to” es un número de teléfono, “from” también debe ser un número de teléfono. Si “to” es una dirección SIP, este valor de “from” debería ser una parte del nombre de usuario que se utilizará para rellenar el encabezado P-Asserted-Identity que se pasa al punto final de SIP. |
to
Required
|
El número de teléfono, la dirección SIP o el identificador de cliente que recibió esta llamada. Los números de teléfono están en formato E.164 (por ejemplo, +16175551212). Las direcciones SIP tienen el formato “sip:nombre@empresa.com”. Los identificadores de cliente tienen el formato “client:nombre”. También se pueden especificar parámetros personalizados. |
status_callback
Optional
|
La URL que deberíamos llamar usando el “status_callback_method” para enviar información de estado a tu aplicación. |
status_callback_method
Optional
|
El método HTTP que deberíamos usar para llamar a “status_callback”. Puede ser: “GET” y “POST” y de manera predeterminada es “POST”. |
status_callback_event
Optional
|
Los cambios de estado de la conferencia que deberían generar una llamada a “status_callback”. Puede ser: “initiated”, “ringing”, “answered” y “completed”. Separa varios valores con un espacio. El valor predeterminado es “completed”. |
label
Optional
|
Una etiqueta para este participante. Si se proporciona una, se puede utilizar posteriormente para recuperar, actualizar o eliminar al participante. |
timeout
Optional
|
La cantidad de segundos que debemos permitir que suene el teléfono antes de concluir que no hay respuesta. Puede ser un entero entre “5” y “600”, ambos incluidos. El valor predeterminado es “60”. Siempre agregamos un búfer de tiempo de espera de 5 segundos a las llamadas salientes, por lo que el valor de 10 daría como resultado un tiempo de espera real más cercano a los 15 segundos. |
record
Optional
|
Si se debe grabar al participante y sus conferencias, incluido el tiempo entre conferencias. Puede ser “true” o “false” y el valor predeterminado es “false”. |
muted
Optional
|
Si el agente está silenciado en la conferencia. Puede ser “true” o “false” y el valor predeterminado es “false”. |
beep
Optional
|
Si se debe reproducir un pitido de notificación en la conferencia cuando el participante se une. Puede ser: “true”, “false”, “onEnter” u “onExit”. El valor predeterminado es “true”. |
start_conference_on_enter
Optional
|
Si se inicia la conferencia cuando el participante se une, si aún no se ha iniciado. Puede ser: “true” o “false” y el valor predeterminado es “true”. Si es “false” y la conferencia no ha comenzado, el participante se silencia y oye música de fondo hasta que otro participante inicie la conferencia. |
end_conference_on_exit
Optional
|
Si se desea finalizar la conferencia cuando el participante se vaya. Puede ser: “true” o “false” y de manera predeterminada es “false”. |
wait_url
Optional
|
La URL a la que deberíamos llamar usando el “wait_method” para que la música se reproduzca mientras los participantes esperan a que comience la conferencia. El valor predeterminado es la URL de nuestra música de espera estándar. Obtén más información sobre la música en espera. |
wait_method
Optional
|
El método HTTP que deberíamos usar para llamar a “wait_url”. Puede ser “GET” o “POST”, y el valor por defecto es “POST”. Cuando se usa un archivo de audio estático, debería ser “GET” para que se pueda almacenar el archivo en caché. |
early_media
Optional
|
Si se permite que un agente escuche el estado de la llamada saliente, incluidos los mensajes de llamada o de desconexión. Puede ser: “true” o “false” y de manera predeterminada es “true”. |
max_participants
Optional
|
La cantidad máxima de participantes en la conferencia. Puede ser un entero positivo desde “2” hasta “250”. El valor predeterminado es “250”. |
conference_record
Optional
|
Si se desea grabar la conferencia a la que se está uniendo el participante. Puede ser: “true”, “false”, “record-from-start” y “do-not-record”. El valor predeterminado es “false”. |
conference_trim
Optional
|
Si se recorta el silencio inicial y final de los archivos de audio grabados de la conferencia. Puede ser: “trim-silence” o “do-not-trim” y de manera predeterminada es “trim-silence”. |
conference_status_callback
Optional
|
La URL que deberíamos llamar usando “conference_status_callback_method” cuando se producen los eventos de conferencia en “conference_status_callback_event”. Solo se utiliza el valor establecido por el primer participante que se una a la conferencia. Los siguientes valores de “conference_status_callback” se ignoran. |
conference_status_callback_method
Optional
|
El método HTTP que deberíamos usar para llamar a “conference_status_callback”. Puede ser: “GET” o “POST” y de manera predeterminada es “POST”. |
conference_status_callback_event
Optional
|
Los cambios del estado de la conferencia que deberían generar una llamada a “conference_status_callback”. Puede ser: “start”, “end”, “join”, “leave”, “mute”, “hold”, “modify”, “speaker” y “advertisement”. Separa varios valores con un espacio. De manera predeterminada es “start end”. |
recording_channels
Optional
|
Los canales de grabación para la grabación final. Puede ser: “mono” o “dual” y el valor predeterminado es “mono”. |
recording_status_callback
Optional
|
La URL a la que deberíamos llamar usando “recording_status_callback_method” cuando cambia el estado de grabación. |
recording_status_callback_method
Optional
|
El método HTTP que deberíamos usar cuando llamamos a “recording_status_callback”. Puede ser: “GET” o “POST” y de manera predeterminada es “POST”. |
sip_auth_username
Optional
|
El nombre de usuario SIP utilizado para la autenticación. |
sip_auth_password
Optional
|
La contraseña SIP para la autenticación. |
region
Optional
|
La región donde debemos mezclar el audio grabado. Puede ser: “us1”, “ie1”, “de1”, “sg1”, “br1”, “au1” o “jp1”. |
conference_recording_status_callback
Optional
|
La URL a la que deberíamos llamar usando “conference_recording_status_callback_method” cuando la grabación de la conferencia esté disponible. |
conference_recording_status_callback_method
Optional
|
El método HTTP que deberíamos usar para llamar a “conference_recording_status_callback”. Puede ser: “GET” o “POST” y de manera predeterminada es “POST”. |
recording_status_callback_event
Optional
|
Los cambios de estado de la grabación que deberían generar una llamada a “recording_status_callback”. Puede ser: “started”, “in-progress”, “paused”, “resumed”, “stopped”, “completed”, “failed” y “absent”. Separa varios valores con un espacio, por ejemplo: “in-progress completed failed”. |
conference_recording_status_callback_event
Optional
|
Los cambios del estado de la grabación que generan una llamada a “conference_recording_status_callback”. Puede ser: “in-progress”, “completed”, “failed” y “absent”. Separa varios valores con un espacio, por ejemplo: “in-progress completed failed” |
coaching
Optional
|
Si el participante está brindando entrenamiento en otra llamada. Puede ser: “true” (verdadero) o “false” (falso). Si no está presente, el valor predeterminado es “false” a menos que esté definido “call_sid_to_coach”. Si es “true”, se debe definir “call_sid_to_coach”. |
call_sid_to_coach
Optional
|
El SID del participante al que se está “entrenando”. El participante que se está el formando es el único participante que puede oír al participante que está “entrenando”. |
jitter_buffer_size
Optional
|
Tamaño del búfer de fluctuación para el participante que se conecta. Twilio utilizará esta configuración para aplicar el búfer de fluctuación antes de que el audio del participante se mezcle en la conferencia. Puede ser: “off”, “small”, “medium” y “large”. El valor predeterminado es “large”. |
byoc
Optional
|
The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that |
caller_id
Optional
|
El número de teléfono, identificador de cliente o parte del nombre de usuario de la dirección SIP que realizó esta llamada. Los números de teléfono están en formato E.164 (por ejemplo, +16175551212). Los identificadores de cliente tienen el formato “client:nombre”. Si utilizas un número de teléfono, debe ser un número de Twilio o un identificador de agente de llamada saliente verificado para tu cuenta. Si el parámetro “to” es un número de teléfono, “callerId” también debe ser un número de teléfono. Si “to” es una dirección SIP, este valor de “callerId” debería ser una parte del nombre de usuario que se utilizará para rellenar el encabezado From (De) que se pasa al punto final de SIP. |
call_reason
Optional
|
The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta) |
recording_track
Optional
|
La pista de audio que se va a grabar para la llamada. Puede ser: “inbound”, “outbound” o “both”. El valor predeterminado es “both”. “inbound” graba el audio que recibe Twilio. “outbound” graba el audio que se envía desde Twilio. “both” graba el audio que Twilio recibe y el que envía. |
time_limit
Optional
|
The maximum duration of the call in seconds. Constraints depend on account and configuration. |
machine_detection
Optional
|
Whether to detect if a human, answering machine, or fax has picked up the call. Can be: |
machine_detection_timeout
Optional
|
The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with |
machine_detection_speech_threshold
Optional
|
The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400. |
machine_detection_speech_end_threshold
Optional
|
The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200. |
machine_detection_silence_timeout
Optional
|
The number of milliseconds of initial silence after which an |
amd_status_callback
Optional
|
The URL that we should call using the |
amd_status_callback_method
Optional
|
The HTTP method we should use when calling the |
Example 1
Parámetros personalizados
Solo se aplica a Twilio Voice Client o puntos finales SIP
Los parámetros personalizados se pueden pasar al ID de cliente especificado o al punto final SIP en el campo to
mediante la notación de cadena de consulta, por ejemplo:
client:alice?mycustomparam1=foo&mycustomparam2=bar
Fetch a Participant resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json
Devuelve un recurso de participante de una conferencia activa, especificada por el SID de la conferencia y la etiqueta o el SID de llamada del participante.
El recurso de participante solo administra participantes activos de conferencias en curso.
Si deseas obtener una lista de todos los participantes de la conferencia durante el transcurso de esta, utiliza statusCallback
de la conferencia a fin de recibir webhooks para cada participante que se una a la conferencia y almacenar los detalles en tu aplicación.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
SID de la Cuenta que creó el recurso de participante que se recuperará. |
conference_sid
Path
|
El SID de la conferencia con el participante que se va a recuperar. |
call_sid
Path
|
SID o etiqueta de la Llamada del participante que se va a recuperar. Los caracteres no seguros de URL en una etiqueta deben estar codificados por porcentaje, por ejemplo, un carácter de espacio se representa como %20. |
Example 1
Example 2
Read multiple Participant resources
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json
Devuelve la lista de participantes activos en la conferencia identificada por ConferenceSid
.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
El SID de la Cuenta que creó los recursos de participante que se van a leer. |
conference_sid
Path
|
El SID de la conferencia con los participantes que se van a leer. |
muted
Optional
|
Si se devuelven solo los participantes que están silenciados. Puede ser: “true” (verdadero) o “false” (falso). |
hold
Optional
|
Si se devuelven solo los participantes que están en espera. Puede ser: “true” (verdadero) o “false” (falso). |
coaching
Optional
|
Si se devuelve solo a los participantes que están brindando entrenamiento en otra llamada. Puede ser: “true” (verdadero) o “false” (falso). |
Example 1
Update a Participant resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json
Actualiza el estado de un participante en una conferencia activa.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
SID de la Cuenta que creó los recursos de participante que se actualizarán. |
conference_sid
Path
|
El SID de la conferencia con el participante que se va a actualizar. |
call_sid
Path
|
SID o etiqueta de la Llamada del participante que se va a actualizar. Los caracteres no seguros de URL en una etiqueta deben estar codificados por porcentaje, por ejemplo, un carácter de espacio se representa como %20. |
muted
Optional
|
Si se debe silenciar al participante. Puede ser “true”o “false”. “true” silenciará al participante y “false” activará su micrófono. Cualquier valor que no sea “true” o “false” se interpreta como “false”. |
hold
Optional
|
Si el participante debe estar en espera. Puede ser: “true” (verdadero) o “false” (falso). “true” pone al participante en espera, y “false” les permite volver a unirse a la conferencia. |
hold_url
Optional
|
The URL we call using the |
hold_method
Optional
|
El método HTTP que deberíamos usar para llamar a “hold_url”. Puede ser: “GET” o “POST”, y el valor por defecto es “GET”. |
announce_url
Optional
|
The URL we call using the |
announce_method
Optional
|
El método HTTP que deberíamos usar para llamar a “announce_url”. Puede ser: “GET” o “POST” y de manera predeterminada es “POST”. |
wait_url
Optional
|
The URL we call using the |
wait_method
Optional
|
El método HTTP que deberíamos usar para llamar a “wait_url”. Puede ser “GET” o “POST”, y el valor por defecto es “POST”. Cuando se usa un archivo de audio estático, debería ser “GET” para que se pueda almacenar el archivo en caché. |
beep_on_exit
Optional
|
Si se reproduce un pitido de notificación en la conferencia cuando el participante sale. Puede ser: “true” (verdadero) o “false” (falso). |
end_conference_on_exit
Optional
|
Si se desea finalizar la conferencia cuando el participante se vaya. Puede ser: “true” o “false” y de manera predeterminada es “false”. |
coaching
Optional
|
Si el participante está brindando entrenamiento en otra llamada. Puede ser: “true” (verdadero) o “false” (falso). Si no está presente, el valor predeterminado es “false” a menos que esté definido “call_sid_to_coach”. Si es “true”, se debe definir “call_sid_to_coach”. |
call_sid_to_coach
Optional
|
El SID del participante al que se está “entrenando”. El participante que se está el formando es el único participante que puede oír al participante que está “entrenando”. |
Example 1
Example 2
Example 3
Example 4
Delete a Participant resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json
Elimina el recurso de participante para quitar al participante de la conferencia. Devuelve HTTP 204 (Sin contenido) sin cuerpo si el participante se quitó correctamente de la conferencia.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
SID de la Cuenta que creó los recursos de participante que se eliminarán. |
conference_sid
Path
|
El SID de la conferencia con los participantes que se van a eliminar. |
call_sid
Path
|
SID o etiqueta de la Llamada del participante que se va a eliminar. Los caracteres no seguros de URL en una etiqueta deben estar codificados por porcentaje, por ejemplo, un carácter de espacio se representa como %20. |
Example 1
Example 2
¿Necesitas ayuda?
Todos la necesitamos a veces; la programación es difícil. Obtén ayuda ahora de nuestro equipo de soporte, o recurre a la sabiduría de la multitud visitando Stack Overflow Collective de Twilio o navegando por la etiqueta de Twilio en Stack Overflow.