Skip to main content

Endpoint

GET /v1/whatsapp-instances
Escopo necessário: read:whatsapp_instances Use para obter IDs de instâncias para usar em whatsapp_instance_id ao enviar mensagens.

Exemplo de requisição

curl "https://api.socialsell.ai/v1/whatsapp-instances" \
  -H "Authorization: Bearer sk_live_..."

Exemplo de resposta

{
  "data": [
    {
      "id": "664h3i4j5k6l7m8n9o0p1q2r",
      "name": "WhatsApp Principal",
      "phone": "+5511333344445",
      "status": "connected",
      "avatar_url": null,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-06-10T12:00:00.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "has_more": false
  }
}

Objeto instância

CampoTipoDescrição
idstringID da instância — use em whatsapp_instance_id
namestring|nullNome da instância
phonestring|nullNúmero de telefone
statusstringconnected ou disconnected
avatar_urlstring|nullURL do avatar do número
created_atstringTimestamp de criação
updated_atstringTimestamp de atualização