Criando Instância

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

Um apelido opcional para sua instância, usado apenas para sua organização.

Maximum string length: 64

Example:

"Bot SDR"

lookup_key

string

Um identificador único opcional de pesquisa que permite associar sua instância a uma estrutura de dados específica. A Zapster API não utiliza esse dado internamente; ele serve exclusivamente para facilitar consultas na API, permitindo localizar registros mais rapidamente por meio deste parâmetro de pesquisa.

Maximum string length: 36

Example:

"ins_8j7wlxmpjlixx9mux5"

metadata

object

Um conjunto de informações adicionais armazenadas como chave e valor. Cada chave é um texto e o valor pode ser um número ou um texto. Esse campo é opcional e pode ser usado para guardar detalhes personalizados.

Para números de telefone, use o formato E.164 (ex: +5587989075555). O sistema validará e formatará automaticamente o número, removendo espaços e hífens.

Show child attributes

metadata.{key}

Example:

{
  "customer_id": "123456",
  "customer_name": "Joãozinho",
  "phone_number": "+5587989075555"
}

settings

object

Objeto opcional de configurações da sua instância.

Show child attributes

settings.call_rejection

enum<string>

Define o comportarmento de rejeição de ligações.

all - Irá rejeitar todas ligações
none - Não irá rejeitar ligações.
video_only - Irá rejeitar apenas ligações de vídeo.
audio_only - Irá rejeitar apenas ligações de audio.

Available options:

all,

none,

video_only,

audio_only

settings.delay_per_word

boolean

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.

settings.delete_chat_after_sent

boolean

⚠️ 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.

settings.message_delay

object

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

Show child attributes

settings.message_delay.enabled

boolean

default:true

settings.message_delay.max

integer

default:10

Máximo de tempo em segundos que deve ser esperado antes do envio da mensagem.

settings.message_delay.min

integer

default:1

Mínimo de tempo em segundos que deve ser esperado antes do envio da mensagem.

settings.presence_behavior

enum<string>

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 online
never - Nunca aparecerá "Online" exceto quando necessário durante os envios (por boas práticas)

Available options:

only_composing,

always,

never

settings.read_confirmation

enum<string>

Define o comportamento de "confirmação de leitura".

never - Nunca irá confirmar a leitura
always - Sempre irá confirmar.

Available options:

never,

always

webhooks

object

Lista de webhooks serão criados assim que a instância finalizar sua criação. Atente-se para a quantidade de webhooks nesta lista, a mesma é baseada no seu plano contratado.

Show child attributes

webhooks.events

enum<string>[]

required

Lista de eventos será enviados para o webhook.

Available options:

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

webhooks.url

string<uri>

required

URL para onde deverá ser enviada as notificações de webhook.

Response

200 - application/json

Success

Estrutura de uma instância registrada na API.

created_at

string<date-time>

required

Data e hora de criação da instância no formato ISO 8601.

Example:

"2024-10-03T21:56:22.620Z"

string

required

Identificador único da instância.

Example:

"xy9rexnkwobmgg3tehgvs"

metadata

object

required

Metadados adicionais armazenados como chave e valor.

Show child attributes

metadata.{key}

Example:

{
  "customer_id": "123456",
  "customer_name": "Joãozinho",
  "phone_number": "+5587989075555"
}

name

string

required

Nome da instância.

Example:

"MyNewInstance2"

owner

object

required

Informações sobre o proprietário da instância.

Show child attributes

owner.id

string<uuid>

required

Identificador único do proprietário.

owner.display_name

string | null

Nome de exibição do proprietário. Pode ser nulo.

Example:

null

settings

object

required

Objeto opcional de configurações da sua instância.

Show child attributes

settings.call_rejection

enum<string>

Define o comportarmento de rejeição de ligações.

all - Irá rejeitar todas ligações
none - Não irá rejeitar ligações.
video_only - Irá rejeitar apenas ligações de vídeo.
audio_only - Irá rejeitar apenas ligações de audio.

Available options:

all,

none,

video_only,

audio_only

settings.delay_per_word

boolean

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.

settings.delete_chat_after_sent

boolean

⚠️ 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.

settings.message_delay

object

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

Show child attributes

settings.message_delay.enabled

boolean

default:true

settings.message_delay.max

integer

default:10

Máximo de tempo em segundos que deve ser esperado antes do envio da mensagem.

settings.message_delay.min

integer

default:1

Mínimo de tempo em segundos que deve ser esperado antes do envio da mensagem.

settings.presence_behavior

enum<string>

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 online
never - Nunca aparecerá "Online" exceto quando necessário durante os envios (por boas práticas)

Available options:

only_composing,

always,

never

settings.read_confirmation

enum<string>

Define o comportamento de "confirmação de leitura".

never - Nunca irá confirmar a leitura
always - Sempre irá confirmar.

Available options:

never,

always

status

enum<string>

required

Status atual da instância

Available options:

connected,

disconnected,

offline

Example:

"disconnected"

webhooks

object[]

required

Lista de webhooks configurados para esta instância.

Show child attributes

webhooks.enabled

boolean

required

Indica se o webhook está ativado.

Example:

true

webhooks.events

enum<string>[]

required

Lista de eventos que acionam este webhook.

Available options:

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

Example:

["message.received"]

webhooks.id

string

required

Identificador único do webhook.

Example:

"2nenz69l0xbf0m3uu9tfo"

webhooks.name

string

required

Nome do webhook configurado.

Example:

"Webhook Name"

webhooks.test_mode

boolean

required

Indica se o webhook está em modo de teste.

Example:

false

webhooks.url

string<uri>

required

URL do webhook para onde os eventos serão enviados.

Example:

"https://webhook.mydomain.com"

webhooks.test_url

string | null

URL de teste do webhook, se disponível.

Example:

null

qrcode

string | null

QR Code da instância, caso disponível.

Example:

null

lookup_key

string

Identificador de pesquisa criado anteriormente.

Example:

"ins_8j7wlxmpjlixx9mux5"

Instâncias

Webhooks

Mensagens

Para Grupos

Utilidades

Authorizations

Body

Response