📨 Mensagens

SendMessageParams

get

Autorizações

BearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatórioExample: your_api_id_here

Parâmetros de consulta

bodyanyOpcional

Texto da mensagem que será enviada

Example: A%20mensagem%20desejadaa

numberanyOpcional

Número do WhatsApp do destinatário (formato: 5511999999999)

Example: 5515998566622

externalKeyanyOpcional

Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)

Example: {{SecretKey}}

bearertokenanyOpcional

Token de autenticação

Example: {{BearerToken}}

isClosedanyOpcional

Define se o ticket será fechado após o envio

Example: false

Corpo

application/json

objectOpcional

Respostas

get

/v2/api/external/{ApiID}/params/

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/params/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

SendMessageAPIText

post

Autorizações

BearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatórioExample: your_api_id_here

Corpo

application/json

objectOpcional

Respostas

post

/v2/api/external/{ApiID}

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 434

"{\n    // Texto da mensagem que será enviada\n    \"body\": \"A mensagem desejada\",\n    \n    // Número do WhatsApp do destinatário (formato: 5511999999999)\n    \"number\": \"5515998566622\",\n    \n    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)\n    \"externalKey\": \"unique_id\",\n    \n    // Define se o ticket será fechado após o envio\n    \"isClosed\": false\n}"

SendMessageAPIFileURL

post

Autorizações

BearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatórioExample: your_api_id_here

Corpo

application/json

objectOpcional

Respostas

post

/v2/api/external/{ApiID}/url

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/url HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 637

"{\r\n    // URL do arquivo que será enviado (imagem, documento, etc)\r\n    \"mediaUrl\": \"https://comunidadezdg.com.br/wp-content/uploads/2022/07/icon100.png\",\r\n    \r\n    // Texto da mensagem que acompanhará o arquivo\r\n    \"body\": \"A mensagem desejada\",\r\n    \r\n    // Número do WhatsApp do destinatário (formato: 5511999999999)\r\n    \"number\": \"5515998566622\",\r\n    \r\n    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)\r\n    \"externalKey\": \"unique_id\",\r\n    \r\n    // Define se o ticket será fechado após o envio\r\n    \"isClosed\": false\r\n}"

SendMessageAPIVoice

post

Autorizações

BearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatórioExample: your_api_id_here

Corpo

application/json

objectOpcional

Respostas

post

/v2/api/external/{ApiID}/voice

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/voice HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 488

"{\n    // URL do arquivo de áudio que será enviado\n    \"audio\": \"https://comunidadezdg.com.br/wp-content/uploads/2022/12/audio.ogg\",\n    \n    // Número do WhatsApp do destinatário (formato: 5511999999999)\n    \"number\": \"5515998566622\",\n    \n    // Chave única do sistema para identificação (valor gerado do seu lado para controle do envio)\n    \"externalKey\": \"unique_id\",\n    \n    // Define se o ticket será fechado após o envio\n    \"isClosed\": false\n}"

SendMessageAPITextBase64

post

Autorizações

BearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatórioExample: your_api_id_here

Corpo

application/json

objectOpcional

Respostas

post

/v2/api/external/{ApiID}/base64

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/base64 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 672

"{\n    // Texto da mensagem que acompanhará o arquivo\n    \"body\": \"A mensagem desejada\",\n    \n    // Número do WhatsApp do destinatário (formato: 5511999999999)\n    \"number\": \"5515998566622\",\n    \n    // Arquivo codificado em base64\n    \"base64Data\": \"iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\",\n    \n    // Tipo MIME do arquivo (ex: image/png, application/pdf)\n    \"mimeType\": \"image/png\",\n    \n    // Nome do arquivo que será exibido\n    \"fileName\": \"exemplo_imagem\",\n    \n    // Define se o ticket será fechado após o envio\n    \"isClosed\": false\n}"