Skip to main content
POST
Obter perfil comercial

Autorizações

apikey
string
header
obrigatório

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Corpo

application/json
number
string
obrigatório

Número de telefone ou JID da conta comercial a inspecionar.

Exemplo:

"5511999999999"

Resposta

Sucesso — corpo de resposta nativo do provedor.

WhatsApp Business profile. When the number is a business account isBusiness=true and the business fields are populated; otherwise isBusiness=false with the on-WhatsApp check fields.

isBusiness
boolean
obrigatório

Whether the number is a WhatsApp Business account.

wid
string

WhatsApp business ID (JID).

jid
string

WhatsApp JID (present in the non-business branch, from the on-WhatsApp check).

exists
boolean

Whether the number exists on WhatsApp (present in the non-business branch).

name
string

Contact/pushname (present in the non-business branch).

message
string

Explanatory message when the number is not a business profile.

description
string

Business description / about text.

email
string

Business contact email.

websites
string[]

Business website URLs (raw Baileys field).

website
string[]

Business website URLs.

address
string

Business physical address.

about
string

Business about text.

vertical
string

Business category/vertical.

profilehandle
string

Business profile handle.