> For the complete documentation index, see [llms.txt](https://ajuda.zdg.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.zdg.com.br/central-do-assinante/referencia-da-api/tickets.md). # 🎫 Tickets ## POST /v2/api/external/{apiId}/addTag > AddTag ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/addTag":{"post":{"tags":["🎫 Tickets"],"summary":"AddTag","operationId":"AddTag","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"integer","description":"ID do ticket que receberá a tag"},"tagId":{"type":"integer","description":"ID da tag que será adicionada (pode usar tagId ou tagIds)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/addTagContact > AddTagContact ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/addTagContact":{"post":{"tags":["🎫 Tickets"],"summary":"AddTagContact","operationId":"AddTagContact","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactId":{"type":"integer","description":"Atribui tag(s) ao CONTATO sem precisar de ticket. Informe contactId OU number para localizar o contato."},"tagId":{"type":"integer","description":"OU localize pelo numero (aceita variantes BR) \"number\": \"5511999999999\", ID da tag a adicionar (use tagId ou tagIds). Mantem as tags existentes."},"validateNumber":{"type":"boolean","description":"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"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/removeTagContact > RemoveTagContact ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/removeTagContact":{"post":{"tags":["🎫 Tickets"],"summary":"RemoveTagContact","operationId":"RemoveTagContact","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"Remove tag(s) do CONTATO sem precisar de ticket. Informe contactId OU number para localizar o contato."},"tagIds":{"type":"array","description":"OU localize pelo ID do contato \"contactId\": 123, ID(s) da tag a remover (use tagId ou tagIds)","items":{"type":"integer"}},"validateNumber":{"type":"boolean","description":"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"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/createNotes > CreateNotes ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/createNotes":{"post":{"tags":["🎫 Tickets"],"summary":"CreateNotes","operationId":"CreateNotes","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"notes":{"type":"string","description":"Texto da nota que será adicionada ao ticket"},"ticketId":{"type":"integer","description":"ID do ticket que receberá a nota"},"userId":{"type":"integer","description":"ID do usuário que está criando a nota"},"idFront":{"type":"string","description":"Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## CreateTicket > Endpoint com mais de um formato de payload na coleção oficial: \*\*CreateTicket\*\*, \*\*CreateTicketFile\*\*, \*\*CreateTicketWebmail\*\*. Veja os exemplos do corpo para escolher a variante. ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/createTicket":{"post":{"tags":["🎫 Tickets"],"summary":"CreateTicket","operationId":"CreateTicket","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"Texto da mensagem inicial do ticket"},"number":{"type":"string","description":"Para canais WhatsApp/outros: número do contato (formato: 5511999999999)"},"externalKey":{"type":"string","description":"Para 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)"},"userId":{"type":"integer","description":"ID do usuário que está criando o ticket"},"status":{"type":"string","description":"Status inicial do ticket (pending ou open)"},"validateNumber":{"type":"boolean","description":"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"}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"media":{"type":"string","format":"binary","description":"Arquivo a ser enviado (imagem, documento, etc)"},"body":{"type":"string","description":"Texto da mensagem inicial do ticket"},"number":{"type":"string","description":"Número do WhatsApp do contato (formato: 5511999999999)"},"externalKey":{"type":"string","description":"Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)"},"userId":{"type":"string","description":"ID do usuário que está criando o ticket"},"status":{"type":"string","description":"Status inicial do ticket (pending, open, closed)"},"kanbanId":{"type":"string","description":"ID do kanban (opcional)"},"chatFlowId":{"type":"string","description":"ID do fluxo de chat (opcional)"},"queueId":{"type":"string","description":"ID da fila (opcional)"},"channelId":{"type":"string","description":"ID do canal (opcional). Para webmail: envie o id do canal webmail"},"email":{"type":"string","description":"Para canal webmail: email do contato (obrigatório quando usar channelId de webmail)"},"name":{"type":"string","description":"Para webmail: nome do contato (opcional)"},"validateNumber":{"type":"string","description":"Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR (recomendado p/ WABA)."}},"required":["media"]}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}},"description":"Endpoint com mais de um formato de payload na coleção oficial: **CreateTicket**, **CreateTicketFile**, **CreateTicketWebmail**. Veja os exemplos do corpo para escolher a variante."}}}} ``` ## GET /v2/api/external/{apiId}/listNotes > ListNotes ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listNotes":{"get":{"tags":["🎫 Tickets"],"summary":"ListNotes","operationId":"ListNotes","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"ticketId","in":"query","required":false,"description":"ID do ticket","schema":{"type":"integer"}}],"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/removeTag > RemoveTag ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/removeTag":{"post":{"tags":["🎫 Tickets"],"summary":"RemoveTag","operationId":"RemoveTag","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"integer","description":"ID do ticket que terá a tag removida"},"tagId":{"type":"integer","description":"ID da tag que será removida (pode usar tagId ou tagIds)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/sendPresence > SendPresence ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/sendPresence":{"post":{"tags":["🎫 Tickets"],"summary":"SendPresence","operationId":"SendPresence","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"integer","description":"ID do ticket associado"},"state":{"type":"string","description":"Estado de presence: \"typing\" (digitando), \"paused\" (pausado) ou \"recording\" (gravando)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/updatequeue > SetQueue ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/updatequeue":{"post":{"tags":["🎫 Tickets"],"summary":"SetQueue","operationId":"SetQueue","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"integer","description":"ID do ticket que terá a fila alterada"},"queueId":{"type":"integer","description":"ID da fila que será atribuída ao ticket"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/updatetag > SetTag ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/updatetag":{"post":{"tags":["🎫 Tickets"],"summary":"SetTag","operationId":"SetTag","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"integer","description":"ID do ticket que terá a tag alterada"},"tag":{"type":"integer","description":"ID da tag que será atribuída ao ticket"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/updateticketinfo > SetTicketInfo ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/updateticketinfo":{"post":{"tags":["🎫 Tickets"],"summary":"SetTicketInfo","operationId":"SetTicketInfo","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"integer","description":"ID do ticket que será atualizado"},"userId":{"type":"integer","description":"ID do usuário que está fazendo a atualização"},"status":{"type":"string","description":"Status do ticket (pending, open, closed)"},"queueId":{"type":"string","description":"ID da fila do ticket (null para remover)","nullable":true},"typebotStatus":{"type":"boolean","description":"Status de integração com Typebot"},"chatgptStatus":{"type":"boolean","description":"Status de integração com ChatGPT"},"dialogflowStatus":{"type":"boolean","description":"Status de integração com Dialogflow"},"difyStatus":{"type":"boolean","description":"Status de integração com Dify"},"n8nStatus":{"type":"boolean","description":"Status de integração com N8N"},"chatFlowId":{"type":"string","description":"ID do fluxo de chat (null para remover)","nullable":true}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/showAllMessages > ShowAllMessages ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/showAllMessages":{"post":{"tags":["🎫 Tickets"],"summary":"ShowAllMessages","operationId":"ShowAllMessages","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticket":{"type":"string","description":"ID do ticket que terá as mensagens listadas"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/showallticket > ShowAllTicketInformation ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/showallticket":{"post":{"tags":["🎫 Tickets"],"summary":"ShowAllTicketInformation","operationId":"ShowAllTicketInformation","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"Número do WhatsApp do contato (formato: 5511999999999)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/showticket > ShowTicketInformation ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/showticket":{"post":{"tags":["🎫 Tickets"],"summary":"ShowTicketInformation","operationId":"ShowTicketInformation","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"Número do WhatsApp do contato (formato: 5511999999999)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/showticketchatbot > ShowTicketInformationChatBot ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/showticketchatbot":{"post":{"tags":["🎫 Tickets"],"summary":"ShowTicketInformationChatBot","operationId":"ShowTicketInformationChatBot","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"Número do WhatsApp do contato (formato: 5511999999999)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/updateNote > UpdateNote ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/updateNote":{"post":{"tags":["🎫 Tickets"],"summary":"UpdateNote","operationId":"UpdateNote","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"noteId":{"type":"integer","description":"ID da nota que será atualizada"},"notes":{"type":"string","description":"Novo conteúdo da nota"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` ## POST /v2/api/external/{apiId}/updateTicketChannel > UpdateTicketChannel ```json {"openapi":"3.0.3","info":{"title":"Z-PRO — API Externa","version":"v4.x.x.x"},"tags":[{"name":"🎫 Tickets"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Z-PRO do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Z-PRO, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Z-PRO.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/updateTicketChannel":{"post":{"tags":["🎫 Tickets"],"summary":"UpdateTicketChannel","operationId":"UpdateTicketChannel","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"integer","description":"ID do ticket que terá o canal alterado"},"whatsappId":{"type":"integer","description":"ID do novo canal (WhatsApp)"},"channel":{"type":"string","description":"Tipo do canal (whatsapp, baileys, zapo, waba, etc)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ajuda.zdg.com.br/central-do-assinante/referencia-da-api/tickets.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.