Instâncias
Mensagens
Para Grupos
Listando Instâncias
curl --request GET \
--url https://api.zapsterapi.com/v1/wa/instances \
--header 'Authorization: Bearer <token>'{
"total": 123,
"instances": [
{
"created_at": "2024-10-03T21:56:22.620Z",
"id": "xy9rexnkwobmgg3tehgvs",
"metadata": {
"customer_id": "123456",
"customer_name": "Joãozinho"
},
"name": "MyNewInstance2",
"owner": {
"display_name": null,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"qrcode": null,
"settings": {
"call_rejection": "all",
"delay_per_word": true,
"delete_chat_after_sent": true,
"message_delay": {
"enabled": true,
"max": 10,
"min": 1
},
"presence_behavior": "only_composing",
"read_confirmation": "never"
},
"status": "disconnected",
"webhooks": [
{
"enabled": true,
"events": [
"message.received"
],
"id": "2nenz69l0xbf0m3uu9tfo",
"name": "Webhook Name",
"test_mode": false,
"test_url": null,
"url": "https://webhook.mydomain.com"
}
],
"lookup_key": "ins_8j7wlxmpjlixx9mux5"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filtrar por identificador de pesquisa
Para registros páginados, define qual página quer buscar.
Limita o número de registros por página.
Filtrar por status
disconnected, connected, offline Response
Quantidade total de registros na conta do usuário
Lista de instâncias encontradas
Estrutura de uma instância registrada na API.
Data e hora de criação da instância no formato ISO 8601.
"2024-10-03T21:56:22.620Z"
Identificador único da instância.
"xy9rexnkwobmgg3tehgvs"
Metadados adicionais armazenados como chave e valor.
{
"customer_id": "123456",
"customer_name": "Joãozinho"
}
Nome da instância.
"MyNewInstance2"
Objeto opcional de configurações da sua instância.
Define o comportarmento de rejeição de ligações.
all- Irá rejeitar todas ligaçõesnone- Não irá rejeitar ligações.
all, none Define se o delay antes de enviar a mensagem deve ser baseado na quantidade de palavras.
ℹ️ Limitado a no máximo 10 segundos de espera.
⚠️ Esta função não está funcionando adequadamente, estamos trabalhando para regulariza-la.
Define se o chat/conversa deve ser limpo depois do envio da mensagem. Isso garante que o dispositivo fique acumulando mensagens a ponto de muitas vezes travar o dispositivo que foi conectado.
Define a configuração de delay antes do envio da mensagem, se configurado delay_per_word é ignorado. O tempo é gerado randomicamente entre os limites configurado (min e max).
Máximo de tempo em segundos que deve ser esperado antes do envio da mensagem.
Mínimo de tempo em segundos que deve ser esperado antes do envio da mensagem.
Define o comportamento da presença (Online, Digitando..., Gravando...) da sua instância.
only_composing- Aprecerá "Online" apenas durante o envio da mensagem. (recomendado)always- Aparecerá sempre onlinenever- Nunca aparecerá "Online" exceto quando necessário durante os envios (por boas práticas)
only_composing, always, never Define o comportamento de "confirmação de leitura".
never- Nunca irá confirmar a leituraalways- Sempre irá confirmar.
never, always Status atual da instância
connected, disconnected, offline "disconnected"
Lista de webhooks configurados para esta instância.
Configuração de um webhook associado à instância.
Indica se o webhook está ativado.
true
Lista de eventos que acionam este webhook.
group.created, group.participants_added, group.participants_demoted, group.participants_promoted, group.participants_removed, group.updated, instance.connected, instance.disconnected, instance.forbidden, instance.mentioned, instance.qrcode, message.deleted, message.delivered, message.pinned, message.reaction, message.read, message.received, message.sent, message.unpinned, poll.created, poll.deleted, poll.updated ["message.received"]
Identificador único do webhook.
"2nenz69l0xbf0m3uu9tfo"
Nome do webhook configurado.
"Webhook Name"
Indica se o webhook está em modo de teste.
false
URL do webhook para onde os eventos serão enviados.
"https://webhook.mydomain.com"
URL de teste do webhook, se disponível.
null
QR Code da instância, caso disponível.
null
Identificador de pesquisa criado anteriormente.
"ins_8j7wlxmpjlixx9mux5"
curl --request GET \
--url https://api.zapsterapi.com/v1/wa/instances \
--header 'Authorization: Bearer <token>'{
"total": 123,
"instances": [
{
"created_at": "2024-10-03T21:56:22.620Z",
"id": "xy9rexnkwobmgg3tehgvs",
"metadata": {
"customer_id": "123456",
"customer_name": "Joãozinho"
},
"name": "MyNewInstance2",
"owner": {
"display_name": null,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"qrcode": null,
"settings": {
"call_rejection": "all",
"delay_per_word": true,
"delete_chat_after_sent": true,
"message_delay": {
"enabled": true,
"max": 10,
"min": 1
},
"presence_behavior": "only_composing",
"read_confirmation": "never"
},
"status": "disconnected",
"webhooks": [
{
"enabled": true,
"events": [
"message.received"
],
"id": "2nenz69l0xbf0m3uu9tfo",
"name": "Webhook Name",
"test_mode": false,
"test_url": null,
"url": "https://webhook.mydomain.com"
}
],
"lookup_key": "ins_8j7wlxmpjlixx9mux5"
}
]
}