Como Criar uma Senha de Atendimento via API

Atualizado em

Pergunte à IA sobre este tutorial

Neste tutorial, você vai criar uma senha de atendimento usando a API REST do Meu Atendimento Virtual. O processo consiste em montar a requisição com os dados do ticket e enviá-la ao endpoint correto para inserir a senha diretamente na fila. Para consultar a referência completa dos endpoints disponíveis, acesse a documentação oficial da API.

I – Definindo os dados do ticket

A requisição exige um JSON no corpo com os seguintes campos:

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

O único campo obrigatório é services. Os demais são opcionais:

  • services: lista de serviços que o cliente deseja acessar. Cada item exige uma service_key, obtida no endpoint /api/v1/services. Consulte o tutorial Como Configurar Serviços/Filas para saber quais serviços estão disponíveis na sua conta.
  • priority_name: prioridade do ticket na fila (ex.: "preferencial", "normal"). Se não informado, o padrão é "Normal". Veja como cadastrar prioridades no tutorial Como Configurar Prioridades de Atendimento.
  • client_key: chave do cliente a ser associado ao ticket. Você obtém essa chave pelos endpoints /api/v1/clients. Consulte a lista de clientes para localizar a chave correta.

II – Enviando a requisição

Envie uma requisição HTTP POST para:

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

Configure os seguintes cabeçalhos, usando a chave de API disponível nas configurações da plataforma:

  • accept: application/json
  • Authorization: Bearer <sua-chave-de-api>
  • Content-Type: application/json

Exemplo 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:

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())

III – Verificando a resposta

Uma criação bem-sucedida retorna o status 201 Created com o seguinte formato:

{
  "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": "joao@example.com",
    "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 é adicionado automaticamente à fila de atendimento na posição definida pela prioridade.

IV – Erros comuns

  • 400 Bad Request: verifique o JSON enviado. O campo services é obrigatório e deve conter ao menos um objeto com service_key válida.
  • 401 Unauthorized: a chave de API está ausente ou incorreta no cabeçalho Authorization. Acesse as configurações da plataforma para copiar a chave correta.

Para acompanhar as senhas criadas pela API, consulte o tutorial Como Listar Senhas de Atendimento. Para monitorar a fila em tempo real, acesse Como Acompanhar Filas de Atendimento.