📤 Envio Em Lote
Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Identificador do recurso na rota.
trueRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
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
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
120Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
GET /v2/api/external/{apiId}/bulkDispatch/list HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Identificador do recurso na rota.
Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
GET /v2/api/external/{apiId}/bulkDispatch/show/{dispatchId} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Identificador do recurso na rota.
cancelledCancelado pelo usuárioRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
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"
}{}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.
Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
{{whatsappId}}baileys5511999990001Olá, mensagem rápida!38Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
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
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
{{whatsappId}}5511999990001Olá, mensagem individual!Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOKRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
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"
}{}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.
Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
{{whatsappId}}5511999990001Olá, tudo bem?38Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
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
}{}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.
Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
{{whatsappId}}Olá {nome}, seu código é {codigo}5511999990001,João,ABC123 5511999990002,Maria,DEF45638Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
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?

