Mensagens (MO)

Quando o cliente enviar uma mensagem para você, a API da Sinch Messaging enviará uma notificação de solicitação HTTP POST à URL do Webhook com os detalhes.

É importante que seu Webhook retorne uma resposta HTTPS 200 OK às notificações (em até 200 ms ou de maneira assíncrona). Caso contrário, a API da Sinch Messaging considerará essa notificação com falha e tentará novamente após um atraso.

Importante: A URL onde você irá receber os Webhooks precisa ser configurado por nosso time de suporte.

O formato do retorno seguirá a seguinte descrição:

Campo	Detalhes	Tipo
total	Números de callbacks para a ligação.	String
data	Lista de mensagens Mobile Originated (MO).	Data[]

Exemplo de mensagem de texto:

cURL

{
  "total": 1,
  "data": [
    {
      "id": "ce425ffe-bc62-421f-9261-e6819a5eab43",
      "source": "5519900000000",
      "origin": "5519900000000",
      "userProfile": {
        "name": "nome do usuário"
      },
      "campaignId": 100,
      "correlationId": "...",
      "campaignAlias": "...",
      "flowId": "....",
      "extraInfo": "...",
      "message": {
            "type": "TEXT",
"messageText": "Olá, essa é uma mensagem do usuário."
      },
      "receivedAt": 1513616971473,
      "receivedDate": "2017-12-18T17:09:31.473Z"
    }
  ]
}

Ruby

Python

PHP

Java

Campo	Detalhes	Tipo
id	Última identificação da mensagem	String
source	Número de telefone do remetente	String
origin	Número de telefone que identifica a Conta de WhatsApp (incluindo código de pais). Exemplo: 5511900000000.	String
userProfile	Perfil do usuario que enviou a mensagem	UserProfile
correlationId	Um ID unico definido por voce para comparar com o status da mensagem (Callback and DLR). Este parametro é opcional, e voce pode usar o ID gerado pelo Sinch Messaging para fazer a comparação.	String
campaignId	campaignID definido anteriormente.	String
campaignAlias	Campaign alias definido anteriormente.	String
message	Mensagem MO.	mensagem
receivedAt	Data em que a mensagem foi recebida. Format: yyyy-MM-dd’T'HH:mm:ssZ	String
receivedDate	Data em que a mensagem foi recebida, usando Unix_time format	String
extraInfo	Informação extra relacionada com a mensagem. Formato: Json	String
referral	Caso a mensagem tenha se iniciado por um click em alguma propaganda, o campo contém a informação do anúncio/publicação. Esse campo é opcional (pode ser nulo).	Referral
mtSentAt	O timestamp de data/hora em que o último MT foi enviada a este destinatário.	Long
session	Informação da sessão.	Session

Exemplo de mensagem com resposta de botão:

cURL

{
    "total":1,
    "data":[
      {
        "id":"ce425ffe-bc62-421f-9261-e6819a5eab43",
        "source":"5511900000000",
        "origin":"5511900000000",
        "userProfile":{
          "name":"username",
          "whatsAppId":"5511900000000"
          },
        "correlationId":"...",
        "messageId":"aae959ca-5944-405a-809a-75ff142bc234",
        "message":{
            "type":"BUTTON",
            "messageText":"Sim",
            "payload":"sim"
            },
        "receivedAt":1513616971473,
        "receivedDate":"2020-07-22T14:24:41Z",
        "session":{
            "id":"06deff90-cc27-11ea-b94f-0050569e62ca",
            "createdAt":1513616971473
              }
          }
      ],
        "clientInfo":{
            "customerId":10,
            "subAccountId":0,
            "userId":101010
            }
  }

Ruby

Python

PHP

Java

Message:

Campo	Detalhes	Tipo
type	Tipo de mensagem enviada pelo usuário final: TEXT - BUTTON - IMAGE - AUDIO - DOCUMENT	String
messageText	A mensagem de texto (MO) enviada pelo usuário final.	String
waGroupId	Grupo ao qual a mensagem foi enviada.	String
mediaUrl	Url para download da midia enviada pelo usuário final.	String
mimeType	Mime type do arquivo enviado pelo usuário final.	String
caption	Media label enviada pelo usuário final.	String
location	Localidade enviada pelo usuário final.	Location
contacts	Contatos enviados pelo usuário final.	Contact[]

JSON

