Envio de mensagens de texto

Permite que mensagens sejam enviadas pela plataforma WhatsApp para um ou mais destinatários.

POST https://api-messaging.wavy.global/v1/whatsapp/send

O corpo da solicitação de qualquer solicitação deve conter um objeto JSON com os seguintes campos:

Base JSON:

Field	Required	Details	Type
destinations	Sim	Lista de destinatários	Destination[]
message	Sim	Mensagem de texto que será enviada para a lista de destinatários	Message
flowId	Não	Identificação do fluxo do bot	String
defaultExtraInfo	Não	Dados adicionais que identifiquem o envio serão vinculados a todos os destinatários que receberão a mensagem	String
campaignAlias	Não	ID da campanha, está vinculado a todas as mensagens de envio	String

Destination:

Field	Required	Details	Type
correlationId	Não	Seu ID definido será retornado em uma mensagem de confirmação (retorno de chamada). Isso é útil nos casos em que você deseja acompanhar a mensagem enviada, já que você pode definir ids diferentes para mensagens diferentes.	String
destination	Sim	O número de telefone (código do país — 55 para o Brasil — e o estado devem estar presentes) para o qual a mensagem será enviada. Exemplos:5519900001111, [phone], [phone]	String

Message:

Field	Required	Details	Type
messageText	Sim	campo usado para caso você queira enviar uma mensagem personalizada em resposta a uma mensagem recebida.	text
image	Sim	Campo usado para o caso de você querer enviar um conteúdo de imagem.	Image
audio	Sim	Campo usado para o caso de você querer enviar um conteúdo de áudio	Audio
video	Sim	Campo usado para o caso de você querer enviar um conteúdo de vídeo.	Video
document	Sim	Campo usado para o caso de você querer enviar um arquivo de documento.	Document
location	Sim	Campo usado para o caso de você querer enviar um local.	Location
contacts	Sim	Campo utilizado para o caso de você querer enviar contato(s).	Contact[]
previewFirstUrl	Não	Controlar a visualização do primeiro URL enviado pelo aplicativo	Boolean

Apenas uma das seguintes opções de mídia deve ser especificada, seja 'mesageText', image', 'audio', 'document', 'location' ou 'contacts'

Texto:

Somente uma mensagem personalizada deve ser enviada em resposta a uma mensagem recebida pelo usuário sempre que a sessão estiver aberta. Se a sessão não estiver aberta ou o usuário não tiver enviado uma mensagem, o Modelo deverá ser usado.

Exemplo de solicitação de texto

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "messageText":"test message"
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "messageText":"test message"
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "messageText":"test message"
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "messageText":"test message"
   }
}

Java

   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "messageText":"test message"
   }
}

Image:

Field	Required	Details	Type
type	Sim	Tipo/extensão da imagem a ser enviada na mensagem. Opções disponíveis: JPG, JPEG, PNG.	String
caption	Não	Texto a ser apresentado ao usuário sob a imagem.	String
url	Sim	URL onde o conteúdo a ser enviado está hospedado.	String
data	Sim	Conteúdo codificado em Base64	String

Apenas uma das seguintes opções deve ser especificada, seja 'url', caso você queira enviar usando um arquivo, ou 'data', caso você queira enviar a imagem usando codificação base64

Exemplo de solicitação de imagem (URL)

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "url":"https://...jpg",
         "caption":"image description"
      }
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "url":"https://...jpg",
         "caption":"image description"
      }
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "url":"https://...jpg",
         "caption":"image description"
      }
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "url":"https://...jpg",
         "caption":"image description"
      }
   }
}

Java

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "url":"https://...jpg",
         "caption":"image description"
      }
   }
}

Exemplo de solicitação de imagem (Base64)

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "data":"ZmlsZQ=="
      }
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "data":"ZmlsZQ=="
      }
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "data":"ZmlsZQ=="
      }
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "url":"https://...jpg",
         "caption":"image description"
      }
   }
}

Java

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "image":{
         "type":"JPG",
         "data":"ZmlsZQ=="
      }
   }
}

Audio:

Field	Required	Details	Type
type	Sim	Tipo/extensão do áudio a ser enviado na mensagem. Opções disponíveis: AAC, MP4, AMR, MP3, OGG.	String
url	Não	URL onde o conteúdo a ser enviado está hospedado.	String
data	Sim	Conteúdo codificado em Base64	String

Apenas uma das seguintes opções deve ser especificada, seja 'url', caso você queira enviar usando um arquivo, ou 'data', caso você queira enviar o áudio usando codificação base64

Exemplo de solicitação de áudio (URL)

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "url":"https://...mp3"
      }
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "url":"https://...mp3"
      }
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "url":"https://...mp3"
      }
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "url":"https://...mp3"
      }
   }
}

Java

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "url":"https://...mp3"
      }
   }
}

