Recurso Interactions (Interações)
Este produto Twilio está atualmente disponível como uma versão Beta. Alguns recursos ainda não foram implementados e outros podem ser alterados antes que o produto seja declarado como disponível para o público em geral. O uso desta versão Beta está sujeito aos termos relevantes do contrato de licença vigente. Os produtos Beta não são abrangidos por um SLA da Twilio. Saiba mais sobre o suporte a produtos Beta.
Flex Conversations requer Flex UI (IU do Flex) 2.0. Se você estiver no Flex UI (IU do Flex) 1.x, consulte as páginas Mensagens no Flex.
Recurso Interactions (Interações)
O recurso Interactions (Interações) permite criar interações de entrada e saída para diferentes tipos de canal. Para criar uma interação, você deve fornecer atributos de Channel (Canal) e Routing (Roteamento). Os atributos do Channel (Canal) são usados para criar ou vincular a um canal de mídia subjacente, como uma conversa. Os atributos de Routing (Roteamento) são usados para criar uma tarefa que é então roteada de acordo com o espaço de trabalho e o fluxo de trabalho especificados. Uma interação bem‐sucedida resulta na oferta de uma reserva de tarefa a um agente que faz referência ao canal de mídia associado.
Criar uma interação é uma solicitação assíncrona para a qual uma resposta 200 indica apenas que o servidor aceitou a solicitação. Você precisa usar os métodos getter para verificar se o canal de interação foi configurado com êxito.
Nesta versão, uma interação é compatível com um único canal. Consulte o subrecurso Invites (Convites) para ver como criar várias tarefas para o mesmo canal de interação para incluir vários agentes.
POST /InteractionsRemember to handle certain terminal TaskRouter events according to you application's needs, as conversations may stay orphaned with an open state.
See Conversations Best Practices for details.
Propriedades de interação
| Resource Properties in REST API format | |
|---|---|
sid
|
A string exclusiva criada pela Twilio para identificar um recurso de interação, prefixado com KD. |
channel
|
Um objeto JSON que define o canal de comunicação da interação e inclui detalhes sobre o canal. Consulte os exemplos de objeto de canal SMS de saída e entrada (iniciado pela API). |
routing
|
Um objeto JSON representando as regras de roteamento para o Interaction Channel (Canal de interação). Consulte Exemplo de SMS de saída para obter um exemplo de objeto de Routing (Roteamento). O recurso Interactions (Interações) usa o TaskRouter para todas as funcionalidades de roteamento. Todos os atributos no objeto de Routing (Roteamento) no corpo da solicitação de interação são adicionados "como são" à tarefa. Para obter uma lista de atributos conhecidos consumidos pelo Flex UI (IU do Flex) e/ou pelo Flex Insights, consulte Atributos de tarefa conhecidos. |
url
|
|
links
|
|
Parâmetros da solicitação
| Parâmetro | Subcampos | Descrição | |
| Channel [obrigatório] | Um objeto JSON que define o canal de comunicação da interação e inclui detalhes sobre o canal. Consulte os exemplos de objeto de e‐mail de saída, SMS de saída e Canal de entrada (iniciado pela API). | ||
|
type [obrigatório] |
O tipo de canal de mídia. Valores permitidos: Observação: eles podem ser diferentes do tipo de canal de tarefa especificado nos atributos de Routing (Roteamento). O tipo de canal de tarefa corresponde à capacidade do canal enquanto este tipo de canal for o tipo de mídia real. |
||
|
initiated_by [obrigatório] |
O agente que criou esta interação. Valores permitidos: customer: indica que essa interação foi iniciada por um cliente e sempre acionará uma tarefa de entrada. O agent: iniciado pelo clique de um agente. Sempre acionará uma tarefa de saída para o mesmo agente. Isso também criará uma nova conversa e incluirá o agente a ela. api: acionada ou iniciada por um tipo secundário de interação, por exemplo, formulário da Web, automação, etc. Isso criará uma tarefa de entrada. Se um |
||
|
properties [opcional] |
As propriedades do canal de mídia. Nesta versão, somente o Twilio Conversations tem suporte como um canal de mídia. Dependendo do valor usado em media_channel_sid é necessário para todos os canais quando Para o canal de e‐mail com from: endereço de e‐mail da equipe do contact center (por exemplo, support@twilio.com). Isso é definido como o parâmetro from_name: nome da equipe do contact center (por exemplo, Suporte da Twilio) |
||
|
participants [ ] [opcional] |
Uma matriz de participantes. Necessário para interações de saída em que initiated_by está definido para um agente. Caso contrário, é opcional. Os participantes especificados serão adicionados ao canal de mídia e ao canal de interação. Os atributos necessários para especificar o endereço do participante dependem do tipo de endereço, como a seguir: SMS e WhatsApp: proxy_address: este é o número comercial que deve ser verificado pela Twilio, por exemplo, +192555512345, WhatsApp:+19251235555. address: número de telefone real do cliente. Chat e Web: identity: a identidade de chat do usuário no Twilio Conversations. Recomendamos seguir a especificação de URI padrão e evitar os seguintes caracteres reservados ! * ' ( ) ; : @ & = + $ , / ? % # [ ] para valores como identidade e nome amigável. E‐mail: level: o campo destinatário. Pode ser Para, Cc ou Cco. name: nome de exibição do cliente em seu aplicativo Flex. address: endereço de e‐mail do cliente. Para obter mais informações, consulte o recurso Participant (Participante) do Twilio Conversations. |
||
| Routing [obrigatório] | Um objeto JSON representando as regras de roteamento para o Interaction Channel (Canal de interação). Consulte o exemplo de SMS de saída para um objeto de Routing (Roteamento) de exemplo. O recurso Interactions (Interações) usa o TaskRouter para todas as funcionalidades de roteamento. | ||
|
properties [obrigatório] |
Campos necessários para criar uma tarefa: workspace_sid [obrigatório] O SID do fluxo de trabalho do TaskRouter que começa com WS. workflow_sid [opcional] O SID do fluxo de trabalho, iniciado com WW. Opcional se houver apenas um fluxo de trabalho definido; caso contrário, ele será obrigatório queue_sid [obrigatório para iniciado pelo agente], o SID da fila do TaskRouter, iniciado com WQ. worker_sid [obrigatório para iniciado pelo agente] task_channel_sid [opcional] task_channel_unique_name [opcional] attributes [opcional]: os atributos da tarefa. priority [opcional]: a prioridade da tarefa na fila. timeout [opcional]: o intervalo de tempo limite da tarefa/reserva em segundos.
|
Criar um recurso Interaction (Interação)
https://flex-api.twilio.com/v1/Interactions
Parameters
| Parameters in REST API format | |
|---|---|
channel
Required
|
O canal da interação. |
routing
Required
|
A lógica de roteamento da interação. |
Contato por SMS iniciado pelo cliente
Para contatos iniciados pelo cliente, você deve ter um Conversation SID (SID de conversa) existente para o media_channel_sid necessário.
Neste exemplo, configuramos o endereço SMS no console com uma integração de webhook. Como resultado, nosso endpoint será chamado quando uma nova conversa for criada e uma nova mensagem (SMS) for adicionada. Neste ponto, criaríamos a Interaction (Interação) e o Channel (Canal), e os rotearíamos para um agente. O diagrama ilustra o fluxo.
Example 1
Interações de saída iniciadas pelo agente
Este exemplo mostra como criar uma interação Flex de saída a partir de seu aplicativo de back-end. Use o endpoint /Interactions para implementar oportunidades adicionais para que os agentes enviem SMS, WhatsApp, Chat ou E‐mail* de saída.
*Observe que o e‐mail no Flex está atualmente no estágio beta privado.
Alguns exemplos práticos incluem uma funcionalidade "click-to-sms" (clique para enviar sms) ou "click-to-email" (clique para enviar e‐mail) na integração com o CRM.
A resposta da API conterá um SID de tarefa recém‐criado que você pode usar para atualizar os atributos da tarefa, recuperar o SID da conversa ou fazer alguma programação adicional conforme necessário.
Example 2
Contato iniciado pela API
Você pode usar a API para solicitar que um agente, por meio de um fluxo de trabalho, envie uma mensagem ao cliente.
Essas tarefas podem ser solicitadas por um cliente solicitando assistência (por exemplo, um formulário 'pedir ajuda') ou por meio da automação (por exemplo, análise de revisões). Desta forma, você deve indicar que a interação foi iniciada pela API. Um fluxo de exemplo pode ser assim:
- O cliente preenche um formulário da Web em seu site ou aplicativo.
- A lógica do aplicativo cria uma interação. O conteúdo do formulário é usado para preencher os atributos da tarefa e o recurso Interactions (Interações) cria uma tarefa de entrada.
- O endpoint Interactions (Interações) cria a conversa e adiciona o participante
- Um agente recebe a tarefa, aceita a reserva e escreve ao cliente para resolver seu problema.
No diagrama acima, a etapa 2 pode parecer assim:
Example 3
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.
