Recurso do Flex Flow
No momento, você está lendo a documentação do Flex Legacy Messaging. Se você estiver começando com uma nova implementação do Flex, considere usar o Flex Conversations.
Um Flex Flow é a lógica que vincula uma identificação de contato (por exemplo Número de telefone habilitado para SMS ou número WhatsApp) ao Flex.
Esta página detalha o recurso da API do Flex Flow. Consulte a documentação adicional para saber mais sobre como trabalhar com Flex Flows.
Propriedades do FlexFlow
| Resource Properties in REST API format | |
|---|---|
account_sid
|
O SID da Conta que criou o recurso Flex Flow e possui este fluxo de trabalho. |
date_created
|
A data e a hora em GMT quando o recurso foi criado especificadas no formato ISO 8601 |
date_updated
|
A data e a hora em GMT quando o recurso foi atualizado pela última vez especificada no formato ISO 8601. |
sid
|
A string exclusiva que criamos para identificar o recurso Flex Flow. |
friendly_name
|
A string que você atribuiu para descrever o recurso. |
chat_service_sid
|
O SID do serviço de chat. |
channel_type
|
O tipo de canal. Uma dos tipos "web", "facebook", "sms", "whatsapp", "line" ou "custom". Por padrão, o widget Send to Flex (Enviar para o Flex) do Studio o transmite para os atributos de Task para tarefas criadas com base neste Flex Flow. Os atributos de Task serão usados pelo Flex UI (IU do Flex) para renderizar a respectiva Tarefa conforme apropriado (aplicando limites de comprimento e design específicos do canal). Se o "channelType" for "facebook", "whatsapp" ou "line", o widget Send to Flex deverá definir o canal de tarefas para o Programmable Chat. |
contact_identity
|
A identidade do contato do canal. |
enabled
|
Se o Flex Flow (Fluxo do flex) estiver ativado. |
integration_type
|
O software que tratará as mensagens de entrada. Tipo de integração pode ser: "studio", "external" ou "task". |
integration
|
Um objeto que contém parâmetros específicos para a integração. |
long_lived
|
Quando ativado, o Flex manterá o canal de chat ativo para que possa ser usado para interações subsequentes com uma identidade de contato. O valor padrão é "false". |
janitor_enabled
|
Quando ativado, o monitor do canal de mensagens removerá as sessões de proxy ativas se a tarefa associada for excluída do Flex UI (IU do Flex). O valor padrão é "false". |
url
|
O URL absoluto do recurso Flex Flow. |
Criar um recurso do FlexFlow
https://flex-api.twilio.com/v1/FlexFlows
Parameters
| Parameters in REST API format | |
|---|---|
friendly_name
Required
|
Uma string descritiva que você cria para descrever o recurso Flex Flow. |
chat_service_sid
Required
|
O SID do serviço de chat. |
channel_type
Required
|
O tipo de canal. Uma dos tipos "web", "facebook", "sms", "whatsapp", "line" ou "custom". Por padrão, o widget Send to Flex (Enviar para o Flex) do Studio o transmite para os atributos de Task para tarefas criadas com base neste Flex Flow. Os atributos de Task serão usados pelo Flex UI (IU do Flex) para renderizar a respectiva Tarefa conforme apropriado (aplicando limites de comprimento e design específicos do canal). Se o "channelType" for "facebook", "whatsapp" ou "line", o widget Send to Flex deverá definir o canal de tarefas para o Programmable Chat. |
contact_identity
Optional
|
A identidade do contato do canal. |
enabled
Optional
|
Se o novo Flex Flow (Fluxo do flex) estiver ativado. |
integration_type
Optional
|
O software que tratará as mensagens de entrada. Tipo de integração pode ser: "studio", "external" ou "task". |
integration.flow_sid
Optional
|
O SID do Studio Flow. Necessário quando o "integrationType" for "studio". |
integration.url
Optional
|
O URL do webhook externo. Necessário quando o "integrationType" for "external". |
integration.workspace_sid
Optional
|
O SID do Workspace para uma nova tarefa. Necessário quando o "integrationType" for "task". |
integration.workflow_sid
Optional
|
O SID do fluxo de trabalho para uma nova tarefa. Necessário quando o "integrationType" for "task". |
integration.channel
Optional
|
O SID do Canal de tarefas (TCXXXX) ou o nome exclusivo (por exemplo, "ms") a ser usado para a Tarefa que será criada. Aplicável e exigido quando o "integrationType" for "task". O valor padrão é "falha". |
integration.timeout
Optional
|
O tempo limite da tarefa em segundos para uma nova tarefa. O padrão é 86.400 segundos (24 horas). Facultativo quando o "integrationType" for uma "task", não aplicável de outra forma. |
integration.priority
Optional
|
A prioridade da tarefa de uma nova tarefa. A prioridade padrão é 0. Facultativo quando o "integrationType" for uma "task", não aplicável de outra forma. |
integration.creation_on_message
Optional
|
No contexto de mensagens de saída, define se uma tarefa deve ser criada imediatamente (e, portanto, reserva a conversa para o agente atual) ou atrasa a criação da tarefa até que o cliente envie a primeira resposta. Defina como falso para criar imediatamente, verdadeiro para atrasar a criação da tarefa. Esta configuração só se aplica a mensagens de saída. |
long_lived
Optional
|
Quando ativado, o Flex manterá o canal de chat ativo para que possa ser usado para interações subsequentes com uma identidade de contato. O valor padrão é "false". |
janitor_enabled
Optional
|
Quando ativado, o monitor do canal de mensagens removerá as sessões de proxy ativas se a tarefa associada for excluída do Flex UI (IU do Flex). O valor padrão é "false". |
integration.retry_count
Optional
|
O número de vezes para tentar novamente o Studio Flow ou o webhook em caso de falha. Obtém valores inteiros de 0 a 3, com o padrão sendo 3. Facultativo quando o "integrationType" for "studio" ou "external", não se aplica de outra forma. |
Example 1
Example 2
O Guia de uso do Studio é uma introdução útil ao Studio Flows e à ideia geral de como o Studio funciona. Se você está procurando uma maneira simples de alimentar seu Flex Flow, um Studio Flow subjacente pode ser a maneira certa!
Quando você receber uma mensagem de entrada, o Flex Flow fará uma requisição POST contendo o corpo da mensagem e alguns metadados para o webhook escolhido.
Buscar um recurso do FlexFlow
https://flex-api.twilio.com/v1/FlexFlows/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
O SID do recurso Flex Flow para fetch (buscar). |
Example 1
Ler vários recursos do FlexFlow
https://flex-api.twilio.com/v1/FlexFlows
Parameters
| Parameters in REST API format | |
|---|---|
friendly_name
Optional
|
O "friendly_name" dos recursos do Flex Flow para read (ler). |
Example 1
Atualizar um recurso do FlexFlow
https://flex-api.twilio.com/v1/FlexFlows/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
O SID do recurso Flex Flow para update (atualizar). |
friendly_name
Optional
|
Uma string descritiva que você cria para descrever o recurso Flex Flow. |
chat_service_sid
Optional
|
O SID do serviço de chat. |
channel_type
Optional
|
O tipo de canal. Uma dos tipos "web", "facebook", "sms", "whatsapp", "line" ou "custom". Por padrão, o widget Send to Flex (Enviar para o Flex) do Studio o transmite para os atributos de Task para tarefas criadas com base neste Flex Flow. Os atributos de Task serão usados pelo Flex UI (IU do Flex) para renderizar a respectiva Tarefa conforme apropriado (aplicando limites de comprimento e design específicos do canal). Se o "channelType" for "facebook", "whatsapp" ou "line", o widget Send to Flex deverá definir o canal de tarefas para o Programmable Chat. |
contact_identity
Optional
|
A identidade do contato do canal. |
enabled
Optional
|
Se o novo Flex Flow (Fluxo do flex) estiver ativado. |
integration_type
Optional
|
O software que tratará as mensagens de entrada. Tipo de integração pode ser: "studio", "external" ou "task". |
integration.flow_sid
Optional
|
O SID do Studio Flow. Necessário quando o "integrationType" for "studio". |
integration.url
Optional
|
O URL do webhook externo. Necessário quando o "integrationType" for "external". |
integration.workspace_sid
Optional
|
O SID do Workspace para uma nova tarefa. Necessário quando o "integrationType" for "task". |
integration.workflow_sid
Optional
|
O SID do fluxo de trabalho para uma nova tarefa. Necessário quando o "integrationType" for "task". |
integration.channel
Optional
|
O SID do Canal de tarefas (TCXXXX) ou o nome exclusivo (por exemplo, "ms") a ser usado para a Tarefa que será criada. Aplicável e exigido quando o "integrationType" for "task". O valor padrão é "falha". |
integration.timeout
Optional
|
O tempo limite da tarefa em segundos para uma nova tarefa. O padrão é 86.400 segundos (24 horas). Facultativo quando o "integrationType" for uma "task", não aplicável de outra forma. |
integration.priority
Optional
|
A prioridade da tarefa de uma nova tarefa. A prioridade padrão é 0. Facultativo quando o "integrationType" for uma "task", não aplicável de outra forma. |
integration.creation_on_message
Optional
|
No contexto de mensagens de saída, define se uma tarefa deve ser criada imediatamente (e, portanto, reserva a conversa para o agente atual) ou atrasa a criação da tarefa até que o cliente envie a primeira resposta. Defina como falso para criar imediatamente, verdadeiro para atrasar a criação da tarefa. Esta configuração só se aplica a mensagens de saída. |
long_lived
Optional
|
Quando ativado, o Flex manterá o canal de chat ativo para que possa ser usado para interações subsequentes com uma identidade de contato. O valor padrão é "false". |
janitor_enabled
Optional
|
Quando ativado, o monitor do canal de mensagens removerá as sessões de proxy ativas se a tarefa associada for excluída do Flex UI (IU do Flex). O valor padrão é "false". |
integration.retry_count
Optional
|
O número de vezes para tentar novamente o Studio Flow ou o webhook em caso de falha. Obtém valores inteiros de 0 a 3, com o padrão sendo 3. Facultativo quando o "integrationType" for "studio" ou "external", não se aplica de outra forma. |
Example 1
Excluir um Flex Flow
https://flex-api.twilio.com/v1/FlexFlows/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
O SID do recurso Flex Flow para delete (excluir). |
Example 1
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.
