Ver perfil comercial
GET /business-profiles/{chat_id}
Lê o perfil comercial (WhatsApp Business) de um número, ou o da inbox com me. Conta pessoal volta 404.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Parâmetros
[
{
"name": "chat_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "O número (ou id) do perfil; `me` para o da inbox."
}
]
Respostas
{
"200": {
"description": "O perfil.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessProfile"
},
"example": {
"id": "5511888888888@s.whatsapp.net",
"description": "Roupas e acessórios.",
"address": "Rua das Flores, 100 - São Paulo",
"email": "contato@loja.com",
"websites": [
"https://loja.com"
],
"categories": [
{
"id": "1752",
"name": "Loja de roupas"
}
]
}
}
}
},
"401": {
"description": "Token inválido ou ausente.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"403": {
"$ref": "#/components/responses/NotAdminWhatsApp"
},
"404": {
"description": "Não é conta comercial.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "not_found",
"message": "O número não tem perfil comercial."
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
},
"501": {
"$ref": "#/components/responses/CloudUnsupported"
},
"503": {
"description": "`disconnected`: a inbox está desconectada do WhatsApp. `unavailable`: o WhatsApp não respondeu agora (conexão caindo ou sem resposta); tente de novo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unavailable",
"message": "O WhatsApp não respondeu agora; tente de novo."
}
}
}
}
}
Estado: Disponível
Compatibilidade de canais
| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim | |
| WhatsApp (API oficial) | Não | Na API oficial, perfil e catálogo ficam no Gerenciador do WhatsApp da Meta. |
| Não | ||
| Messenger | Não | |
| Telegram | Não |
Eventos que esta rota gera
Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.
Antes e depois (uazapi → Orkesio)
Na uazapi: POST /business/get/profile.
jidno caminho (antes no corpo; vazio era a inbox, agorame); sem o enveloperesponse;categories[].localized_display_name→name;tagsaiu (interno).
#/components/schemas/BusinessProfile
{
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"description": "Perfil comercial (WhatsApp Business).",
"properties": {
"id": {
"type": "string",
"description": "O número dono do perfil."
},
"description": {
"type": "string",
"description": "Descrição do negócio."
},
"address": {
"type": "string",
"description": "Endereço do negócio."
},
"email": {
"type": "string",
"description": "E-mail de contato do negócio."
},
"websites": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sites do negócio."
},
"categories": {
"type": "array",
"description": "Categorias do negócio.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Id da categoria (o mesmo de `GET /business-categories`)."
},
"name": {
"type": "string",
"description": "Nome no idioma da conta."
}
}
}
},
"business_hours": {
"type": "object",
"additionalProperties": false,
"description": "O horário de atendimento, quando o perfil tem.",
"properties": {
"timezone": {
"type": "string",
"description": "Fuso do horário (ex.: `America/Sao_Paulo`)."
},
"days": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"day",
"mode"
],
"properties": {
"day": {
"type": "string",
"description": "Dia da semana em inglês, abreviado (`mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `sun`)."
},
"mode": {
"type": "string",
"description": "`specific_hours` (das `open_time` às `close_time`), `open_24h` ou `appointment_only`; outro valor do WhatsApp vem como chegou."
},
"open_time": {
"type": "string",
"description": "Abre às (HH:MM), com `specific_hours`."
},
"close_time": {
"type": "string",
"description": "Fecha às (HH:MM), com `specific_hours`."
}
}
},
"description": "Um item por dia configurado."
}
},
"required": [
"days"
]
},
"options": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Opções do perfil, como o WhatsApp manda (ex.: `cart_enabled`)."
}
}
}
#/components/schemas/OrkesioError
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
},
"message": {
"type": "string",
"description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
},
"field": {
"type": "string",
"description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
}
},
"required": [
"error",
"message"
],
"additionalProperties": true,
"description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}
#/components/responses/NotAdminWhatsApp
{
"description": "`not_admin`: o WhatsApp recusou por falta de permissão (em geral, só o dono ou um administrador pode; na leitura, o catálogo ou o canal não está aberto para esta conta).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "not_admin",
"message": "O WhatsApp recusou por falta de permissão (em geral, só o dono ou um administrador pode)."
}
}
}
}
#/components/responses/RateLimited
{
"description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
"headers": {
"Retry-After": {
"description": "Segundos até poder chamar de novo.",
"schema": {
"type": "integer",
"minimum": 1
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "rate_limited",
"message": "Muitas requisições."
}
}
}
}
#/components/responses/InternalError
{
"description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "internal_error",
"message": "Falha inesperada."
}
}
}
}
#/components/responses/CloudUnsupported
{
"description": "`unsupported_for_channel`: o canal da inbox não atende esta rota (rota só do WhatsApp Web numa inbox oficial, ou rota da API oficial numa inbox do WhatsApp Web). O canal está em `Inbox.channel`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unsupported_for_channel",
"message": "Esta rota não está disponível no canal da inbox."
}
}
}
}
Guias relacionados
Visão geral · O que funciona em cada canal · O que muda da uazapi