Obter detalhes da instância

GET

api

instances

{id}

curl --request GET \
  --url https://api.wappfy.io/api/instances/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "user_id": "<string>",
  "name": "<string>",
  "is_active": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "phone_number": "<string>",
  "display_name": "<string>",
  "session_name": "<string>",
  "phone_number_id": "<string>",
  "waba_id": "<string>",
  "access_token": "<string>",
  "webhook_url": "<string>",
  "profile_picture_url": "<string>"
}

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

string<uuid>

obrigatório

ID da instância

Resposta

Detalhes da instância

string

obrigatório

user_id

string

obrigatório

name

string

obrigatório

instance_type

enum<string>

obrigatório

Opções disponíveis:

waha,

cloud_api

status

enum<string>

obrigatório

Opções disponíveis:

created,

starting,

scan_qr,

connected,

disconnected,

failed

is_active

boolean

obrigatório

created_at

string

obrigatório

updated_at

string

obrigatório

phone_number

string

display_name

string

Nome de exibição do WhatsApp (pushName)

session_name

string

phone_number_id

string

waba_id

string

access_token

string

webhook_url

string

profile_picture_url

string

Excluir instânciaExclui permanentemente uma instância. Para instâncias WAHA, a sessão também é removida do servidor WAHA.

Obter detalhes da instância

curl --request GET \
  --url https://api.wappfy.io/api/instances/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "user_id": "<string>",
  "name": "<string>",
  "is_active": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "phone_number": "<string>",
  "display_name": "<string>",
  "session_name": "<string>",
  "phone_number_id": "<string>",
  "waba_id": "<string>",
  "access_token": "<string>",
  "webhook_url": "<string>",
  "profile_picture_url": "<string>"
}