📨 Mensagens

GetMessageByMessageId

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/getMessageByMessageId

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

messageIdstringOpcional

ID da mensagem retornado pela Meta (ex: wamid.xxxxx)

Example: wamid.xxxxx

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/getMessageByMessageId

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/getMessageByMessageId HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

SendMessageAPIText

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

bodystringOpcional

numberstringOpcional

externalKeystringOpcional

isClosedbooleanOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}

HTTPcURLJavaScriptPython

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

{
  "body": "A mensagem desejada",
  "number": "5515998566622",
  "externalKey": "{{SecretKey}}",
  "isClosed": false
}

200

Successful response

SendMessageAPIFileURL

post

https://{{baseurl}}https://{{BaseUrl}}

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

mediaUrlstringOpcional

bodystringOpcional

numberstringOpcional

externalKeystringOpcional

isClosedbooleanOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "mediaUrl": "https://comunidadezdg.com.br/wp-content/uploads/2022/07/icon100.png",
  "body": "A mensagem desejada",
  "number": "5515998566622",
  "externalKey": "{{SecretKey}}",
  "isClosed": false
}

200

Successful response

SendMessageAPITextBase64

post

https://{{baseurl}}https://{{BaseUrl}}

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

bodystringOpcional

numberstringOpcional

base64DatastringOpcional

mimeTypestringOpcional

fileNamestringOpcional

isClosedbooleanOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "body": "A mensagem desejada",
  "number": "5515998566622",
  "base64Data": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
  "mimeType": "image/png",
  "fileName": "exemplo_imagem",
  "isClosed": false
}

200

Successful response

SendMessageAPIVoice

post

https://{{baseurl}}https://{{BaseUrl}}

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

audiostringOpcional

numberstringOpcional

externalKeystringOpcional

isClosedbooleanOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "audio": "https://comunidadezdg.com.br/wp-content/uploads/2022/12/audio.ogg",
  "number": "5515998566622",
  "externalKey": "{{SecretKey}}",
  "isClosed": false
}

200

Successful response

SendMessageParams

get

https://{{baseurl}}https://{{BaseUrl}}

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

bodystringOpcional

Texto da mensagem que será enviada

Example: A%20mensagem%20desejadaa

numberintegerOpcional

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

Example: 5515998566622

externalKeystringOpcional

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

Example: {{SecretKey}}

bearertokenstringOpcional

Token de autenticação

Example: {{BearerToken}}

isClosedbooleanOpcional

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

Example: false

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/params/ HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response