A resposta curta: a API lê os pedidos de suporte (tickets) da sua conta, abre novos, responde e fecha, e lê os artigos da Base de Conhecimento e os anúncios. Os pedidos ficam sempre em nome da sua conta. Lê com support:read e escreve com support:write.
Ler pedidos e departamentos
| Operação |
O que faz |
| GET /v1/tickets |
Os pedidos da conta, primeiro os que têm a resposta mais recente, em páginas. Filtro ?status=open. |
| GET /v1/tickets/{id} |
Um pedido, pelo número, com todas as mensagens, primeiro as mais antigas. Dos anexos, vem só o nome. |
| GET /v1/support/departments |
Os departamentos que podem receber pedidos. |
Abrir um pedido de suporte
curl https://api.mozout.com/v1/tickets -X POST \
-H "Authorization: Bearer $RLX_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 2c5e8f1a-4b7d-4e9a-b3c6-d8f0a1b2c3d4" \
-d '{"department_id": 1, "subject": "Ajuda com o plano", "message": "Preciso de ajuda com o meu plano."}'
| 1 |
Escolha o departamento com GET /v1/support/departments e use o department_id.
|
|
| 2 |
Ligue o pedido ao que interessa: a um serviço com service_id ou a um domínio com domain_id. A prioridade pode ser low, medium ou high.
|
|
| 3 |
Envie sempre Idempotency-Key: repetir com a mesma chave não abre outro pedido.
|
|
Pode abrir até 10 pedidos por hora, por conta. Um departamento que peça dados extra responde 422 com department_portal_only: abra esse pedido no My MozOut. Com uma chave Sandbox, nenhum pedido é criado e o id vem a null.
Responder e fechar
| Operação |
O que faz |
| POST /v1/tickets/{id}/replies |
Acrescenta a sua resposta. Responder a um pedido fechado volta a abri-lo, e reopened vem a true. Até 30 respostas por hora, por conta. Envie Idempotency-Key para não responder duas vezes. |
| POST /v1/tickets/{id}/close |
Fecha o pedido. Alguns só podem ser fechados pela nossa equipa: nesses, responde 409 closure_not_allowed. |
|
Abrir, responder e fechar pela API envia os mesmos e-mails que no My MozOut, incluindo o pedido de avaliação ao fechar. Num programa que corre sozinho, pense nisso antes de abrir pedidos em série. Os anexos ainda não se enviam pela API: junte-os no My MozOut.
|
Base de Conhecimento e anúncios
Só saem os artigos publicados, na língua do cabeçalho Accept-Language, quando houver tradução. Pesquisar tem um limite de 30 por minuto, por conta.
| Operação |
O que devolve |
| GET /v1/kb/categories |
As categorias. |
| GET /v1/kb/articles |
Os artigos. Use q para pesquisar e category para escolher uma categoria. |
| GET /v1/kb/articles/{id} |
Um artigo, com o texto em HTML. |
| GET /v1/announcements, /v1/announcements/{id} |
Os anúncios publicados, primeiro os mais recentes, e o texto de cada um. |
|
Uma ideia prática: o seu sistema de monitorização detecta que o site caiu e abre logo um pedido de suporte ligado ao serviço, com a hora e o que viu; antes, mostra à sua equipa os artigos da Base de Conhecimento que a pesquisa com q encontrar. Os prazos de resposta estão na Política de Suporte.
|
|
Quer ligar o seu sistema ao nosso suporte? Veja a página da API e teste com uma chave Sandbox, que não cria pedidos.
Ver a página da API
|
PRODUTO RECOMENDADO Alojamento de sites com cPanel Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 5,94 €/mês (plano de 3 anos, com cupão) Ver planos |
Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
