🎫 Tickets
Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
ID do ticket que receberá a tag
4ID da tag que será adicionada (pode usar tagId ou tagIds)
1Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/addTag HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"ticketId": 4,
"tagId": 1
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Atribui tag(s) ao CONTATO sem precisar de ticket. Informe contactId OU number para localizar o contato.
123OU localize pelo numero (aceita variantes BR) "number": "5511999999999", ID da tag a adicionar (use tagId ou tagIds). Mantem as tags existentes.
1Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado
trueRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/addTagContact HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49
{
"contactId": 123,
"tagId": 1,
"validateNumber": true
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Remove tag(s) do CONTATO sem precisar de ticket. Informe contactId OU number para localizar o contato.
5511999999999OU localize pelo ID do contato "contactId": 123, ID(s) da tag a remover (use tagId ou tagIds)
1Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado
trueRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/removeTagContact HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"number": "5511999999999",
"tagIds": [
1,
2
],
"validateNumber": true
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Texto da nota que será adicionada ao ticket
Mensagem da notaID do ticket que receberá a nota
1262ID do usuário que está criando a nota
1Chave ú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}/createNotes HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130
{
"notes": "Mensagem da nota",
"ticketId": 1262,
"userId": 1,
"idFront": "ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK"
}{}Endpoint com mais de um formato de payload na coleção oficial: CreateTicket, CreateTicketFile, CreateTicketWebmail. Veja os exemplos do corpo para escolher a variante.
Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Texto da mensagem inicial do ticket
A mensagem desejadaPara canais WhatsApp/outros: número do contato (formato: 5511999999999)
5535988754197Para canal WEBMAIL: email do contato (obrigatório quando channelId for de um canal webmail) "email": "contato@exemplo.com", ID do canal (opcional). Para webmail: envie o id do canal webmail (não vem do APIConfig) "channelId": 17841443941506797, 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_WEBHOOKID do usuário que está criando o ticket
3Status inicial do ticket (pending ou open)
pendingValidar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado
trueRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/createTicket HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186
{
"body": "A mensagem desejada",
"number": "5535988754197",
"externalKey": "ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK",
"userId": 3,
"status": "pending",
"validateNumber": true
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
ID do ticket
1262Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
GET /v2/api/external/{apiId}/listNotes 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.
ID do ticket que terá a tag removida
4ID da tag que será removida (pode usar tagId ou tagIds)
1Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/removeTag HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"ticketId": 4,
"tagId": 1
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
ID do ticket associado
1262Estado de presence: "typing" (digitando), "paused" (pausado) ou "recording" (gravando)
typingRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/sendPresence HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"ticketId": 1262,
"state": "typing"
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
ID do ticket que terá a fila alterada
4ID da fila que será atribuída ao ticket
1Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/updatequeue HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"ticketId": 4,
"queueId": 1
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
ID do ticket que terá a tag alterada
4ID da tag que será atribuída ao ticket
1Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/updatetag HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"ticketId": 4,
"tag": 1
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
ID do ticket que será atualizado
1262ID do usuário que está fazendo a atualização
1Status do ticket (pending, open, closed)
pendingID da fila do ticket (null para remover)
Status de integração com Typebot
falseStatus de integração com ChatGPT
falseStatus de integração com Dialogflow
falseStatus de integração com Dify
falseStatus de integração com N8N
falseID do fluxo de chat (null para remover)
Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/updateticketinfo HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186
{
"ticketId": 1262,
"userId": 1,
"status": "pending",
"queueId": null,
"typebotStatus": false,
"chatgptStatus": false,
"dialogflowStatus": false,
"difyStatus": false,
"n8nStatus": false,
"chatFlowId": null
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
ID do ticket que terá as mensagens listadas
123Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/showAllMessages HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"ticket": "123"
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Número do WhatsApp do contato (formato: 5511999999999)
5515998566622Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/showallticket HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"number": "5515998566622"
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Número do WhatsApp do contato (formato: 5511999999999)
5515998566622Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/showticket HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"number": "5515998566622"
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
Número do WhatsApp do contato (formato: 5511999999999)
5515998566622Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/showticketchatbot HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"number": "5515998566622"
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
ID da nota que será atualizada
1Novo conteúdo da nota
Conteúdo atualizado da notaRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/updateNote HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"noteId": 1,
"notes": "Conteúdo atualizado da nota"
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
ID do ticket que terá o canal alterado
1262ID do novo canal (WhatsApp)
1Tipo do canal (whatsapp, baileys, zapo, waba, etc)
whatsappRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/updateTicketChannel HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"ticketId": 1262,
"whatsappId": 1,
"channel": "whatsapp"
}{}Atualizado
Isto foi útil?