Pular para o conteúdo principal
POST
/
api
/
v1
/
instances
curl --request POST \
  --url https://6827d740d717.ngrok-free.app/api/v1/instances \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Minha Instância WhatsApp",
  "phone": "+5511999999999",
  "age": "MORE_30",
  "provider": "whatsapp-web",
  "configs": {
    "minDelay": 3000,
    "maxDelay": 7000,
    "minJitter": 1000,
    "maxJitter": 3000,
    "dailyLimit": 50,
    "monthlyLimit": 1000,
    "workingHours": {
      "start": "08:00",
      "end": "18:00"
    },
    "workingDays": [
      1,
      2,
      3,
      4,
      5
    ],
    "timeout": 30000,
    "maxRetries": 3
  }
}
'
{
  "id": "inst_1234567890abcdef",
  "name": "Minha Instância WhatsApp",
  "phone": "+5511999999999",
  "age": "MORE_30",
  "status": "ACTIVE",
  "provider": "whatsapp-web",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "configs": {
    "minDelay": 3000,
    "maxDelay": 7000,
    "minJitter": 1000,
    "maxJitter": 3000,
    "dailyLimit": 50,
    "monthlyLimit": 1000,
    "workingHours": {
      "start": "08:00",
      "end": "18:00"
    },
    "workingDays": [
      1,
      2,
      3,
      4,
      5
    ],
    "timeout": 30000,
    "maxRetries": 3
  },
  "connectInstanceAt": "2024-01-15T10:30:00Z",
  "proxies": [
    {
      "id": "proxy_1234567890abcdef",
      "provider": "webshare",
      "type": "http",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ]
}

Autorizações

​
Authorization
string
header
obrigatório

API Key de autenticação - usar ApiKey {sua-api-key}

Corpo

application/json

Dados para criar a instância

​
name
string
obrigatório

Nome da instância

Exemplo:

"Minha Instância WhatsApp"

​
phone
string
obrigatório

Número de telefone da instância

Exemplo:

"+5511999999999"

​
age
enum<string>
obrigatório

Idade da instância

Opções disponíveis:
MORE_30,
LESS_30,
LESS_7
Exemplo:

"MORE_30"

​
provider
string

Provedor da instância

Exemplo:

"whatsapp-web"

​
configs
object

Configurações da instância

Exemplo:
{
  "minDelay": 3000,
  "maxDelay": 7000,
  "minJitter": 1000,
  "maxJitter": 3000,
  "dailyLimit": 50,
  "monthlyLimit": 1000,
  "workingHours": { "start": "08:00", "end": "18:00" },
  "workingDays": [1, 2, 3, 4, 5],
  "timeout": 30000,
  "maxRetries": 3
}

Resposta

Instância criada com sucesso

​
id
string
obrigatório

ID único da instância

Exemplo:

"inst_1234567890abcdef"

​
name
string
obrigatório

Nome da instância

Exemplo:

"Minha Instância WhatsApp"

​
phone
string
obrigatório

Número de telefone

Exemplo:

"+5511999999999"

​
age
string
obrigatório

Idade da instância

Exemplo:

"MORE_30"

​
status
string
obrigatório

Status da instância

Exemplo:

"ACTIVE"

​
provider
string
obrigatório

Provedor da instância

Exemplo:

"whatsapp-web"

​
createdAt
string<date-time>
obrigatório

Data de criação

Exemplo:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>
obrigatório

Data de atualização

Exemplo:

"2024-01-15T10:30:00Z"

​
configs
object

Configurações da instância

Exemplo:
{
  "minDelay": 3000,
  "maxDelay": 7000,
  "minJitter": 1000,
  "maxJitter": 3000,
  "dailyLimit": 50,
  "monthlyLimit": 1000,
  "workingHours": { "start": "08:00", "end": "18:00" },
  "workingDays": [1, 2, 3, 4, 5],
  "timeout": 30000,
  "maxRetries": 3
}
​
connectInstanceAt
string<date-time>

Data de conexão da instância

Exemplo:

"2024-01-15T10:30:00Z"

​
proxies
object[]

Lista de proxies associados