Skip to content

API

Enviar Lead para o SWR

Quando você gera leads no seu site, Landing Page ou qualquer outro meio é posível que seu lead seja enviado diretamente para o SWR via API simples.

Informações importantes

  • O sistema realiza inúmeras verificações para garantir a qualidade do lead e que esse registro não seja duplicado no sistema.

  • Leads com E-mail ou Telefone já registrados no SWR NÃO são duplicados. Caso essas informações já estejam cadastradas, o sistema não gera novo lead e somente sinaliza nova interação.


Método: POST
URL: https://swr-api.app/lead

Header:
Content-Type: application/x-www-form-urlencoded

Campos Tipo Descrição
token string Token fornecido pela equipe SWR.
nome string Nome do cliente/lead. Preferencialmente nome completo
telefone string Número do telefone sem formatação preferencial e com DDD
email string Email válido
utm_source (opcional) string Campo de identificação da origem do lead. Exemplo: facebook, google, meu portal, site, app, etc.
utm_campaign (opcional) string Campo de identificação da campanha do lead. Geralmente ligado ao nome da campanha que está sendo veiculado em mídias sociais.
utm_medium (opcional) string Campo de identificação da mídia de publicidade. Exemplo: banner, cpc, newsletter, etc.
utm_content (opcional) string Este parâmetro permite que você saiba qual apelo à ação gerou tráfego, como “compre hoje” ou “mais informações”.

Exemplo de retorno:
JSON: 

{
  "status": {
    "type": "success",
    "message": "success",
    "code": 200,
    "error": false
  },
  "data": {
      "session": "XXXXXXXXXXXXXXXX"
  }
}

Enviar mensagem

O SWR fornece api simples e diretas para uso, facilitando muito o envio de mensagens rápidas via whatsapp, sms, messenger e e-mail

Abaixo você pode observar como consumir as rotas dos diferentes canais disponíveis:


Whatsapp

Método: POST
URL: https://swr-api.app/api/whatsapp/

Header:
Content-Type: application/x-www-form-urlencoded
x-access-token: "TOKEN FORNECIDO PELO SWR"

Campos Tipo Descrição
to string Número de telefone destino para envio de mensagem de texto. Usar o formato E.164. Exemplo: +55119876543210
from string Número de origem fornecido pelo SWR ou seja o número de whatsapp contratado para a empresa.
message string Mensagem texto que será enviado



SMS

Método: POST
URL: https://swr-api.app/api/sms/

Header:
Content-Type: application/x-www-form-urlencoded
x-access-token: "TOKEN FORNECIDO PELO SWR"

Campos Tipo Descrição
to string Número de telefone destino para envio de mensagem de texto. Usar o formato E.164. Exemplo: +55119876543210
from string Número de origem fornecido pelo SWR ou seja o número de whatsapp contratado para a empresa.
message string Mensagem texto que será enviado



Messenger

Método: POST
URL: https://swr-api.app/api/messenger/

Header:
Content-Type: application/x-www-form-urlencoded
x-access-token: "TOKEN FORNECIDO PELO SWR"

Campos Tipo Descrição
to string Número de telefone destino para envio de mensagem de texto. Usar o formato E.164. Exemplo: +55119876543210
from string Número de origem fornecido pelo SWR ou seja o número de whatsapp contratado para a empresa.
message string Mensagem texto que será enviado



Email

Método: POST
URL: https://swr-api.app/api/email/

Header:
Content-Type: application/x-www-form-urlencoded
x-access-token: "TOKEN FORNECIDO PELO SWR"

Campos Tipo Descrição
to string Email destino para envio de mensagem de texto
from string Email de origem.
body string Corpo de email no formato html
subject string Assunto do email

Webhook

No webhook SWR, você pode criar diversos gatinhos de retorno referente a acões criadas no nosso sistema. Um dos principais webhooks são:

Enviado via: POST

Mensagens de texto recebidas:

{ 
  "id": 12,
  "created_at": "2021-06-30 13:45:56",
  "origin": "client",
  "type": "text",
  "sid": "2384572093487502984759028fDSFD4",
  "channel": "whatsapp",
  "message": "Hello World",
  "session": "hjh4jksdfj23jsj234jk",
  "from": "+55119876543210",
  "to": "+5511555555555"
}



Mensagens com arquivos recebidas:

{ 
  "id": 12,
  "created_at": "2021-06-30 13:45:56",
  "origin": "client",
  "type": "text",
  "sid": "2384572093487502984759028fDSFD4",
  "channel": "whatsapp",
  "message": "",
  "file": "https://storage.swr-api.app/file/image.png",
  "session": "hjh4jksdfj23jsj234jk",
  "from": "+55119876543210",
  "to": "+5511555555555"
}



Mensagens com audio recebidas:

{ 
  "id": 12,
  "created_at": "2021-06-30 13:45:56",
  "origin": "client",
  "type": "text",
  "sid": "2384572093487502984759028fDSFD4",
  "channel": "whatsapp",
  "message": "",
  "file": "https://storage.swr-api.app/file/audio.mp3",
  "session": "hjh4jksdfj23jsj234jk",
  "from": "+55119876543210",
  "to": "+5511555555555"
}



Confirmação de entrega e leitura:

Informações importantes

  • Esse webhook fornece a confirmação de envio, entrega e recebimento de mensagens enviadas via whatsapp e messenger.

  • O campo status pode assumir os seguintes valores: "PENDING", "DELIVERED" ou "READ". Esse webhook é ideal para sinalizar se uma mensagem foi entregue ou visualizada pelo seu cliente.


{ 
  "id": 12,
  "created_at": "2021-06-30 13:45:56",
  "origin": "client",
  "type": "text",
  "sid": "2384572093487502984759028fDSFD4",
  "channel": "whatsapp",
  "status" : "READ", 
  "session": "hjh4jksdfj23jsj234jk",
  "from": "+55119876543210",
  "to": "+5511555555555"
}