Instâncias
Uma instância é um número de WhatsApp conectado ao LiteZap, com token próprio, configurações de envio e um processo worker dedicado. Criar, listar, apagar e rotacionar token exigem o token admin; as demais ações aceitam o token da própria instância.
As ações de ciclo de vida respondem logo depois de disparadas: acompanhe o estado com GET /v1/instances/{id} ou pelo evento instance.status. Os estados estão em Instâncias e estados.
Conceito: leia antes de integrar.
Operações
| Operação | Rota | Token |
|---|---|---|
| Listar instâncias | GET /v1/instances | token admin |
| Criar instância | POST /v1/instances | token admin |
| Consultar instância | GET /v1/instances/{id} | token da instância ou admin |
| Editar instância | PATCH /v1/instances/{id} | token da instância ou admin |
| Apagar instância | DELETE /v1/instances/{id} | token admin |
| Iniciar worker | POST /v1/instances/{id}/start | token da instância ou admin |
| Parar worker | POST /v1/instances/{id}/stop | token da instância ou admin |
| Reiniciar worker | POST /v1/instances/{id}/restart | token da instância ou admin |
| Desconectar número | POST /v1/instances/{id}/logout | token da instância ou admin |
| Rotacionar token da instância | POST /v1/instances/{id}/token/rotate | token admin |
Eventos relacionados
Gerado de openapi.yaml. Convenções gerais na visão geral e todos os códigos em Erros.