Neste tutorial, você aprenderá, passo a passo, como criar uma senha de atendimento utilizando a API REST da plataforma Meu Atendimento Virtual. Com esta integração, é possível automatizar a geração de tickets e gerenciar filas de atendimento de forma eficiente, respeitando prioridades e serviços solicitados. Vamos detalhar todo o processo, desde a configuração até a verificação da resposta da API.

Resumo #

A API da plataforma Meu Atendimento Virtual permite criar senhas de atendimento de forma programática, inserindo tickets diretamente na fila com base nos serviços solicitados e nas prioridades definidas. Este guia prático mostra como configurar uma requisição HTTP POST para o endpoint /api/v1/tickets/ e processar a resposta. Para mais detalhes, consulte a documentação oficial da API.

Preparação do Ambiente #

Antes de começar, você precisará:

1. Chave de API: Acesse o módulo de configurações da plataforma Meu Atendimento Virtual para obter sua chave.
2. Ferramenta para requisições HTTP: Use ferramentas como cURL, Postman ou bibliotecas como axios (JavaScript) ou requests (Python).
3. Configuração do cabeçalho: A autenticação é feita via Bearer Token. Configure o cabeçalho Authorization: Bearer <sua-chave> e defina o Content-Type: application/json.

Dica: Consulte o tutorial de autenticação da API para maisComo Criar uma Senha de Atendimento via API no Meu Atendimento Virtual detalhes sobre como configurar o cabeçalho corretamente.

Definição dos Dados do TicketComo Criar uma Senha de Atendimento via API no Meu Atendimento Virtual #

Para criar um ticket, você deve enviar um objeto JSON no corpo da requisição com os seguintes campos:

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

services (obrigatório) #

• Descrição: Lista de serviços que o cliente deseja acessar. Cada serviço é identificado por uma service_key única.
• Estrutura: Array de objetos JSON, onde cada objeto contém a service_key correspondente ao serviço desejado.
• Como obter a service_key: Utilize o endpoint de listagem de serviços (/api/v1/services) para consultar as chaves disponíveis.
• Impacto: Define quais serviços serão associados ao ticket, influenciando a alocação de recursos e a equipe responsável pelo atendimento.

Exemplo:

"services": [
  {
    "service_key": "pri459dn"
  }
]

priority_name (opcional) #

• Descrição: Define a prioridade do ticket na fila de atendimento.
• Valores possíveis: Qualquer prioridade cadastrada no sistema (ex.: “preferencial”, “normal”). Se não informado, o valor padrão é “Normal”.
• Impacto: Determina a ordem de atendimento, priorizando tickets com maior urgência.

client_key (opcional) #

• Descrição: Identifica o cliente associado ao ticket.
• Como obter a client_key: Use os endpoints de busca ou criação de clientes (/api/v1/clients).
• Impacto: Vincula o ticket ao histórico do cliente, permitindo personalização e acesso rápido a informações relevantes.

Nota: O único campo obrigatório é services. Os campos priority_name e client_key são opcionais, mas recomendados para maior controle e personalização.

Envio da Requisição Para Criar uma Senha #

Para criar a senha, envie uma requisição HTTP POST para o endpoint:

https://painel.meuatendimentovirtual.com.br/api/v1/tickets

Configuração da Requisição #

• Método: POST
• Cabeçalhos:
  • accept: application/json
  • Authorization: Bearer <sua-chave-de-api>
  • Content-Type: application/json
• Corpo da requisição: JSON com os dados do ticket.

Exemplo de Requisição com cURL #

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

Exemplo em Python (usando requests) #

import requests

url = "https://painel.meuatendimentovirtual.com.br/api/v1/tickets/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999",
    "Content-Type": "application/json"
}
data = {
    "priority_name": "preferencial",
    "client_key": "xfrh3456s",
    "services": [
        {
            "service_key": "pri459dn"
        }
    ]
}

response = requests.post(url, json=data, headers=headers)
print(response.status_code)
print(response.json())

Verificação da Resposta #

A API retornará uma resposta com o status da criação do ticket. Verifique os seguintes pontos:

• Código de status HTTP:
  • 201 Created: O ticket foi criado com sucesso.
  • 400 Bad Request: Erro nos dados enviados (verifique o JSON).
  • 401 Unauthorized: Chave de API inválida ou ausente.
• Corpo da resposta: Contém detalhes do ticket criado, como:

{
  "key": "ticket123",
  "code": "A001",
  "status": "waiting",
  "created_at": "2025-05-30T13:07:00.000Z",
  "priority_name": "preferencial",
  "service_point_key": "sp456",
  "attendance_key": "att789",
  "client": {
    "key": "xfrh3456s",
    "name": "João Silva",
    "email": "[email protected]",
    "cpf": "123.456.789-00",
    "phone": "+5511999999999"
  },
  "services": [
    {
      "service_key": "pri459dn",
      "name": "Atendimento Prioritário",
      "is_active": true,
      "queue_type": "priority",
      "position": 1
    }
  ]
}

O ticket será automaticamente adicionado à fila de atendimento, respeitando a prioridade e os serviços definidos. Você pode usar outros endpoints da API para consultar o status ou atualizar o ticket.

Conclusão #

Com este tutorial, você aprendeu como criar uma senha de atendimento via API no Meu Atendimento Virtual. A integração permite automatizar a geração de tickets, otimizando o gerenciamento de filas e melhorando a experiência do cliente. Para explorar mais funcionalidades, como consultar serviços ou gerenciar clientes, acesse a documentação completa da API.

Entre em Contato ou Saiba Mais #

Estamos à disposição para ajudar! Acesse nossos canais oficiais:

📞 WhatsApp : Clique aqui para nos enviar uma mensagem
🌐 Plataforma eAgenda : Conheça o eAgenda
🏢 Nossa Empresa : Mupi Systems – Soluções Inovadoras
📧 E-mail : [email protected]
📚 Tutoriais e Documentação : Acesse nossos guias e tutoriais