Obter perfil comercial no WhatsApp, por uma API

Retorna o perfil comercial que as pessoas veem em um número de telefone: about, address, description, email, websites, vertical e profile_picture_url.

Identificador
whatsapp_get_business_profile

A chamada

POST https://connect.reportei.com/api/tools/whatsapp_get_business_profile/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "phone_number_id": "<phone_number_id>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
phone_number_idstringSimId of the business phone number, from List phone numbers.
fieldsstringNãoComma-separated fields. The default is all of them.

Conexões possíveis

O seu cliente conecta a conta do WhatsApp uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/whatsapp_get_business_profile. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do WhatsApp

Ver as 10 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.