For the complete documentation index, see llms.txt. This page is also available as Markdown.

📤 Envio Em Lote

BulkDispatchIncrementProgress

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.

dispatchIdstringObrigatório

Identificador do recurso na rota.

Corpo
successbooleanOpcionalExample: true
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/bulkDispatch/incrementProgress/{dispatchId}
POST /v2/api/external/{apiId}/bulkDispatch/incrementProgress/{dispatchId} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "success": true
}
{}

BulkDispatchList

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
pageintegerOpcionalExample: 1
limitintegerOpcionalExample: 20
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/bulkDispatch/list
GET /v2/api/external/{apiId}/bulkDispatch/list HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

BulkDispatchShow

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.

dispatchIdstringObrigatório

Identificador do recurso na rota.

Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/bulkDispatch/show/{dispatchId}
GET /v2/api/external/{apiId}/bulkDispatch/show/{dispatchId} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

BulkDispatchUpdate

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.

dispatchIdstringObrigatório

Identificador do recurso na rota.

Corpo
statusstringOpcionalExample: cancelled
cancellationReasonstringOpcionalExample: Cancelado pelo usuário
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/bulkDispatch/update/{dispatchId}
POST /v2/api/external/{apiId}/bulkDispatch/update/{dispatchId} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "status": "cancelled",
  "cancellationReason": "Cancelado pelo usuário"
}
{}

BulkFastMessage

post

v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.

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
whatsappIdstringOpcionalExample: {{whatsappId}}
whatsappTypestringOpcionalExample: baileys
arrayNumbersstring[]OpcionalExample: 5511999990001
messagestringOpcionalExample: Olá, mensagem rápida!
minintegerOpcionalExample: 3
maxintegerOpcionalExample: 8
Respostas
200

Requisição processada com sucesso.

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

{
  "whatsappId": "{{whatsappId}}",
  "whatsappType": "baileys",
  "arrayNumbers": [
    "5511999990001",
    "5511999990002"
  ],
  "message": "Olá, mensagem rápida!",
  "min": 3,
  "max": 8
}
{}

BulkIndividual

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
whatsappIdstringOpcionalExample: {{whatsappId}}
numberstringOpcionalExample: 5511999990001
messagestringOpcionalExample: Olá, mensagem individual!
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
Respostas
200

Requisição processada com sucesso.

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

{
  "whatsappId": "{{whatsappId}}",
  "number": "5511999990001",
  "message": "Olá, mensagem individual!",
  "externalKey": "ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK"
}
{}

BulkSendMessage

post

v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.

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
whatsappIdstringOpcionalExample: {{whatsappId}}
arrayNumbersstring[]OpcionalExample: 5511999990001
messagestringOpcionalExample: Olá, tudo bem?
minintegerOpcionalExample: 3
maxintegerOpcionalExample: 8
Respostas
200

Requisição processada com sucesso.

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

{
  "whatsappId": "{{whatsappId}}",
  "arrayNumbers": [
    "5511999990001",
    "5511999990002"
  ],
  "message": "Olá, tudo bem?",
  "min": 3,
  "max": 8
}
{}

BulkSendMessageWithVariable

post

v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, o destinatario com ticket aberto ou pendente (em qualquer canal) NAO recebe o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.

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
whatsappIdstringOpcionalExample: {{whatsappId}}
messagestringOpcionalExample: Olá {nome}, seu código é {codigo}
dataInputstringOpcionalExample: 5511999990001,João,ABC123 5511999990002,Maria,DEF456
minintegerOpcionalExample: 3
maxintegerOpcionalExample: 8
Respostas
200

Requisição processada com sucesso.

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

{
  "whatsappId": "{{whatsappId}}",
  "message": "Olá {nome}, seu código é {codigo}",
  "dataInput": "5511999990001,João,ABC123\n5511999990002,Maria,DEF456",
  "min": 3,
  "max": 8
}
{}

Atualizado

Isto foi útil?