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

Menu

API Interactions

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.

URL base

https://flex-api.twilio.com/v1

Autenticação

A API do Flex usa a mesma autenticação básica HTTP que outras APIs da Twilio. Use o Account SID (SID da conta) da Twilio como o nome de usuário e seu Auth Token (Token de autenticação) como a senha.

Recursos

Atributos da tarefa

A tabela a seguir lista um conjunto de atributos 'bem conhecidos' que são consumidos pelo Flex UI (IU do Flex) e/ou pelo Flex Insights.

Atributo

Descrição

Exemplo

customerName

Para o Insights, ele é usado para preencher conversations.customers.name.


No Flex UI (IU do Flex), ele é renderizado como o nome do cliente principal para uma tarefa de e‐mail.

Al Fresco

customerAddress

Para o Insights, ele é usado para preencher conversations.customers.email ou conversations.customers.phone.


No Flex UI (IU do Flex), ele é renderizado como o endereço de e‐mail do cliente principal para uma tarefa de e‐mail.

+192522212345 ou

alfresco@aol.com

from

Este é o atributo preferencial do Flex UI (IU do Flex) para identificar o cliente em tarefas que não sejam de e‐mail. Para tarefas de e‐mail, ele usa customerName.

Al Fresco, +19251235555

subject

No Flex UI (IU do Flex), ele é renderizado como o assunto inicial de uma tarefa de thread de e‐mail.

Problemas com sapatos

flexInteractionChannelSid

Usado no Flex UI (IU do Flex) para identificar se uma tarefa é baseada em interação ou não e, portanto, se há necessidade de orquestração do Flex UI (IU do Flex).

UOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

flexInteractionSid

O SID da interação

KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

flexChannelInviteSid

O SID do convite

KGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

followed_by

Usado para transferências assistidas externas

outcome

Usado para transferências assistidas externas

clientes

Este objeto é adicionado automaticamente se customerAddress e customerName forem fornecidos.


Este objeto contém o nome, telefone e e‐mail de um único cliente.

name [obrigatório]: o nome de exibição do cliente. Se o nome não estiver disponível, ele deve ser definido como nulo

phone [obrigatório]: o número de telefone ou WhatsApp do cliente. Se o número não estiver disponível, ele deve ser definido como nulo

email [obrigatório]: o endereço de e‐mail do cliente. Se nenhum endereço de e‐mail estiver disponível, ele deverá ser definido como nulo

"customers": {

"name": "Al Fresco",

"Phone": "+19252148887",

"email": nulo

}

Os seguintes atributos são adicionados quando o canal é criado (de forma assíncrona):

Atributo

Descrição

Exemplo

conversations.external_contact


(Este é o Endereço projetado da conversa)

Para o Insights, este é o endereço de contato usado pelo cliente para falar com você ou o endereço de contato usado por você para contatá‐lo. Pode ser um número de telefone de suporte de entrada, seu e‐mail de suporte ou um número que aparece no telefone do cliente quando você liga para ele.


As informações de contato (e‐mail, telefone) que o cliente usa ou vê ao se comunicar com o contact center podem ser usadas para a segmentação de tráfego.

help@twilio.com

Atributos da tarefa mapeados a partir de Atributos do canal

Alguns atributos de canal de solicitação de interação também são usados para criar outros atributos de tarefa. A tabela a seguir lista os atributos de tarefa que são criados a partir dos atributos de canal fornecidos:

Atributo do canal de interação

Atributo(s) da tarefa

Valores


tipo

conversations.media.type (Insights)

Para todos os tipos de mídia de conversa

ChatTranscript

conversations.communication_channel (Insights)

E‐mail, SMS, WhatsApp, Web, Chat

channelType (Flex UI,IU do Flex)

O Flex UI (IU do Flex) usa isso para identificar tarefas que têm o mesmo 'uniqueTaskChannelName' que o chat, mas precisam ser tratadas de forma diferente, por exemplo, WhatsApp e SMS.

E‐mail, SMS, WhatsApp, Web, Chat

initiated_by

direction (Flex UI, IU do Flex)

Quando initiated_by estiver definido como 'agent' (agente), esse valor será de saída; caso contrário, será de entrada.

cliente | api | agente


properties.media_channel_sid

conversations.conversation_id (Insights)

KDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

conversations.media.sid (Insights)

conversationSid (Flex UI,IU do Flex)

A tabela a seguir exibe o motivo para precisar desses atributos:

Atributos do Flex Insights

Como/por que ele é usado

conversations.media.type

Um exemplo do objeto de mídia inteiro com transcrição de chat anexada

conversations.initiated_by

Flex Insights: usado para identificar como a conversa foi iniciada. Isso ajuda a identificar funis que levam a uma conversa.

conversations.external_contact

Flex Insights: o endereço de contato usado pelo cliente para falar com você ou o endereço de contato usado por você para contatá‐lo. Pode ser um número de telefone de suporte de entrada, seu e‐mail de suporte ou um número que aparece no telefone do cliente quando você liga para ele.


Útil para segmentar o tráfego por informações de contato (e‐mail, telefone)

conversations.conversation_id

conversations.media.sid

O ID da conversa usado para insights históricos. O SID de mídia é usado para obter acesso às transcrições.

Erros

Alguns erros comuns que você pode encontrar incluem o Erro 20003 e o Erro 11200. Consulte o Dicionário de erros e avisos da Twilio para obter uma lista de possíveis erros.

Classifique esta página:

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.

Obrigado pelo seu feedback!

Selecione o(s) motivo(s) para seu feedback. As informações adicionais que você fornece nos ajudam a melhorar nossa documentação:

Enviando seu feedback...
🎉 Obrigado pelo seu feedback!
Algo deu errado. Tente novamente.

Obrigado pelo seu feedback!

Indique‑nos e obtenha USD10 em 3 etapas simples!

Etapa 1

Obtenha o link

Obtenha um link de indicação pessoal gratuito aqui

Etapa 2

Dê USD10

Seu usuário se inscreve e faz a atualização usando o link

Etapa 3

Obtenha USD10

1.250 mensagens SMS grátis
OU 1.000 min de voz grátis
OU 12.000 chats
OU mais