Mensagens

A API de envio de mensagens é muito simples.

Basta enviar uma requisição POST da sua aplicação para o endpoint https://api.mensageiro.io/events/messages

Uma resposta 202 significa que um registro de mensagem foi criado na Mensageiro. Isso não significa que cada mensagem foi enviada e entregue com sucesso.

Para conhecer o status da mensagem, verifique o parâmetro status do registro da mensagem.

Os registros de mensagens podem ser criados com status failed devido à plataforma Mensageiro. Verifique error para saber o motivo da falha. Nesses casos, nenhum valor é deduzido e o total_cost é sempre será zero.

Os registros de mensagens podem ser atualizados para o estado undelivered. Isso ocorre devido a problemas relacionados à operadora / operadora. Verifique error para saber o motivo da falha. Nesses casos, o valor é deduzido do saldo.

Depois de enfileiradas, as mensagens da sua conta são desenfileiradas e processadas na taxa definida para a sua conta (o padrão é 5 mensagens por segundo).

Caso precise aumentar seu limite de taxa, entre em contato com o suporte@mensageiro.io.

POST https://api.mensageiro.io/events/messages

Para uso da API o cliente deve solicitar ao suporte um token de autenticação.

RequestResponse
Headers
Authorization (required)stringsolicite seu token de acesso no vendas@mensageiro.io
Body Parameters
messagesarrayArray de Mensagens
channel (required)stringCanal a ser usado para enviar a mensagem. Ex: "whatsapp", "sms", "email", "instagram", atualmente somente "whatsapp" é aceito no endpoint.
source (required)stringConta de origem da mensagem. Ex. número do telefone de origem, email, conta do Instagram.
destination (required)arrayArray com os números de destino, quando o envio de mensagens for através do channel "whatsapp", destination pode conter apenas um número no array.
content (required)objectConteúdo a ser enviado para os destinos,apenas uma proppriedade deve ser definida text, location ou media.
curl --location --request POST 'https://api.mensageiro.io/events/messages' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic TOKEN' \
--data-raw '{
    "messages": [
        {
            "channel": "whatsapp",
            "source": "+551199998877",
            "destination": [
                "+554896839045"
            ],
            "content": {
                "text": "Greetings from Mensageiro.io",
                "location": {
                    "longitude": -27.5707056,
                    "latitude": -48.75046,
                    "label": "Florianópolis",
                    "address": "Florianópolis!"
                },
                "media": {
                    "url": "https://your.public.url",
                    "caption": "media description"
                }
            }
            
        },
        {
            "channel": "whatsapp",
            "source": "+5519982321055",
            "destination": [
                "+554899617730"
            ],
            "content": {
                "text": "Olá, 2"
            }
        }                
    ]
}'

Também pode ser enviado arquivos informando a url de onde o arquivo está hospedado, conforme o exemplo abaixo.

Vídeos são limitados à 2Mb. Você pode enviar links do Youtube para vídeos maiores.

curl --location --request POST 'https://api.mensageiro.io/events/messages' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic TOKEN' \
--data-raw '{
    "messages": [
        {
            "channel": "whatsapp",
            "source": "+551199998877",
            "destination": [
                "+554896839045"
            ],
            "content": {
                "media": {
                  "url": "https://media.example.com/file",
                  "caption": "your media file"
                 }    
            }
        }              
    ]
}'

Caso necessite de vídeos maiores para uma utilização específica, entre em contato com nosso suporte para encaminharmos sua solicitação para avaliação de viabilidade.

Edit this page