Positus PT
PositusTeste API grátis ESEN
  • Positus e WhatsApp Business API
  • WhatsApp Benchmark
  • Primeiros passos
    • Como começar a usar
    • Criando Business Facebook
  • Integração WhatsApp API
    • API - Documentação
    • Webhook
    • Exemplos de códigos
  • Positus Studio
  • Positus Studio
  • Sandbox
  • Webhook
  • API - Studio
  • Positus Messenger
    • Positus Messenger
    • FAQ
  • Language
  • English
  • Spanish
  • Sites
  • Website Positus
  • Status Page
  • Suporte
  • Brand guidelines
  • Grupo Robbu
Powered by GitBook
On this page
  • Arquitetura Positus - WhatsApp Business API
  • Postman file
  • messages
  • HSM
  • Contact
  • Location
  • Image
  • Document
  • Video
  • Audio
  • Sticker
  • Download Midia
  • Mensagens Interativas - Lista
  • Mensagens Interativas - Botões

Was this helpful?

  1. Integração WhatsApp API

API - Documentação

Integre agora mesmo com a maior plataforma de comunicação do mundo, WhatsApp Business API por Positus.

PreviousCriando Business FacebookNextWebhook

Last updated 3 years ago

Was this helpful?

Arquitetura Positus - WhatsApp Business API

SDK

Laravel / PHP

Youtube

PHP

Nuget .NET / .NET Core

Github para .NET

Postman file

messages

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Utilize esta rota para enviar mensagens de texto via WhatsApp

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Content-Type

string

application/json

Authentication

string

Autenticação usando Bearer Token

Request Body

Name
Type
Description

object

{ "to": "+5511999999999", "type": "text", "text": { "body": "your-message-content" } }

{
    "messages": [
        {
            "id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
        }
    ],
    "message": "The message was successfully sent"
}
{
    "errors": [
        {
            "code": ,
            "title": "",
            "details": ""
        }
    ],
    "message": ""
}

HSM

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Utilize esta rota para enviar mensagens de notificação via WhatsApp HSM - São templates de mensagens pré-aprovadas pelo Facebook, podem mensagens de texto, midia ou arquivos.

Path Parameters

Name
Type
Description

Chave

string

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

Completo

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"
}
{
    "errors": [
        {
            "code": ,
            "title": "",
            "details": ""
        }
    ],
    "message": ""
}

Contact

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Compartilhe contatos

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

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"
}
{
    "errors": [
        {
            "code": ,
            "title": "",
            "details": ""
        }
    ],
    "message": ""
}

Location

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Compartilhe localizações

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

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"
}
{
    "errors": [
        {
            "code": ,
            "title": "",
            "details": ""
        }
    ],
    "message": ""
}

Image

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Compartilhe imagens

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

object

{ "to": "+5511999999999", "type": "image", "image": { "link": "https://picsum.photos/200", "caption": "your-document-caption" }

{
    "messages": [
        {
            "id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
        }
    ],
    "message": "The message was successfully sent"
}
{
    "errors": [
        {
            "code": ,
            "title": "",
            "details": ""
        }
    ],
    "message": ""
}

Document

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Compartilhe imagens

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

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"
}
{
    "errors": [
        {
            "code": ,
            "title": "",
            "details": ""
        }
    ],
    "message": ""
}

Video

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Compartilhe videos

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

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"
}
{
    "errors": [
        {
            "code": ,
            "title": "",
            "details": ""
        }
    ],
    "message": ""
}

Audio

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Compartilhe audios

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

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"
}
{
    "errors": [
        {
            "code": ,
            "title": "",
            "details": ""
        }
    ],
    "message": ""
}

Sticker

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Compartilhe adesivos. O Formato do adesivo tem que ser exatamente 512x512

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

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}}

Faça o download das midias

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

{
    "messages": [
        {
            "id": "gBGHVRGZmZmZnwIJpWDiExk7olMZ"
        }
    ],
    "message": "The message was successfully sent"
}
{
    "errors": [
        {
            "code": ,
            "title": "",
            "details": ""
        }
    ],
    "message": ""
}

Mensagens Interativas - Lista

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Listar Mensagens: Mensagens incluindo um menu de até 10 opções. Esse tipo de mensagem oferece uma maneira mais simples e consistente para os usuários fazerem uma seleção ao interagir com uma empresa. Mensagens de botão de lista ou de resposta não podem ser usadas como notificações. Atualmente, eles só podem ser enviados dentro de 24 horas da última mensagem enviada pelo usuário. Se você tentar enviar uma mensagem fora da janela de 24 horas, você receberá uma mensagem de erro.

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

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"}]}]}}}

Mensagens Interativas - Botões

POST https://api.positus.global/v2/whatsapp/numbers/{{chave}}/messages

Botões de resposta: Mensagens incluindo até 3 opções — cada opção é um botão. Esse tipo de mensagem oferece uma maneira mais rápida para os usuários fazerem uma seleção a partir de um menu ao interagir com uma empresa. Os botões de resposta têm a mesma experiência do usuário que modelos interativos com botões. Mensagens de botão de lista ou de resposta não podem ser usadas como notificações. Atualmente, eles só podem ser enviados dentro de 24 horas da última mensagem enviada pelo usuário. Se você tentar enviar uma mensagem fora da janela de 24 horas, você receberá uma mensagem de erro.

Path Parameters

Name
Type
Description

Chave

string

Código único por número de WhatsApp

Headers

Name
Type
Description

Authentication

string

Autenticação usando Bearer Token

Content-Type

string

application/json

Request Body

Name
Type
Description

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"}}]}}}

Token de Produção: O seu token será gerado e fornecido pela Positus, ele dará acesso a todos os seus números de WhatsApp Business API. A chave será fornecido após ativação de cada número de WhatsApp Business API. Sandbox - Token desenvolvimento: Você poderá gerar o seu token diretamente pelo .

O Postman é uma ferramenta que tem como objetivo testar serviços RESTful (Web APIs) por meio do envio de requisições HTTP e da análise do seu retorno.

Documentação completa:

Documentação completa:

http://studio.posit.us/
Download Postman App
https://developers.facebook.com/docs/whatsapp/guides/interactive-messages
https://developers.facebook.com/docs/whatsapp/guides/interactive-messages
https://github.com/positusapps/positus-api-laravel-client
https://github.com/positusapps/positus-api-php-client
Youtube
https://www.nuget.org/packages/positus-api-csharp-client/
YouTube
https://github.com/positusapps/positus-api-csharp-client
32KB
Positus API (October 2020).postman_collection.json
API for production
9KB
Positus API Sandbox (November 2020).postman_collection.json
API for development SandBox