📨 Mensagens

GetMessageByMessageId

get

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Parâmetros de consulta

messageIdstringOpcional

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

Example: wamid.xxxxx

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

GET /v2/api/external/{apiId}/getMessageByMessageId HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

SendMessageAPI

post

Endpoint com mais de um formato de payload na coleção oficial: SendMessageAPIFile, SendMessageAPIText. Veja os exemplos do corpo para escolher a variante.

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

mediastring · binaryObrigatório

Arquivo a ser enviado (imagem, documento, etc)

bodystringOpcional

Texto da mensagem que acompanhará o arquivo

Example: Mensagem de teste 2

numberstringOpcional

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 e não pode se repetir)

Example: ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK

isClosedstringOpcional

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

Example: false

validateNumberstringOpcional

Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR (recomendado p/ WABA).

Example: true

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/v2/api/external/{apiId}

POST /v2/api/external/{apiId} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 194

{
  "media": "binary",
  "body": "Mensagem de teste 2",
  "number": "5515998566622",
  "externalKey": "ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK",
  "isClosed": "false",
  "validateNumber": "true"
}

{}

SendMessageAPIFileURL

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

mediaUrlstringOpcional

URL do arquivo que será enviado (imagem, documento, etc)

Example: https://comunidadezdg.com.br/wp-content/uploads/2022/07/icon100.png

bodystringOpcional

Texto da mensagem que acompanhará o arquivo

Example: A mensagem desejada

numberstringOpcional

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 e não pode se repetir)

Example: ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK

isClosedbooleanOpcional

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

Example: false

validateNumberbooleanOpcional

Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Example: true

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/url HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 254

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

{}

SendMessageAPITextBase64

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

bodystringOpcional

Texto da mensagem que acompanhará o arquivo

Example: A mensagem desejada

numberstringOpcional

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

Example: 5515998566622

base64DatastringOpcional

Arquivo codificado em base64

Example: iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==

mimeTypestringOpcional

Tipo MIME do arquivo (ex: image/png, application/pdf)

Example: image/png

fileNamestringOpcional

Nome do arquivo que será exibido

Example: exemplo_imagem

isClosedbooleanOpcional

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

Example: false

validateNumberbooleanOpcional

Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Example: true

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/base64 HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 277

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

{}

SendMessageAPIVoice

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

audiostringOpcional

URL do arquivo de áudio que será enviado

Example: https://comunidadezdg.com.br/wp-content/uploads/2022/12/audio.ogg

numberstringOpcional

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 e não pode se repetir)

Example: ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK

isClosedbooleanOpcional

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

Example: false

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/voice HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

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

{}

SendMessageParams

get

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

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 e não pode se repetir)

Example: ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK

bearertokenstringOpcional

Token de autenticação

Example: {{BearerToken}}

isClosedstringOpcional

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

Example: false

validateNumberstringOpcional

Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR (recomendado p/ WABA).

Example: true

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

GET /v2/api/external/{apiId}/params/ HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}