Skip to main content
POST
Criar instância
Cria uma nova instância da EZ API e retorna os identificadores necessários para as próximas chamadas.

Authorizations

Client-Token
string
header
required

Body

application/json
name
string

Nome de exibição da instância.

Example:

"Minha Instância"

deliveryCallbackUrl
string<uri>

Webhook chamado no evento de entrega.

Example:

"https://example.com/webhooks/delivery"

receivedCallbackUrl
string<uri>

Webhook chamado no evento de recebimento.

Example:

"https://example.com/webhooks/received"

disconnectedCallbackUrl
string<uri>

Webhook chamado no evento de desconexão.

Example:

"https://example.com/webhooks/disconnected"

connectedCallbackUrl
string<uri>

Webhook chamado no evento de conexão.

Example:

"https://example.com/webhooks/connected"

messageStatusCallbackUrl
string<uri>

Webhook chamado quando o status da mensagem muda.

Example:

"https://example.com/webhooks/status"

antiBanEnabled
boolean

Ativa ou desativa o AntiBan já na criação.

Example:

false

Response

Resposta de sucesso.

instanceId
string
required
Example:

"abc1234567890"

instanceToken
string
required
Example:

"tok_a1b2c3d4e5f6..."

status
string
required
Example:

"pending"