You are viewing the Spanish (Mexico) site, but your language preference is set to English. Switch to English site →

Menu

Expand
Calificar esta página:

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<AC> Not PII

SID de la Cuenta que creó el recurso de participante.

call_sid
sid<CA> Not PII

SID de Llamada al que está asociado el recurso de participante.

label
string Not PII

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
sid<CA> Not PII

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
boolean Not PII

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
sid<CF> Not PII

El SID de la conferencia en la que se encuentra el participante.

date_created
date_time<rfc2822> Not PII

La fecha y hora en GMT en que se creó el recurso, especificadas en formato RFC 2822.

date_updated
date_time<rfc2822> Not PII

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
boolean Not PII

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
boolean Not PII

Si el participante está silenciado. Puede ser “true”o “false”.

hold
boolean Not PII

Si el participante está en espera. Puede ser “true”o “false”.

start_conference_on_enter
boolean Not PII

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
enum:status Not PII

El estado de la llamada del participante en una sesión. Puede ser: “queued”, “connecting”, “ringing”, “connected”, “complete” o “failed”.

uri
string Not PII

La URL del recurso, referente a “https://api.twilio.com”.

Crear un participante

post
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
post sid<AC> Not PII

El SID de la Account que creará el recurso.

conference_sid
Path
post sid_like<CF> Not PII

El SID de la conferencia del participante.

from
Required
post endpoint PII MTL: 120 DAYS

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
post endpoint PII MTL: 120 DAYS

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
post url Not PII

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
post http_method Not PII

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
post string[] Not PII

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
post string Not PII

Una etiqueta para este participante. Si se proporciona una, se puede utilizar posteriormente para recuperar, actualizar o eliminar al participante.

timeout
Optional
post integer Not PII

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
post boolean Not PII

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
post boolean Not PII

Si el agente está silenciado en la conferencia. Puede ser “true” o “false” y el valor predeterminado es “false”.

beep
Optional
post string Not PII

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
post boolean Not PII

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
post boolean Not PII

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
post url Not PII

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
post http_method Not PII

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
post boolean Not PII

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
post integer Not PII

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
post string Not PII

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
post string Not PII

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
post url Not PII

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
post http_method Not PII

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
post string[] Not PII

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
post string Not PII

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
post url Not PII

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
post http_method Not PII

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
post string Not PII

El nombre de usuario SIP utilizado para la autenticación.

sip_auth_password
Optional
post string Not PII

La contraseña SIP para la autenticación.

region
Optional
post string Not PII

La región donde debemos mezclar el audio grabado. Puede ser: “us1”, “ie1”, “de1”, “sg1”, “br1”, “au1” o “jp1”.

conference_recording_status_callback
Optional
post url Not PII

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
post http_method Not PII

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
post string[] Not PII

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
post string[] Not PII

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
post boolean Not PII

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
post sid<CA> Not PII

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
post string Not PII

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
post sid<BY> Not PII

The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that byoc is only meaningful when to is a phone number; it will otherwise be ignored. (Beta)

caller_id
Optional
post string Not PII

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
post string PII MTL: 120 DAYS

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
post string Not PII

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
post integer Not PII

The maximum duration of the call in seconds. Constraints depend on account and configuration.

machine_detection
Optional
post string Not PII

Whether to detect if a human, answering machine, or fax has picked up the call. Can be: Enable or DetectMessageEnd. Use Enable if you would like us to return AnsweredBy as soon as the called party is identified. Use DetectMessageEnd, if you would like to leave a message on an answering machine. If send_digits is provided, this parameter is ignored. For more information, see Answering Machine Detection.

machine_detection_timeout
Optional
post integer Not PII

The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy of unknown. The default timeout is 30 seconds.

machine_detection_speech_threshold
Optional
post integer Not PII

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
post integer Not PII

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
post integer Not PII

The number of milliseconds of initial silence after which an unknown AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.

amd_status_callback
Optional
post url Not PII

The URL that we should call using the amd_status_callback_method to notify customer application whether the call was answered by human, machine or fax.

amd_status_callback_method
Optional
post http_method Not PII

The HTTP method we should use when calling the amd_status_callback URL. Can be: GET or POST and the default is POST.

