Enviando mensagens de texto#

/v1/messages

Use o método messages para enviar mensagens de texto a um contato ou grupo.

Request#

Para enviar uma mensagem de texto, você deve realizar uma requisição do tipo POST em:

POST https://api.green-api.com/v1/messages

{
    "recipient_type": "individual" | "group",
    "to": "whatsapp-id" | "whatsapp-group-id",
    "type": "text",
    "text": {
        "body": "your-text-message-content"
    }
}

Parâmetros de Requisição#

Parâmetro	Tipo	Obrigatório	Descrição
`recipient_type`	string	Não	Define o tipo de destinatário - correspondente ou grupo. Valores possíveis: `individual` - envio para o correspondente; `group` - enviando para um grupo. Valor padrão: `individual`
`to`	string	Sim	ID do contato ou grupo - o destinatário da mensagem`
`type`	string	Não	O tipo de mensagem a ser enviada. Ao enviar uma mensagem de texto, o parâmetro é opcional. Valor padrão: `text`
`text`	object	Sim	Objeto de mensagem de texto

Objeto text

Parâmetro	Tipo	Obrigatório	Descrição
`body`	string	Sim	Mensagem de texto. Pode conter vários URLs e suporte a formatação. O comprimento máximo de uma mensagem de texto é 4096 caracteres. Emokis são suportados 😃.

Exemplo de Requisição#

Enviando uma mensagem a um contato:

{
    "to": "5521985880044",
    "type":"text",    
    "text": {
        "body": "I use Green-API to send this message to you!"
    }    
}

Enviando uma mensagem para um grupo:

{
    "recipient_type": "group",
    "to": "5521985880044-1581234048",
    "type":"text",    
    "text": {
        "body": "I use Green-API to send this message to the Group!"
    }    
}

Resposta#

Em uma resposta bem-sucedida, o código HTTP 201 é retornado

Parâmetros de Resposta#

Campo	Tipo	Descrição
`messages`	array	Array com IDs de mensagens enviadas

Array messages

Campo	Tipo	Descrição
`id`	string	ID de mensagem enviada

Exemplo de Resposta#

201 Created

{
    "messages": [
        {
            "id": "1234"
        }
    ],
    "meta": {
        "api_status": "stable",
        "version": "2.0.1"
    }
}

Erros#

Para obter uma lista de erros comuns a todos os métodos, consulte a seção Erros padrão.

Em caso de erro, o código HTTP 400 é retornado com uma descrição detalhada do erro no corpo da resposta.

Exemplo de Resposta de Erro#

{
    "errors": [
        {
            "code": 82,
            "details": "Outgoing messages limit exceeded",
            "title": "Número de mensagens enviadas excedido"
        }
    ],
    "meta": {
        "api_status": "stable",
        "version": "2.0.1"
    }
}

Exemplo de código Python#

import requests

url = "https://api.green-api.com/v1/messages"

payload = "{\r\n    \"to\": \"5521985887676\",\r\n    \"type\":\"text\",    \r\n    \"text\": {\r\n        \"body\": \"I use Green-API to send this message to you!\"\r\n    }    \r\n}"
headers = {
  'Authorization': 'Bearer {{AuthToken}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))