👥 Mensagens Em Grupo

SendGroupMessageAPI

post

Endpoint com mais de um formato de payload na coleção oficial: SendGroupMessageAPIFile, SendGroupMessageAPIText. 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(s) a ser enviado (imagem, documento, etc)

bodystringOpcional

Texto da mensagem que acompanhará o arquivo

Example: Mensagem de teste 2

numberstringOpcional

ID do grupo do WhatsApp

Example: 12356818915189153

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

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}/group

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

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

{}

SendMessageAPIFileURLGroup

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

ID do grupo do WhatsApp

Example: 12356818915189153

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}/groupMediaUrl

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

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

{}