Como Criar um Grupo de Serviços via API

Neste tutorial, você vai criar um grupo de serviços na plataforma usando a API REST do Meu Atendimento Virtual. Esse recurso ajuda a organizar a exibição de serviços na tela, inclusive com suporte a estruturas recursivas de grupos e subgrupos. Para consultar a referência completa dos endpoints disponíveis, acesse a documentação oficial da API.

I – Definindo os dados do grupo

A requisição aceita um JSON no corpo. O campo obrigatório é group_name. Os demais são opcionais.

{
  "group_name": "Serviços Administrativos",
  "type_group": "service",
  "icon": "https://exemplo.com/icons/servicos-administrativos.png"
}

Campos do corpo da requisição:

• group_name (obrigatório): nome do grupo de serviços.
• type_group (opcional): tipo do grupo. Valores permitidos:
  • service: grupo de serviços.
  • group: grupo de grupos (estrutura recursiva).
• icon (opcional): URL de imagem para representar o grupo na tela.

Se type_group não for enviado, defina o valor no payload conforme a estrutura que deseja montar.

II – Enviando a requisição

Envie uma requisição HTTP POST para:

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

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/grupos/ \
-H "accept: application/json" \
-H "Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999" \
-H "Content-Type: application/json" \
-d '{
  "group_name": "Serviços Administrativos",
  "type_group": "service",
  "icon": "https://exemplo.com/icons/servicos-administrativos.png"
}'

Exemplo em Python:

import requests

url = "https://painel.meuatendimentovirtual.com.br/api/v1/grupos/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999",
    "Content-Type": "application/json"
}
data = {
    "group_name": "Serviços Administrativos",
    "type_group": "service",
    "icon": "https://exemplo.com/icons/servicos-administrativos.png"
}

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 os dados do grupo:

{
  "group_name": "Serviços Administrativos",
  "group_key": "19cdcce6-2400-4000-8770-ff2c3a024301",
  "type_group": "service",
  "icon": "https://exemplo.com/icons/servicos-administrativos.png",
  "subgroups": [],
  "services": []
}

O campo group_key identifica o grupo criado e pode ser usado em outros fluxos de configuração da plataforma.

IV – Erros comuns

• 400 Bad Request: verifique se group_name foi enviado e se type_group usa apenas service ou group.
• 401 Unauthorized: a chave de API está ausente ou incorreta no cabeçalho Authorization.

---

Depois de criar o grupo, você pode cadastrar os serviços que serão exibidos para o usuário. Veja o tutorial Como Criar um Serviço via API. Para configurar a exibição dos serviços pela interface, consulte Como Configurar Serviços/Filas.