Recurso da conferência
O recurso Conference (Conferência) permite consultar e gerenciar o estado das conferências em sua conta da Twilio.
As salas de conferência não são criadas diretamente a partir da Programmable Voice API.
Para criar uma nova conferência, você deve usar o verbo de TwiML <Dial> com o <Conference>substantivo. Depois que uma instância de conferência tiver sido criada, você poderá acessá-la usando a API REST.
Para obter instruções passo a passo sobre como escrever esse TwiML e lidar programaticamente com a conferência, consulte nossos guias sobre como criar chamadas de conferência usando as bibliotecas auxiliares compatíveis pela Twilio.
Conference properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
O SID da Account (Conta) que criou o recurso Conferência. |
date_created
|
The date and time in GMT that this resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT that this resource was last updated, specified in RFC 2822 format. |
api_version
|
A versão da API usada para criar esta conferência. |
friendly_name
|
Uma string que você atribuiu para descrever esta sala de conferência. |
region
|
Uma string que representa a região da Twilio onde o áudio da conferência foi mixado. Pode ser "us1", "ie1", "de1", "sg1", "br1", "au1" e "jp1". O áudio básico das conferências será sempre mixado em "us1". O áudio da Conferência global será mixado mais próximo da maioria dos participantes. |
sid
|
A string exclusiva que criamos para identificar o recurso da Conferência. |
status
|
O status desta conferência. Pode ser: "init" (iniciado), "in-progress" (em andamento) ou "completed" (concluído). |
uri
|
The URI of this resource, relative to |
subresource_uris
|
Uma lista dos recursos relacionados identificados pelos seus URIs relativos a "https://api.twilio.com". |
reason_conference_ended
|
O motivo pelo qual uma conferência foi encerrada. Quando uma conferência estiver em andamento, será "null". Quando a conferência for concluída, pode ser: "conference-ended-via-api", "participant-with-end-conference-on-exit-left", "participant-with-end-conference-on-exit-kicked", "last-participant-kicked" ou "last-participant-left". |
call_sid_ending_conference
|
O call SID (SID da chamada) que encerrou a conferência. |
Você pode ter muitas instâncias de conferência que compartilham o mesmo friendly_name. Apenas uma dessas conferências distintas pode estar em andamento em um determinado momento. Por exemplo, se você tiver duas conferências separadas com o friendly_name de "my-conference", você não poderá adicionar participantes a uma instância enquanto a outra estiver em andamento.
Fetch a Conference resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json
A maneira recomendada de monitorar o estado de uma conferência e seus participantes é usar o statusCallback da conferência. Este retorno de chamada do webhook será acionado quando o estado da conferência ou de um participante for alterado.
A qualquer momento, você pode usar a API REST para consultar os recursos da Conferência e do Participante. No entanto, a pesquisa contínua desses recursos não é recomendada.
Parameters
| Parameters in REST API format | |
|---|---|
account_sid
Path
|
O SID da Account (Conta) que criou o recurso de conferência para fetch (buscar). |
sid
Path
|
A string fornecida pela Twilio que identifica exclusivamente o recurso da conferência para fetch (buscar) |
Example 1
Read multiple Conference resources
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences.json
Leia todas as conferências em sua conta.
A lista de conferências que retornamos inclui informações de paginação.
Parameters
| Parameters in REST API format | |
|---|---|
account_sid
Path
|
O SID da Account (Conta) que criou os recursos da conferência para read (ler). |
date_created
Optional
|
O valor "date_created", especificado como "AAAA‐MM‐DD", dos recursos para read (ler). Para read (ler) as conferências iniciadas à meia‐noite ou antes dessa data, utilize o comando "<=AAAA‐MM‐DD" e para especificar as conferências iniciadas à meia‐noite ou após essa data, utilize o comando ">=AAAA‐MM‐DD". |
date_updated
Optional
|
O valor "date_updated", especificado como "AAAA‐MM‐DD", dos recursos para read (ler). Para read (ler) as conferências que foram atualizadas pela última vez em ou antes da meia‐noite de uma data, use o comando "<=AAAA‐MM‐DD" e para especificar as conferências que foram atualizadas pela última vez em uma determinada data ou após a meia‐noite, use o comando ">=AAAA‐MM‐DD". |
friendly_name
Optional
|
A string que identifica os recursos da conferência para read (ler). |
status
Optional
|
O status dos recursos para read (ler). Pode ser: "init" (iniciado), "in-progress" (em andamento) ou "completed" (concluído). |
Example 1
Example 2
Example 3
Example 4
Update a Conference resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json
Você pode usar a ação de atualização para alterar as propriedades da conferência, bem como para encerrar a conferência.
Parameters
| Parameters in REST API format | |
|---|---|
account_sid
Path
|
O SID da Account (Conta) que criou os recursos da conferência para update (atualizar). |
sid
Path
|
A string fornecida pela Twilio que identifica exclusivamente o recurso de conferência para update (atualizar) |
status
Optional
|
O novo status do recurso. Pode ser: Pode ser: "init" (iniciado), "in-progress" (em andamento) ou "completed" (concluído). Especificar "completed" (concluído) encerrará a conferência e desligará todos os participantes |
announce_url
Optional
|
The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains |
announce_method
Optional
|
O método HTTP que usamos para chamar "announce_url". Pode ser: Pode ser "GET" ou "POST" e o padrão é "POST" |
Example 1
Example 2
Gerenciar participantes da conferência
Cada Conferência tem um sub‐recurso de participantes . Os participantes representam o conjunto de pessoas atualmente conectadas a uma conferência em andamento.
Você pode solicitar todos os participantes de uma determinada conferência solicitando o seguinte:
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.jsonConsulte a documentação completa de referência da API do Participante para obter as propriedades, os parâmetros e as ações do Participante.
Gravações de conferência
Você pode acessar o sub‐recurso Recordings list (Lista de gravações) em qualquer Conferência específica.
A seguir, será exibida uma lista de todas as gravações geradas para uma determinada conferência, identificadas por seu ConferenceSid. (Observe que as gravações associadas a um segmento de chamada individual da conferência não serão retornadas.)
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.jsonConsulte a documentação de referência de gravações para obter as propriedades dos recursos e os formatos de resposta.
Retenção do registro de conferência
A partir de 5 de fevereiro de 2021,você poderá recuperar recursos via GET para os endpoints /Conferences e /Participants por 13 meses após a criação do recurso. Isso representa uma alteração significativa, pois esses registros são atualmente armazenados indefinidamente pela Twilio e recuperados via Console e API.
É importante observar que não estamos excluindo seus logs, apenas alterando onde eles estarão disponíveis para você. Fornecemos um utilitário de Exportação em massa no Console para recursos de Conferências e Participantes, bem como uma API. A Exportação em massa gerará arquivos S3 contendo um dia de dados por arquivo e entregará o link de download via webhook, e‐mail ou Console. Registros com mais de 13 meses só poderão ser recuperados via Exportação em massa.
Se você executar a extração de registros por meio da API de forma contínua, é importante verificar se você está extraindo os registros em uma frequência que não será afetada por essa alteração.
Precisa de ajuda?
Às vezes, todos nós precisamos; a programação é difícil. Receba ajuda agora da nossa equipe de suporte, ou confie na sabedoria da multidão navegando pelo Stack Overflow Collective da Twilio ou buscando a tag Twilio no Stack Overflow.
