Quando novas credenciais de API são criadas no Journey Optimizer, os webhooks de SMS agora são a maneira de capturar palavras-chave de entrada e eventos de feedback como entregas e erros. Como cada provedor tem recursos diferentes, há instruções separadas para ativar webhooks.
Com os webhooks que agora oferecem suporte ao provedor personalizado, agora é possível coletar feedback e coleção de palavras-chave de entrada de qualquer provedor para ser relatado e aplicado no Journey Optimizer.
-
Novos clientes: As instruções aqui podem ser seguidas para configurar webhooks de SMS corretamente.
-
Clientes existentes: é possível migrar das informações armazenadas nas Credenciais da API para os Webhooks e não há linha do tempo para os clientes migrarem. Para clientes existentes que desejam migrar para Webhooks de SMS, as etapas de migração precisam ser executadas conforme documentado no guia de migração.
Visão geral overview
Depois que suas credenciais de API forem criadas com êxito, você poderá configurar webhooks para capturar respostas de entrada para gerenciar o consentimento de aceitação e recusa e para receber relatórios do delivery, incluindo confirmações de leitura, quando disponíveis.
Ao configurar um webhook, você pode definir sua finalidade com base no tipo de dados que deseja capturar:
-
Entrada: use esta opção se desejar capturar respostas de consentimento, como aceitação ou recusa, e coletar preferências do usuário.
-
Feedback: escolha esta opção para rastrear eventos de entrega e participação, incluindo entregas, erros de saída, confirmações de leitura (se aplicável) para oferecer suporte a relatórios e análises.
Dependendo do seu provedor, haverá expectativas diferentes sobre o que precisa ser configurado para ter uma implementação de SMS bem-sucedida:
-
Conversação entre Sinch e Sinch: crie um webhook que manipula eventos de entrada e de feedback. Nenhuma configuração de conteúdo é necessária.
-
Infobip: crie dois webhooks separados, um para eventos de entrada e outro para eventos de feedback. Nenhuma configuração de carga é necessária para qualquer webhook.
-
Twilio: os webhooks não estão disponíveis. Não há suporte para a coleta de dados de entrada e de feedback.
-
Provedor personalizado: crie dois webhooks separados, um para eventos de entrada e outro para eventos de feedback. A configuração de carga é necessária para que ambos os webhooks funcionem corretamente.
Suporte do provedor provider-support
A tabela a seguir mostra quais provedores oferecem suporte a webhooks de entrada e de feedback e se a criação de carga útil é necessária:
Para clientes que estão mudando de credenciais de API para webhooks de SMS, as informações sobre o caminho de migração são encontradas no guia de migração.
Criar webhook
Para conversa entre Sinch e Sinch create-webhook-sinch
Para a Conversação entre Sinch e Sinch, crie um único webhook que lida com eventos de entrada e de feedback. Nenhuma configuração de carga personalizada é necessária.
-
No painel à esquerda, navegue até Administração
>Canais, selecione o menu Webhooks de SMS em Configurações de SMS e clique no botão Criar Webhook.
-
Defina as configurações do webhook, conforme detalhado abaixo:
-
Nome: digite um nome para o webhook.
-
Selecionar fornecedor de SMS: Sinch ou Sinch Conversational.
-
Credenciais da API: escolha no menu suspenso suas credenciais de API configuradas anteriormente.
-
Número de Telefone do Remetente: digite o número de telefone do remetente que você deseja usar para suas comunicações.
-
-
Comece a configurar as palavras-chave de entrada inserindo palavras-chave no campo Inserir uma Palavra-chave. Várias palavras-chave podem ser adicionadas e removidas. Observe que palavras-chave não diferenciam maiúsculas de minúsculas.
-
Selecione uma categoria de palavra-chave no menu suspenso Categoria de Palavra-chave de Entrada para configurar:
-
accordion Opt-In -
Ative as palavras-chave que aceitam os usuários com seu consentimento. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, seu número de telefone é aceito para receber mensagens SMS.
-
Por padrão, as seguintes palavras-chave são ativadas: Subscribe, Yes, Unstop, Continue, Resume e Begin. Remova quaisquer palavras-chave padrão clicando em
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando a mensagem de entrada de um usuário corresponde a uma palavra-chave de aceitação.
-
-
accordion Recusar -
Ative palavras-chave que recusam usuários e remova o consentimento para enviar mensagens de texto. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, o número de telefone dele não recebe mensagens SMS.
-
Por padrão, as seguintes palavras-chave são ativadas: Stop, Quit, Cancel, End, Unsubscribe, No. Remova quaisquer palavras-chave padrão clicando em
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando a mensagem de entrada de um usuário corresponde a uma palavra-chave de recusa.
-
Habilite a Lógica Difusa para detectar palavras-chave semelhantes a palavras-chave de Recusa configuradas. Se a resposta de um usuário for fechada, mas não exata, a mensagem inserida no campo Resposta Automática Difusa será enviada. Normalmente, essa mensagem indica que a recusa não ocorreu e especifica a palavra-chave exata necessária para cancelar a inscrição.
-
-
accordion Aceitação dupla -
Ative palavras-chave para o requisito de aceitação dupla. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, ele não é totalmente aceito nesse estágio. Esse fluxo de trabalho de consentimento em duas etapas requer que os usuários confirmem sua aceitação com uma segunda palavra-chave.
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando uma palavra-chave de aceitação dupla é correspondida. Essa mensagem instrui o usuário a inserir uma palavra-chave de aceitação para concluir o processo de aceitação.
-
-
accordion Ajuda -
Ative palavras-chave que fornecem uma resposta padrão quando a ajuda é solicitada. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, ele recebe a mensagem Ajuda.
-
Por padrão, as seguintes palavras-chave são ativadas: Ajuda, Informações, Informações. Remova quaisquer palavras-chave padrão clicando em
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando a mensagem de entrada de um usuário corresponde a uma palavra-chave da Ajuda.
-
-
accordion Personalizado -
Configure uma única palavra-chave personalizada. Quando a mensagem de um usuário corresponde a esta palavra-chave, ela é gravada no conjunto de dados Acompanhamento de feedback da mensagem para criação de relatórios e público-alvo.
-
Crie um Público (streaming ou lote) que faça referência a essa palavra-chave para uso em suas jornadas e campanhas.
-
-
-
Insira uma Mensagem de Resposta Padrão. Esta mensagem é enviada automaticamente quando a resposta de um usuário não corresponde a nenhuma palavra-chave configurada.
-
Clique em Enviar para salvar a configuração do webhook.
-
No menu Webhooks, você pode editar ou excluir webhooks existentes.
-
Acesse o Webhook recém-criado e copie a URL do Webhook.
-
Use sua URL do Webhook para habilitar os eventos de Feedback e Entrada para entrar no Journey Optimizer.
-
Para o canal SMS, saiba mais na documentação do Sinch
-
Para o canal MMS, saiba mais na documentação do Sinch
-
Para clientes que compraram SMS diretamente pelo Journey Optimizer, registre um tíquete de suporte com o suporte da Adobe. A equipe de conta da Adobe configurará o URL do webhook para você.
-
Se o webhook usar credenciais de API anexadas a uma configuração de canal existente, o webhook entrará em vigor imediatamente. Caso contrário, crie uma nova configuração de canal.
Para Infobip create-webhook-infobip
Para o Infobip, crie dois webhooks separados: um para eventos de Feedback e outro para eventos de Entrada.
-
No painel à esquerda, navegue até Administração
>Canais, selecione o menu Webhooks de SMS em Configurações de SMS e clique no botão Criar Webhook.
-
Defina as configurações do webhook, conforme detalhado abaixo:
-
Nome: digite um nome para o webhook.
-
Selecionar fornecedor de SMS: Infobip.
-
Tipo: escolha Feedback ou Entrada. Você precisa criar ambos separadamente, aqui, começamos com a Entrada.
-
Credenciais da API: escolha no menu suspenso suas credenciais de API configuradas anteriormente.
-
Número de Telefone do Remetente: digite o número de telefone do remetente que você deseja usar para suas comunicações.
-
-
Comece a configurar as palavras-chave de entrada inserindo palavras-chave no campo Inserir uma Palavra-chave. Várias palavras-chave podem ser adicionadas e removidas. Observe que palavras-chave não diferenciam maiúsculas de minúsculas.
-
Selecione uma categoria de palavra-chave no menu suspenso Categoria de Palavra-chave de Entrada para configurar:
-
accordion Opt-In -
Ative as palavras-chave que aceitam os usuários com seu consentimento. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, seu número de telefone é aceito para receber mensagens SMS.
-
Por padrão, as seguintes palavras-chave são ativadas: Subscribe, Yes, Unstop, Continue, Resume e Begin. Remova quaisquer palavras-chave padrão clicando em
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando a mensagem de entrada de um usuário corresponde a uma palavra-chave de aceitação.
-
-
accordion Recusar -
Ative palavras-chave que recusam usuários e remova o consentimento para enviar mensagens de texto. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, o número de telefone dele não recebe mensagens SMS.
-
Por padrão, as seguintes palavras-chave são ativadas: Stop, Quit, Cancel, End, Unsubscribe, No. Remova quaisquer palavras-chave padrão clicando em
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando a mensagem de entrada de um usuário corresponde a uma palavra-chave de recusa.
-
Habilite a Lógica Difusa para detectar palavras-chave semelhantes a palavras-chave de Recusa configuradas. Se a resposta de um usuário for fechada, mas não exata, a mensagem inserida no campo Resposta Automática Difusa será enviada. Normalmente, essa mensagem indica que a recusa não ocorreu e especifica a palavra-chave exata necessária para cancelar a inscrição.
-
-
accordion Aceitação dupla -
Ative palavras-chave para o requisito de aceitação dupla. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, ele não é totalmente aceito nesse estágio. Esse fluxo de trabalho de consentimento em duas etapas requer que os usuários confirmem sua aceitação com uma segunda palavra-chave.
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando uma palavra-chave de aceitação dupla é correspondida. Essa mensagem instrui o usuário a inserir uma palavra-chave de aceitação para concluir o processo de aceitação.
-
-
accordion Ajuda -
Ative palavras-chave que fornecem uma resposta padrão quando a ajuda é solicitada. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, ele recebe a mensagem Ajuda.
-
Por padrão, as seguintes palavras-chave são ativadas: Ajuda, Informações, Informações. Remova quaisquer palavras-chave padrão clicando em
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando a mensagem de entrada de um usuário corresponde a uma palavra-chave da Ajuda.
-
-
accordion Personalizado -
Configure uma única palavra-chave personalizada. Quando a mensagem de um usuário corresponde a esta palavra-chave, ela é gravada no conjunto de dados Acompanhamento de feedback da mensagem para criação de relatórios e público-alvo.
-
Crie um Público (streaming ou lote) que faça referência a essa palavra-chave para uso em suas jornadas e campanhas.
-
-
-
Insira uma Mensagem de Resposta Padrão. Esta mensagem é enviada automaticamente quando a resposta de um usuário não corresponde a nenhuma palavra-chave configurada.
-
Clique em Enviar para salvar a configuração do webhook.
-
No menu Webhooks, agora é necessário criar um webhook Feedback para o Infobip.
-
Defina as configurações do webhook, conforme detalhado abaixo:
-
Nome: digite um nome para o webhook.
-
Selecionar fornecedor de SMS: Infobip.
-
Tipo: Escolher Comentários.
-
-
Clique em Enviar para salvar sua configuração de webhook de Comentários.
-
No menu Webhooks, você pode editar ou excluir webhooks existentes.
-
Acesse os Webhooks recém-criados e copie a URL do Webhook de cada um deles.
-
Agora você pode usar esses URLs para ativar URLs de retorno de chamada para trazer eventos de feedback e de entrada para a Journey Optimizer.
Se o webhook usar credenciais de API anexadas a uma configuração de canal existente, o webhook entrará em vigor imediatamente. Caso contrário, crie uma nova configuração de canal.
Para provedor personalizado create-webhook-custom
Para provedores de SMS personalizados, crie dois webhooks separados: um para eventos de Feedback e outro para eventos de Entrada.
-
No painel à esquerda, navegue até Administração
>Canais, selecione o menu Webhooks de SMS em Configurações de SMS e clique no botão Criar Webhook.
-
Defina as configurações do webhook, conforme detalhado abaixo:
-
Nome: digite um nome para o webhook.
-
Selecionar fornecedor de SMS: personalizado.
-
Tipo: escolha Feedback ou Entrada. Você precisa criar ambos separadamente, aqui, começamos com a Entrada.
-
Credenciais da API: escolha no menu suspenso suas credenciais de API configuradas anteriormente.
-
Número de Telefone do Remetente: digite o número de telefone do remetente que você deseja usar para suas comunicações.
-
-
Comece a configurar as palavras-chave de entrada inserindo palavras-chave no campo Inserir uma Palavra-chave. Várias palavras-chave podem ser adicionadas e removidas. Observe que palavras-chave não diferenciam maiúsculas de minúsculas.
-
Selecione uma categoria de palavra-chave no menu suspenso Categoria de Palavra-chave de Entrada para configurar:
-
accordion Opt-In -
Ative as palavras-chave que aceitam os usuários com seu consentimento. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, seu número de telefone é aceito para receber mensagens SMS.
-
Por padrão, as seguintes palavras-chave são ativadas: Subscribe, Yes, Unstop, Continue, Resume e Begin. Remova quaisquer palavras-chave padrão clicando em
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando a mensagem de entrada de um usuário corresponde a uma palavra-chave de aceitação.
-
-
accordion Recusar -
Ative palavras-chave que recusam usuários e remova o consentimento para enviar mensagens de texto. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, o número de telefone dele não recebe mensagens SMS.
-
Por padrão, as seguintes palavras-chave são ativadas: Stop, Quit, Cancel, End, Unsubscribe, No. Remova quaisquer palavras-chave padrão clicando em
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando a mensagem de entrada de um usuário corresponde a uma palavra-chave de recusa.
-
Habilite a Lógica Difusa para detectar palavras-chave semelhantes a palavras-chave de Recusa configuradas. Se a resposta de um usuário for fechada, mas não exata, a mensagem inserida no campo Resposta Automática Difusa será enviada. Normalmente, essa mensagem indica que a recusa não ocorreu e especifica a palavra-chave exata necessária para cancelar a inscrição.
-
-
accordion Aceitação dupla -
Ative palavras-chave para o requisito de aceitação dupla. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, ele não é totalmente aceito nesse estágio. Esse fluxo de trabalho de consentimento em duas etapas requer que os usuários confirmem sua aceitação com uma segunda palavra-chave.
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando uma palavra-chave de aceitação dupla é correspondida. Essa mensagem instrui o usuário a inserir uma palavra-chave de aceitação para concluir o processo de aceitação.
-
-
accordion Ajuda -
Ative palavras-chave que fornecem uma resposta padrão quando a ajuda é solicitada. Quando a mensagem de um usuário corresponde a uma palavra-chave configurada, ele recebe a mensagem Ajuda.
-
Por padrão, as seguintes palavras-chave são ativadas: Ajuda, Informações, Informações. Remova quaisquer palavras-chave padrão clicando em
-
Use o campo Responder Mensagem para criar uma mensagem que é enviada automaticamente quando a mensagem de entrada de um usuário corresponde a uma palavra-chave da Ajuda.
-
-
accordion Personalizado -
Configure uma única palavra-chave personalizada. Quando a mensagem de um usuário corresponde a esta palavra-chave, ela é gravada no conjunto de dados Acompanhamento de feedback da mensagem para criação de relatórios e público-alvo.
-
Crie um Público (streaming ou lote) que faça referência a essa palavra-chave para uso em suas jornadas e campanhas.
-
-
-
Insira uma Mensagem de Resposta Padrão. Esta mensagem é enviada automaticamente quando a resposta de um usuário não corresponde a nenhuma palavra-chave configurada.
-
Crie uma carga personalizada que corresponda ao JSON proveniente do provedor. Observe que o único formato de webhook compatível é o JSON. Os dados de formulário para webhooks não são compatíveis.
O webhook de entrada requer os seguintes campos para receber valores do webhook do seu provedor:
- InboundMessage: a mensagem ou palavra-chave de entrada recebida do usuário.
- ProfileNumber: o número de telefone do usuário que enviou a mensagem.
- RequestID: um identificador exclusivo fornecido pelo seu provedor de SMS para identificar uma transação específica.
- OriginTimestamp: O carimbo de data/hora quando a mensagem é recebida, no formato UTC.
- InboundNumber: o número de telefone usado para esta configuração de webhook.
accordion Exemplo de conteúdo code language-none "json { "mensagem de entrada": "{{inboundMessage}}", "profileNumber": "{{profileNumber}}", "requestId": "{{requestId}}", "originTimestamp": "{{originTimestamp}}", "inboundNumber": "{{inboundNumber}}" " -
Quando o arquivo JSON for criado, clique em Exibir editor de carga, copie e cole sua carga JSON no editor e salve-a.
-
Clique em Enviar para salvar a configuração do webhook.
-
No menu Webhooks, agora é necessário criar um webhook Feedback para o provedor personalizado.
-
Defina as configurações do webhook, conforme detalhado abaixo:
-
Nome: digite um nome para o webhook.
-
Selecionar fornecedor de SMS: personalizado.
-
Tipo: Escolher Comentários.
-
-
Crie uma carga personalizada que corresponda ao formato JSON do seu provedor. Observe que o único formato de webhook compatível é o JSON. Os dados de formulário para webhooks não são compatíveis.
O webhook de feedback requer os seguintes campos para receber valores do webhook do seu provedor:
- Referência de Cliente: um identificador exclusivo retornado na carga para fins de registro em log.
- Código: o código de falha fornecido pelo seu provedor de SMS.
- Status: o status de falha fornecido pelo seu provedor de SMS.
accordion Exemplo de conteúdo code language-none "json { "clientReference": "{{client_reference}}", "status": [ { "código": "{{failureCode}}", "status": "{{feedbackStatus}}" ] " -
Clique em Exibir editor de carga, copie e cole sua carga JSON no editor e salve-a.
-
Clique em Enviar para salvar sua configuração de webhook de Comentários.
-
No menu Webhooks, você pode editar ou excluir webhooks existentes.
-
Acesse os Webhooks recém-criados e copie a URL do Webhook de cada um deles.
-
Configure seu provedor de SMS para enviar eventos de Feedback e Entrada para essas URLs de webhook no Journey Optimizer.
As instruções de configuração variam por provedor de SMS. Consulte a documentação do provedor para obter detalhes sobre como configurar URLs de retorno de chamada.
Se o webhook usar credenciais de API anexadas a uma configuração de canal existente, o webhook entrará em vigor imediatamente. Caso contrário, crie uma nova configuração de canal.