{
  "total": 1,
  "data": [
    {
      "id": "ce425ffe-bc62-421f-9261-e6819a5eab43",
      "source": "5519900000000",
      "origin": "5519900000000",
      "userProfile": {
        "name": "nome do usuário"
      },
      "campaignId": 100,
      "correlationId": "...",
      "campaignAlias": "...",
      "flowId": "....",
      "extraInfo": "...",
      "message": {
            "type": "IMAGE",
           "mediaUrl": "https://...",
           "mimeType": "image/jpg",
           "caption": "..."
      },
      "receivedAt": 1513616971473,
      "receivedDate": "2017-12-18T17:09:31.473Z"
    }
  ]
}

Referral:

Todos os campos desse objeto são opcionais (podem ser nulos).

Campo	Detalhes	Tipo
headLine	Título do ad que gerou a mensagem.	String
body	Corpo do ad que gerou a mensagem.	String
sourceType	Tipo da propaganda que o usuario clicou. Valores podem ser “ad”, “post” ou “unknown”.	String
sourceId	Identificador da propaganda no Facebook.	String
sourceUrl	Url da propaganda. Leva para a propaganda que o usuario clicou.	String
mediaType	Tipo mídia presente na propaganda. Pode ser “image” ou “video”.	String
mediaUrl	Url da mídia presente na propaganda.	String

Exemplo de mensagem de texto com referral:

JSON

{
  "total": 1,
  "data": [
    {
      "id": "ce425ffe-bc62-421f-9261-e6819a5eab43",
      "source": "5519900000000",
      "origin": "5519900000000",
      "userProfile": {
        "name": "name of the user"
      },
      "campaignId": 100,
      "correlationId": "...",
      "campaignAlias": "...",
      "flowId": "....",
      "extraInfo": "...",
      "referral": {
        "headLine": "...",
        "body": "...",
        "sourceType": "...",
        "sourceId": "...",
        "sourceUrl": "...",
        "mediaType": "...",
        "mediaUrl": "..."
      },
      "mtSentAt": 1513616971473,
      "message": {
        "type": "TEXT",
        "messageText": "Hi, this is a message from the user"
      },
      "receivedAt": 1513616971473,
      "receivedDate": "2017-12-18T17:09:31.473Z"
    }
  ]
}

Session

Field	Details	Type
sessionId	Id da sessão para este usuário.	String
createdAt	Timestamp de criação da sessão	Long

UserProfile:

Campo	Obrigatório	Detalhes	Tipo
name	Não	Nome de perfil do usuário	String

Location

Campo	Detalhes	Tipo
name	Nome do local.	String
address	Endereço do local.	String
geoPoint	Geopoint enviado pelo usuário final. Formato: “latitude,longitude”	String

Exemplo de mensagem de localização:

JSON

{
  "total": 1,
  "data": [
    {
      "id": "ce425ffe-bc62-421f-9261-e6819a5eab43",
      "source": "5519900000000",
      "origin": "5519900000000",
      "userProfile": {
        "name": "nome do usuário"
      },
      "campaignId": 100,
      "correlationId": "...",
      "campaignAlias": "...",
      "flowId": "....",
      "extraInfo": "...",
      "message": {
           "location": {
               "geoPoint": "-22.894180,-47.047960",
               "name": "Sinch",
               "address": "Av. Cel. Silva Telles"
           }
      },
      "receivedAt": 1513616971473,
      "receivedDate": "2017-12-18T17:09:31.473Z"
    }
  ]
}

Contact

Campo	Obrigatório	Detalhes	Tipo
addresses	Não	Endereço(s) completo(s) do contato.	Address[]
birthday	Não	Data de aniversário com formato YYYY-MM-DD.	String
emails	Não	Endereço(s) de e-mail de contato.	Email[]
name	Não	Nome completo do contato.	Name
org	Não	Informações da organização do contato.	Org
phones	Não	Número(s) de telefone do contato.	Phone[]
urls	Não	URL(s) do contato.	Url[]

Exemplo de mensagem de contato:

JSON

