🎫Tickets

Criação de ticket de suporte

POST https://servicedesk.estoca.com.br/v1/support/tickets

Cria um novo ticket no sistema de atendimento. O ticket será criado no Zendesk através da integração configurada.

Headers

Name	Type	Description
Content-Type*	String	Tipo de conteúdo (application/json para POST)
X-API-Key*	String	Chave de API criada através da plataforma

Request Body

Name	Type	Description
subject*	String	Assunto do ticket 1-255 caracteres
description*	String	Descrição detalhada do ticket Mínimo 1 caractere
requester*	Object	Informações do solicitante
requester.name*	String	Nome do solicitante 1-255 caracteres
requester.email*	String	Email do solicitante Deve ser um email válido
priority	String	Prioridade do ticket Valores: "low", "normal", "high", "urgent"
tags	Array	Lista de tags para o ticket
custom_fields	Object	Campos customizados do ticket

201: Created Ticket criado com sucesso

{
    "id": 12346
}

400: Bad Request Dados inválidos

{
    "detail": [
        {
            "type": "string_too_short",
            "loc": ["body", "subject"],
            "msg": "String should have at least 1 character",
            "input": "",
            "ctx": {"min_length": 1}
        }
    ]
}

401: Unauthorized Acesso não autorizado

{
    "detail": "Not authenticated"
}

500: Internal Server Error Erro interno

{
    "detail": "Failed to create ticket"
}

Estrutura de Tickets

Prioridades Disponíveis

• low - Prioridade baixa

• normal - Prioridade normal (padrão)

• high - Prioridade alta

• urgent - Prioridade urgente

Campos Customizados

Os campos customizados são mapeados automaticamente para os campos configurados no seu Zendesk. Apenas campos que existem e estão ativos no Zendesk serão processados.

Limites

A utilização dos recursos de tickets da nossa API são limitadas a no máximo 100 requisições por minuto e esse limite é controlado por empresa.

Caso seja ultrapassado o limite da requisição, o recurso retornará o código de status 429 Too Many Requests e a mensagem Requests limited. Retry after seconds in Headers.

Também será retornado no cabeçalho da requisição (Header) a informação Retry-After que é o tempo em segundos que o seu sistema deverá aguardar até enviar a próxima requisição HTTP.

Ferramentas

Indicamos que sempre seja utilizado ferramentas que tem como objetivo para testar os recursos disponibilizados através do envio de requisições HTTP para análise do seu envio e retorno, antes mesmo de iniciar o desenvolvimento ou ajuste no seu sistema.