Exemplo de solicitação de áudio (Base64)

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "data":"ZmlsZQ=="
      }
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "data":"ZmlsZQ=="
      }
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "data":"ZmlsZQ=="
      }
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "data":"ZmlsZQ=="
      }
   }
}

Java

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "data":"ZmlsZQ=="
      }
   }
}

Vídeo:

Field	Required	Details	Type
type	Sim	Tipo/extensão do vídeo a ser enviado na mensagem. Opções disponíveis: MP4, 3gpp.	String
caption	Não	Texto a ser apresentado ao usuário sob o vídeo.	String
URL	Sim	URL onde o conteúdo a ser enviado está hospedado.	String
data	Sim	Conteúdo codificado em Base64	String

Apenas uma das seguintes opções deve ser especificada, seja 'url', caso você queira enviar usando um arquivo, ou 'data', caso você queira enviar o vídeo usando codificação base64

Exemplo de solicitação de Vídeo (URL)

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "video":{
         "type":"MP4",
         "url":"https://...mp4",
         "caption":"video description"
      }
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "video":{
         "type":"MP4",
         "url":"https://...mp4",
         "caption":"video description"
      }
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "video":{
         "type":"MP4",
         "url":"https://...mp4",
         "caption":"video description"
      }
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "video":{
         "type":"MP4",
         "url":"https://...mp4",
         "caption":"video description"
      }
   }
}

Java

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "audio":{
         "type":"MP3",
         "data":"ZmlsZQ=="
      }
   }
}

Exemplo de solicitação de Vídeo (Base64)

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "video":{
         "type":"MP4",
         "data":"ZmlsZQ=="
      }
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "video":{
         "type":"MP4",
         "data":"ZmlsZQ=="
      }
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "video":{
         "type":"MP4",
         "data":"ZmlsZQ=="
      }
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "video":{
         "type":"MP4",
         "data":"ZmlsZQ=="
      }
   }
}

Java

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "video":{
         "type":"MP4",
         "data":"ZmlsZQ=="
      }
   }
}

Document:

Field	Required	Details	Type
type	Sim	Tipo/extensão do documento a ser enviado na mensagem. Opções disponíveis: PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX	String
caption	Sim	Texto a ser apresentado ao usuário sob o documento.	String
url	Sim	URL onde o conteúdo a ser enviado está hospedado.	String
data	Sim	Conteúdo codificado em Base64	String

Apenas uma das seguintes opções deve ser especificada, seja 'url', caso você queira enviar usando um arquivo, ou 'data', caso você queira enviar o documento usando codificação base64

Exemplo de solicitação de documento (URL)

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "url":"https://...pdf",
         "caption":"pdf description"
      }
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "url":"https://...pdf",
         "caption":"pdf description"
      }
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "url":"https://...pdf",
         "caption":"pdf description"
      }
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "url":"https://...pdf",
         "caption":"pdf description"
      }
   }
}

Java

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "url":"https://...pdf",
         "caption":"pdf description"
      }
   }
}

Exemplo de solicitação de documento (Base64)

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "data":"ZmlsZQ=="
      }
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "data":"ZmlsZQ=="
      }
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "data":"ZmlsZQ=="
      }
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "data":"ZmlsZQ=="
      }
   }
}

Java

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "document":{
         "type":"PDF",
         "data":"ZmlsZQ=="
      }
   }
}

Localização:

Field	Required	Details	Type
geopoint	Sim	O geoponto do lugar. O formato deve ser: "latitude,longitude"	String
address	Não	Endereço do local.	String
name	Não	Nome do local.	String

Exemplo de solicitação de local

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "location":{
         "geoPoint":"-22.894180,-47.047960",
         "name":"Wavy",
         "address":"Av. Cel. Silva Telles"
      }
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "location":{
         "geoPoint":"-22.894180,-47.047960",
         "name":"Wavy",
         "address":"Av. Cel. Silva Telles"
      }
   }
}

Python

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "location":{
         "geoPoint":"-22.894180,-47.047960",
         "name":"Wavy",
         "address":"Av. Cel. Silva Telles"
      }
   }
}

PHP

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "location":{
         "geoPoint":"-22.894180,-47.047960",
         "name":"Wavy",
         "address":"Av. Cel. Silva Telles"
      }
   }
}

Java

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "message":{
      "location":{
         "geoPoint":"-22.894180,-47.047960",
         "name":"Wavy",
         "address":"Av. Cel. Silva Telles"
      }
   }
}

Contact:

Field	Required	Details	Type
addresses	Não	Endereço(s) de contato completo(s).	Address[]
birthday	Não	Data de aniversário como cadeia de caracteres formatada AAAA-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 de contato.	Org
phones	Não	Telefone(s) de contato.	Phone[]
urls	Não	URL(s) de contato.	Url[]

Exemplo de solicitação de contatos

cURL

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "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"
               }
            ]
         }
      ]
   }
}

Ruby

{
   "destinations":[
      {
         "correlationId":"MyCorrelationId",
         "destination":"5519900001111"
      }
   ],
   "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"
               }
            ],