Passar para o conteúdo principal

Disparo de campanha via CRM Insider

Escrito por Caroline Silva

Pré-requisitos

Antes de configurar a integração entre Antes de configurar a integração entre o Journey Builder (Insider) e a API de Campaign (OmniChat), certifique-se de atender aos seguintes requisitos:

  1. Acesso à conta OmniChat com permissões para criar e gerenciar campanhas.

  2. Credenciais de API válidas — x-api-key e x-api-secret.

  3. Uma campanha ativa previamente criada na OmniChat, com o respectivo campaignId a ser usado na chamada.

  4. Conta Insider com acesso ao Journey Builder (Architect) e permissão para criar integrações via Call an API (clique no link para instruções oficiais da Insider).

  5. Os atributos do usuário (como telefone, nome, ID de pedido etc.) devem estar disponíveis no perfil da Insider para uso como variáveis dinâmicas no corpo da requisição.

  6. Ambiente de testes ou sandbox para validar o disparo antes da publicação da jornada em produção.

Exemplo de Requisição a ser configurada na função Call an API da Insider

curl --request POST \ --url https://campaign-api.omni.chat/v1/campaigns/id-da-campaign-omnichat/dispatch?keepValidContacts=true \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --header 'x-api-key: sua-api-key' \ --header 'x-api-secret: sua-api-secret' \ --header 'x-omnichat-platform: Insider' \ --data '{ "contacts": [ { "fullNumber": "{{phone_number}}", "nome": "{{first_name}}", } ] }'

Instruções:

  • Método: POST. Configure a URL Endpoint da API de Campaign da Omnichat no campo abaixo na Insider:

    https://campaign-api.omni.chat/v1/campaigns/id-da-campaign-omnichat/dispatch?keepValidContacts=true

    image-20251014-123312.png

  • Endpoint: Substitua o valor de campaignId na URL (id-da-campaign-omnichat) pelo ID real da sua campanha na OmniChat. Para recuperar este valor, abra o seu app OmniChat, acesse o menu Marketing, Campanhas, identifique na lista a campanha desejada e clique em Editar. No menu lateral “Resumo”, copie e cole o Id, como mostrado no exemplo abaixo:

    image-20251014-124754.png

  • Headers: As chaves x-api-key e x-api-secret devem ter os valores informados reais da sua conta e informados nos headers key/value da Call An API da Insider. A chave x-omnichat-platform deve ter o valor “Insider”.

    image-20251014-123156.png

  • Body: As tags {{phone_number}}, {{first_name}} e são variáveis dinâmicas da Insider (utilize a função Add Dynamic Content da Insider) e serão automaticamente preenchidas pelo perfil do usuário no momento do disparo. Garanta que número do cliente {{phone_number}} esteja no formato DDI+DDD+telefone. Mais informações sobre inclusão de dados dinâmicos, consulte a ajuda oficial da Insider.

    image-20251014-125512.png

    Como resultado final, o body deverá ter esta estrutura:

    { "contacts": [ { "fullNumber": "{{phone_number}}", "nome": "{{first_name}}", } ] }

  • Se quiser testar o fluxo antes de publicar, use números de teste e um sandbox contact na OmniChat.

Artigos relacionados
Respondeu à sua pergunta?