Criar uma senha de atendimento via API

Resumo #

Neste tutorial, apresentamos um exemplo prático de como utilizar a API da plataforma Meu Atendimento Virtual para a criação de uma senha de atendimento. Através deste guia, você aprenderá a configurar e enviar uma requisição HTTP para gerar uma senha, que será inserida automaticamente na fila de atendimento, respeitando as regras de prioridade e os serviços solicitados pelo cliente.

O link da documentação completa pode ser acessado na área do desenvolvedor da plataforma.

Preparação do Ambiente #

Certifique-se de ter a chave de API, que pode ser obtida dentro do módulo de configurações da plataforma. Instruções sobre o preenchimento do cabeçalho da requisição podem ser encontradas em um tutorial específico sobre isso.

Definição dos Dados do Ticket #

Para criar um ticket na fila de atendimento via API REST, é importante entender cada campo do JSON que será enviado na requisição. Esses campos contêm as informações necessárias para que o sistema possa processar e gerenciar o atendimento de forma eficiente. Vamos detalhar cada um dos elementos que compõem o JSON do ticket:

{
  priority_name: string
  client_key: string
  services: [{
              service_key: string
            }]
}

services (obrigatório) #

• Descrição: Este campo é uma lista de serviços que o cliente deseja acessar. Cada serviço deve ser representado por uma chave única (service_key).
• Estrutura do Campo: O campo services é um array de objetos JSON, onde cada objeto representa um serviço solicitado. Cada serviço tem uma chave (service_key) que o identifica de forma única dentro do sistema. Consulte as chaves do serviço pela rota de listar serviços.
• Impacto: A lista de serviços permite que o sistema saiba exatamente quais tipos de atendimento o cliente está solicitando. Isso ajuda na alocação de recursos, como enviar o ticket para a equipe/usuários corretos ou garantir que todos os serviços solicitados sejam tratados em um único atendimento. Cada serviço listado será associado ao ticket, e a ordem de atendimento pode ser influenciada pela complexidade ou natureza dos serviços.

priority_name (opcional): #

• Descrição: Este campo define a prioridade do ticket dentro da fila de atendimento.
• Valores Possíveis: Pode ser preenchido com o nome de qualquer prioridade cadastrada no sistema. Caso o campo não seja enviado, a senha será criada com prioridade “Normal”
• Impacto: A prioridade determina a ordem de atendimento do ticket.

client_key (opcional): #

• Descrição: Este campo identifica de forma única o cliente que está solicitando o serviço.
• Exemplo de Valor: A chave do cliente pode ser encontrada usando as rotas de buscar/criar de cliente. Caso o campo não seja enviado, a senhas será criada sem o vínculo com um cliente.
• Impacto: Ao fornecer um client_key, o sistema pode associar o ticket ao histórico do cliente, personalizar o atendimento e garantir que as informações relevantes sejam recuperadas rapidamente durante o atendimento. Isso melhora a eficiência e a personalização do serviço.

Envio da Requisição #

• Faça uma requisição HTTP POST para o endpoint /api/v1/tickets/ da API.
• Inclua o JSON com os dados do ticket no corpo da requisição
• Certifique-se de que o cabeçalho da requisição esteja configurado para enviar dados no formato JSON (Content-Type: application/json) além das credenciais com a chave de API.

Exemplo de comando cURL:

curl -X POST https://painel.meuatendimentovirtual.com.br/api/v1/tickets/ \
-H "accept: application/json" \
-H "authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999" 
-d '{
  "priority_name": "preferencial",
  "client_key": "xfrh3456s",
  "services": [
    {
      "service_key": "pri459dn"
    }
  ]
}'

Verificação da Resposta #

Após enviar a requisição, o sistema retornará uma resposta indicando o sucesso ou falha da criação do ticket. Verifique o código de status HTTP. Um código 201 Created indica que o ticket foi criado com sucesso. Analise o corpo da resposta para obter informações adicionais, como o identificador do ticket criado.

Com o ticket criado, ele será automaticamente adicionado à fila de atendimento, respeitando a prioridade definida. Você pode consultar o status do ticket ou atualizar informações adicionais através de outros endpoints da API.