API - Documentación
Integre ahora con la plataforma de comunicación más grande del mundo, WhatsApp Business API de Positus.
Arquitectura Positus - WhatsApp Business API

SDK
Postman file
Postman es una herramienta que tiene como objetivo probar los servicios RESTful (API web) enviando solicitudes HTTP y analizando sus comentarios. Descargar la aplicación Postman
mensaje
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Use esta ruta para enviar mensajes de texto a través de WhatsAppWhatsApp.
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Content-Type
string
application/json
Authentication
string
Autenticación usando Bearer Token
Request Body
object
{ "to": "+5511999999999", "type": "text", "text": { "body": "your-message-content" } }
{
"messages": [
{
"id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
}
],
"message": "The message was successfully sent"
}
HSM
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Use esta ruta para enviar mensajes de notificación via WhatsApp HSM - Son plantillas de mensajes preaprobadas pelo Facebook, pueden enviar mensajes de texto, midia ou arquivos.
Path Parameters
Chave
string
Headers
Authentication
string
Autenticação usando Bearer Token
Content-Type
string
application/json
Request Body
Full Body
string
{ "to": "+551199999999", "type": "template", "template": { "namespace": "xxxxxxx", "language": { "policy": "deterministic", "code": "pt_BR" }, "name": "xxxxxx", "components": [ { "type": "header", "parameters": [ { "type": "image", "image": { "link": "https://dealers.rewebmkt.com/images/20190417084518-actros-3-1280.jpg" } } ] }, { "type": "body", "parameters": [ { "type": "text", "text": "Rafael" }, { "type": "text", "text": "Mercedes-Benz" }, { "type": "text", "text": "Actros" }, { "type": "text", "text": "Cardiesel - Belo Horizonte" }, { "type": "text", "text": "08/05/2020" } ] }, { "type": "button", "sub_type" : "url", "index": "0", "parameters": [ { "type": "text", "text": "fMYMyV8x" } ] } ] } }
Botões
string
{ "to": "+5511999999999", "type": "template", "template": { "namespace": "dc730af3_d5a86", "language": { "policy": "deterministic", "code": "pt_BR" }, "name": "carteiro_botoes", "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "Robbu" }, { "type": "text", "text": "Thiago Thamiel" } ] }, { "type": "button", "sub_type": "quick_reply", "index": "0" } ] } }
Texto
object
{ "to": "+55119999999999", "type": "hsm", "hsm": { "namespace": "52_2bca4fad4c4a", "element_name": "fgv_3", "language": { "policy": "deterministic", "code": "pt_BR" }, "localizable_params": [ { "default": "Thiago" } ] } }
{
"messages": [
{
"id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
}
],
"message": "The message was successfully sent"
}
Contact
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Compartir contactos
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticación usando Bearer Token
Content-Type
string
application/json
Request Body
object
{ "to": "+5511999999999", "type": "contacts", "contacts":[{ "addresses": [], "emails": [], "ims": [], "name": { "first_name": "Positus Provider", "formatted_name": "Positus Provider" }, "org": [], "phones": [{ "phone": "+55 11 2626-4234", "type": "CELL", "wa_id": "551126264234" }], "urls": [] }] }
{
"messages": [
{
"id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
}
],
"message": "The message was successfully sent"
}
Location
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Compartir ubicaciones
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticación usando Bearer Token
Content-Type
string
application/json
Request Body
object
{ "to": "+5511999999999", "type": "location", "location": { "longitude": -46.662787, "latitude": -23.553610, "name": "Robbu Brazil", "address": "Av. Angélica, 2530 - Bela Vista, São Paulo - SP, 01228-200" } }
{
"messages": [
{
"id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
}
],
"message": "The message was successfully sent"
}
Image
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Compartir imágenes
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticación usando Bearer Token
Content-Type
string
application/json
Request Body
object
{ "to": "+5511999999999", "type": "image", "image": { "link": "https://picsum.photos/200", "caption": "your-document-caption" }
{
"messages": [
{
"id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
}
],
"message": "The message was successfully sent"
}
Document
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Compartr imágenes
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticación usando Bearer Token
Content-Type
string
application/json
Request Body
object
{ "to": "+5511941489395", "type": "document", "document": { "link": "http://www.pdf995.com/samples/pdf.pdf", "caption": "your-document-caption" }
{
"messages": [
{
"id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
}
],
"message": "The message was successfully sent"
}
Video
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Compartir videos
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticación usando Bearer Token
Content-Type
string
application/json
Request Body
object
{ "to": "+5511999999999", "type": "video", "video": { "link": "https://sample-videos.com/video123/mp4/720/big_buck_bunny_720p_1mb.mp4", "caption": "your-document-caption" }
{
"messages": [
{
"id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
}
],
"message": "The message was successfully sent"
}
Audio
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Compartir audios
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticación usando Bearer Token
Content-Type
string
application/json
Request Body
object
{ "to": "+5511999999999", "type": "audio", "audio": { "link": "https://sample-videos.com/audio/mp3/crowd-cheering.mp3" }
{
"messages": [
{
"id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
}
],
"message": "The message was successfully sent"
}
Sticker
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Comparte pegatinas. El formato de la etiqueta debe ser exactamente 512x512
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticación usando Bearer Token
Content-Type
string
application/json
Request Body
object
{ "to": "+5511999999999", "type": "sticker", "sticker": { "link": "https://studio.posit.us/api/samples/sticker.webp" }
Download Midia
GET
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/media/{{messages.type.id}}
Descargar los medios
Path Parameters
chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticación usando Bearer Token
Content-Type
string
application/json
{
"messages": [
{
"id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
}
],
"message": "The message was successfully sent"
}
Mensajería interactiva: lista
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Lista de mensajes: mensajes que incluyen un menú de hasta 10 opciones. Este tipo de mensaje ofrece una forma más sencilla y coherente para que los usuarios realicen una selección al interactuar con una empresa. El botón de lista o los mensajes de respuesta no se pueden utilizar como notificaciones. Actualmente, solo se pueden enviar dentro de las 24 horas posteriores al último mensaje enviado por el usuario. Si intenta enviar un mensaje fuera del período de 24 horas, recibirá un mensaje de error.
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticação usando Bearer Token
Content-Type
string
application/json
Request Body
string
{"to":"+5511999999999","type":"interactive","interactive":{"type":"list","header":{"type":"text","text":"CryptoBank"},"body":{"text":"Olá senhor Thiago Thamiel, me chamo Francisco Dabus estou falando referente ao Banco CryptoBank e você já pode regular sua pendência financeira por aqui. Veja as opções que preparamos para você!\n\n💼 Contrato: 82782361236213\n🗓️ Vencimento: 01/01/2021\n💰 Valor Atualizado: 232,83"},"footer":{"text":"Demonstração Robbu"},"action":{"button":"Opções de pagamento","sections":[{"title":"Atualização","rows":[{"id":"7","title":"Vencimento Hoje","description":"💰 R$ 201,23 - Parcelas 17 até 19 de 24"},{"id":"1","title":"Vencimento Amanha","description":"💰 R$ 219,32 - Parcelas 17 até 19 de 24"}]},{"title":"Quitação","rows":[{"id":"3","title":"Vencimento Hoje","description":"💰 R$ 1.323,21 - Todas as parcelas restantes"},{"id":"4","title":"Vencimento Amanha","description":"💰 R$ 1.382,34 - Todas as parcelas restantes"}]}]}}}
Mensajería interactiva: botones
POST
https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages
Botones de respuesta: mensajes que incluyen hasta 3 opciones; cada opción es un botón. Este tipo de mensaje ofrece una forma más rápida para que los usuarios realicen una selección de un menú cuando interactúan con una empresa. Los botones de respuesta tienen la misma experiencia de usuario que los modelos de botones interactivos.
Path Parameters
Chave
string
Código único por número de WhatsApp
Headers
Authentication
string
Autenticação usando Bearer Token
Content-Type
string
application/json
Request Body
string
{"to":"+5511999999999","type":"interactive","recipient_type":"individual","interactive":{"type":"button","header":{"type":"text","text":"1 mês grátis"},"body":{"text":"Ótima escolha, agora você já pode ativar o seu número e realizar testes por 1 mês sem compromisso."},"footer":{"text":"https://posit.us"},"action":{"buttons":[{"type":"reply","reply":{"id":"unique-postback-id-1","title":"Criar conta grátis"}},{"type":"reply","reply":{"id":"unique-postback-id-2","title":"Falar com atendente"}}]}}}
Last updated
Was this helpful?