{
  "total": 1,
  "data": [
    {
      "id": "ce425ffe-bc62-421f-9261-e6819a5eab43",
      "source": "5519900000000",
      "origin": "5519900000000",      
      "userProfile": {
        "name": "nome do usuário"
      },
      "campaignId": 100,
      "correlationId": "...",
      "campaignAlias": "...",
      "flowId": "....",
      "extraInfo": "...",
      "message": {
           "contacts":[  
                 {  
                    "addresses":[  
                       {  
                          "city":"Menlo Park",
                          "country":"United States",
                          "country_code":"us",
                          "state":"CA",
                          "street":"1 Hacker Way",
                          "type":"HOME",
                          "zip":"94025"
                       },
                       {  
                          "city":"Menlo Park",
                          "country":"United States",
                          "country_code":"us",
                          "state":"CA",
                          "street":"200 Jefferson Dr",
                          "type":"WORK",
                          "zip":"94025"
                       }
                    ],
                    "birthday":"2012-08-18",
                    "emails":[  
                       {  
                          "email":"[e-mail]",
                          "type":"WORK"
                       },
                       {  
                          "email":"[e-mail]",
                          "type":"WORK"
                       }
                    ],
                    "name":{  
                       "first_name":"John",
                       "formatted_name":"John Smith",
                       "last_name":"Smith"
                    },
                    "org":{  
                       "company":"WhatsApp",
                       "department":"Design",
                       "title":"Manager"
                    },
                    "phones":[  
                       {  
                          "phone":"[phone]",
                          "type":"HOME"
                       },
                       {  
                          "phone":"[phone]",
                          "type":"WORK",
                          "wa_id":"16505551234"
                       }
                    ],
                    "urls":[  
                       {  
                          "url":"https://www.fb.com",
                          "type":"WORK"
                       }
                    ]
                 }
              ]
      },
      "receivedAt": 1513616971473,
      "receivedDate": "2017-12-18T17:09:31.473Z"
    }
  ]
}

Address

Campo	Obrigatório	Detalhes	Tipo
street	Não	Nome e número da rua.	String
city	Não	Nome da cidade.	String
state	Não	Sigla do Estado.	String
zip	Não	CEP.	String
country	Não	Nome completo do país.	String
country_code	Não	Abreviação de país (Duas letras).	String
type	Não	Valores Padrões: HOME, WORK.	String

Email

Campo	Obrigatório	Detalhes	Tipo
email	Não	Endereço de e-mail.	String
type	Não	Valores Padrões: HOME, WORK.	String

Name

Campo	Obrigatório	Detalhes	Tipo
first_name	Não	Primeiro nome.	String
last_name	Não	Último nome.	String
middle_name	Não	Nome do meio.	String
name_suffix	Não	Sufixo do nome.	String
name_prefix	Não	Prefixo do nome.	String
formatted_name	Não	Nome completo como normalmente aparece.	String

ORG

Campo	Obrigatório	Detalhes	Tipo
company	Não	Nome da organização do contato.	String
department	Não	Nome do departamento do contato.	String
title	Não	Título corporativo do contato.	String

Phone

Campo	Obrigatório	Detalhes	Tipo
phone	Não	Número de telefone formatado.	String
type	Não	Valores padrões: CELL, MAIN, IPHONE, HOME, WORK.	String
wa_id	Não	Identficador WhatsApp.	String

URL

Campo	Obrigatório	Detalhes	Tipo
url	Não	URL do contato.	String
type	Não	Valores padrões: HOME, WORK.	String

ExtraInfo (Controle de Fluxo de MO- Listas de Segmentação)

A mensagem terá uma lista de listas de segmentação no campo de extraInfo. Nossos parceiros a utilizam para direcionar as mensagens para certos fluxos. O nome da chave é segmentation_lists e ela contém uma lista de SegmentationList.

Campo	Detalhes	Tipo
id	Identificador da lista de segmentação	Integer
customerId	Identificador do cliente	Integer
subAccountId	Identificador da subconta	Integer
name	Nome da lista de segmentação	String
active	Status da lista de segmentação	Boolean

JSON

{  
   "segmentation_list":[  
      {  
         "id":26,
         "customerId":42,
         "subAccountId":0,
         "name":"Wavy WhatsApp Segmentation List",
         "active":true
      },
      {  
         "id":27,
         "customerId":43,
         "subAccountId":0,
         "name":"Wavy WhatsApp Segmentation List 2",
         "active":true
      }
   ]
}

Para os objetos que contêm um campo de tipo, os valores listados são considerados os valores padrões que podem ser vistos, no entanto, você pode definir nesse campo qualquer valor descritivo que desejar.