Abertura de chamados por API

Você pode realizar a abertura de chamados utilizando nossa API. O primeiro passo consiste em gerar um token de acesso, que será utilizado para autenticação da requisição.

Token de acesso

Para criar um token de acesso, faça o login com um usuário administrador, clique no seu avatar e acesse o menu Configurações > Segurança.

Vá até a seção Chaves de acesso e clique em Nova chave de acesso.

Recomendamos que você conceda sempre o menor privilégio necessário. Neste caso específico, você deve criar um token do tipo Atendente, que é o privilégio mínimo necessário para criação de tickets.

Você também pode especificar um tempo máximo de duração, antes que o token expire. Por padrão, os tokens gerados por este processo não possuem data de validade.

Endpoint de tickets

A criação de chamados ocorre por meio de uma chamada POST no endpoint /v1/tickets/ . Você pode consultar a documentação completa em nosso site. Lembre-se de substituir a variável <token> pelo token gerado no passo anterior.

  • Verbo: POST

  • Método: /v1/tickets/

  • Cabeçalhos:

    • X-API-KEY: <token>

    • Content-Type: application/json

  • Conteúdo (JSON):

    • title: Campo obrigatório com o título do chamado.

    • text: Campo obrigatório com o texto do chamado.

    • contact: Objeto com pelo menos um identificador (id, email ou mobile_number) e, opcionalmente, o nome do cliente.

      • name: Nome do solicitante (opcional).

      • id: Identificador do solicitante na Atendo.

      • email: E-mail do solicitante.

      • mobile_number: Telefone celular do solicitante.

    • category_id: (Opcional) Identificador da categoria desejada.

    • priority: (Opcional) Prioridade do ticket. Aceita os valores urgent, high, medium (padrão) e low.

    • source: Identificação da origem do contato (exemplo, "site").

    • medium: Identificação do meio do contato (exemplo: "form").

Abaixo você encontra um exemplo de requisição em cURL:

 curl -X POST -H 'X-API-KEY: <token>' \
  -H 'Content-Type: application/json' \
  https://api-prd-us1.atendo.cloud/v1/tickets/ \
  --data-raw '{"title":"Título", "text":"Chamado teste", "contact": {"email":"[email protected]","name":"Pedro"}}'

Não se esqueça de substituir os parâmetros pelos valores esperados. Caso o número informado não conste na base de contatos, um novo contato será criado e armazenado.

© 2024 Atendo. Todos os direitos reservados.

Powered by