Example 1
        
        
        
        Crea un participante en una conferencia. Si este ConferenceSid no es una conferencia activa, la solicitud fallará.

        Crear un participante de conferencia

        Crea un participante en una conferencia. Si este ConferenceSid no es una conferencia activa, la solicitud fallará.

        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

        get
        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
        get sid<AC> Not PII

        SID de la Cuenta que creó el recurso de participante que se recuperará.

        conference_sid
        Path
        get sid<CF> Not PII

        El SID de la conferencia con el participante que se va a recuperar.

        call_sid
        Path
        get sid_like<CA> Not PII

        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
              
              
              

              Recuperar un recurso de participante

              Example 2
                    
                    
                    

                    Recuperar un recurso de participante por etiqueta

                    Read multiple Participant resources

                    get
                    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
                    get sid<AC> Not PII

                    El SID de la Cuenta que creó los recursos de participante que se van a leer.

                    conference_sid
                    Path
                    get sid<CF> Not PII

                    El SID de la conferencia con los participantes que se van a leer.

                    muted
                    Optional
                    get boolean Not PII

                    Si se devuelven solo los participantes que están silenciados. Puede ser: “true” (verdadero) o “false” (falso).

                    hold
                    Optional
                    get boolean Not PII

                    Si se devuelven solo los participantes que están en espera. Puede ser: “true” (verdadero) o “false” (falso).

                    coaching
                    Optional
                    get boolean Not PII

                    Si se devuelve solo a los participantes que están brindando entrenamiento en otra llamada. Puede ser: “true” (verdadero) o “false” (falso).

                    Example 1
                          
                          
                          

                          Leer varios recursos de participante

                          Update a Participant resource

                          post
                          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
                          post sid<AC> Not PII

                          SID de la Cuenta que creó los recursos de participante que se actualizarán.

                          conference_sid
                          Path
                          post sid<CF> Not PII

                          El SID de la conferencia con el participante que se va a actualizar.

                          call_sid
                          Path
                          post sid_like<CA> Not PII

                          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
                          post boolean Not PII

                          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
                          post boolean Not PII

                          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
                          post url Not PII

                          The URL we call using the hold_method for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.

                          hold_method
                          Optional
                          post http_method Not PII

                          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
                          post url Not PII

                          The URL we call using the announce_method for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.

                          announce_method
                          Optional
                          post http_method Not PII

                          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
                          post url Not PII

                          The URL we call using the wait_method for the music to play while participants are waiting for the conference to start. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs. The default value is the URL of our standard hold music. Learn more about hold music.

                          wait_method
                          Optional
                          post http_method Not PII

                          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
                          post boolean Not PII

                          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
                          post boolean Not PII

                          Si se desea finalizar la conferencia cuando el participante se vaya. Puede ser: “true” o “false” y de manera predeterminada es “false”.

                          coaching
                          Optional
                          post boolean Not PII

                          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
                          post sid<CA> Not PII

                          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
                                
                                
                                

                                Silenciar participante

                                Example 2
                                      
                                      
                                      

                                      Silenciar participante por etiqueta

                                      Example 3
                                            
                                            
                                            

                                            Poner a un participante en espera con música

                                            Example 4
                                                  
                                                  
                                                  
                                                  Reproduce el archivo de audio en la announce_url del participante.

                                                  Hacer un anuncio al participante

                                                  Reproduce el archivo de audio en la announce_url del participante.

                                                  Delete a Participant resource

                                                  delete
                                                  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
                                                  delete sid<AC> Not PII

                                                  SID de la Cuenta que creó los recursos de participante que se eliminarán.

                                                  conference_sid
                                                  Path
                                                  delete sid<CF> Not PII

                                                  El SID de la conferencia con los participantes que se van a eliminar.

                                                  call_sid
                                                  Path
                                                  delete sid_like<CA> Not PII

                                                  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
                                                        
                                                        
                                                        

                                                        Eliminar un participante

                                                        Example 2
                                                              
                                                              
                                                              

                                                              Eliminar un participante por etiqueta

                                                              Calificar esta página:

                                                              ¿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.

                                                                    
                                                                    
                                                                    

                                                                    Gracias por tus comentarios.

                                                                    Selecciona los motivos de tus comentarios. La información adicional que nos brindas nos ayuda a mejorar nuestra documentación:

                                                                    Enviando tus comentarios…
                                                                    🎉 Gracias por tus comentarios.
                                                                    Se produjo un error. Inténtalo de nuevo.

                                                                    Gracias por tus comentarios.

                                                                    thanks-feedback-gif