WhatsApp · Conexões — API Zyron Connect Suite

Módulo

WhatsApp · Conexões

Comece por aqui: descubra os números disponíveis e as capacidades reais de cada conexão antes de enviar.

GETListar conexões/connections GETConsultar conexão/connections/:id GETSaúde do número/connections/:id/health GETPerfil de negócio/connections/:id/profile PATCHAtualizar perfil/connections/:id/profile

GET/connectionsEscopo: readOficial + Básico

Lista conexões WhatsApp e capacidades.

Retorna connection_id para automações, sem expor tokens, QR ou credenciais do provider. phone_number vem no formato que o provedor devolveu; phone_number_digits é o mesmo número normalizado — e é ele que as rotas de envio aceitam no lugar do connection_id. capabilities é a fonte de verdade: a conexão Oficial (Meta) expõe todos os tipos e ações; a conexão do plano Básico expõe provider "freemium" com apenas text e send.

Parâmetros de caminho

Sem parâmetros adicionais.

Parâmetros de query

Sem parâmetros adicionais.

Campos do corpo

Este endpoint não recebe corpo JSON.

Exemplos prontos

curl -X GET "https://connect.zyronstack.com/api/v1/connections" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Respostas

200	Conexões retornadas.

Exemplo de resposta

{
  "data": [{
    "id": "<CONNECTION_ID>",
    "type": "official",
    "status": "connected",
    "phone_number": "+55 62 9249-8338",
    "phone_number_digits": "556292498338",
    "capabilities": {
      "provider": "meta_cloud_api",
      "message_types": ["text", "template", "image", "video", "audio", "document", "sticker", "location", "contacts", "interactive", "reaction"],
      "actions": ["send", "mark_read", "media_upload", "media_get", "media_download", "media_delete"]
    }
  }, {
    "id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
    "type": "freemium",
    "status": "connected",
    "phone_number": "5511988887777",
    "phone_number_digits": "5511988887777",
    "capabilities": {
      "provider": "freemium",
      "message_types": ["text"],
      "actions": ["send"]
    }
  }]
}

GET/connections/:idEscopo: readOficial + Básico

Consulta uma conexão.

Use para confirmar status e tipos de mensagem suportados antes da automação.

Parâmetros de caminho

Campo	Tipo	Descrição
`id`obrigatório	uuid	ID da conexão.

Parâmetros de query

Sem parâmetros adicionais.

Campos do corpo

Este endpoint não recebe corpo JSON.

Exemplos prontos

curl -X GET "https://connect.zyronstack.com/api/v1/connections/<CONNECTION_ID>" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Respostas

200	Conexão retornada.
404	Conexão não encontrada.

GET/connections/:id/healthEscopo: readOficial (Meta)Requer plano Oficial ou Agency

Saúde e limites do número Oficial.

Consulta a Meta em tempo real: qualidade (quality_rating), limite de conversas (messaging_limit_tier), throughput, status de verificação e health_status com o motivo quando o número não pode enviar.

Parâmetros de caminho

Campo	Tipo	Descrição
`id`obrigatório	uuid	ID da conexão Oficial.

Parâmetros de query

Sem parâmetros adicionais.

Campos do corpo

Este endpoint não recebe corpo JSON.

Exemplos prontos

curl -X GET "https://connect.zyronstack.com/api/v1/connections/<CONNECTION_ID>/health" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Respostas

200	Detalhe retornado direto da Meta.
403	upgrade_required: recurso do plano Oficial/Agency.
422	Conexão não é Oficial.

Exemplo de resposta

{
  "data": {
    "connection_id": "<CONNECTION_ID>",
    "display_phone_number": "+55 62 9249-8338",
    "verified_name": "Zyron Grid",
    "quality_rating": "GREEN",
    "platform_type": "CLOUD_API",
    "code_verification_status": "VERIFIED",
    "messaging_limit_tier": "TIER_1K",
    "throughput": { "level": "STANDARD" },
    "health_status": { "can_send_message": "AVAILABLE", "entities": [] }
  }
}

GET/connections/:id/profileEscopo: readOficial (Meta)Requer plano Oficial ou Agency

Perfil de negócio do número.

Retorna o perfil exibido no WhatsApp: about, endereço, descrição, e-mail, vertical, sites e foto.

Parâmetros de caminho

Campo	Tipo	Descrição
`id`obrigatório	uuid	ID da conexão Oficial.

Parâmetros de query

Sem parâmetros adicionais.

Campos do corpo

Este endpoint não recebe corpo JSON.

Exemplos prontos

curl -X GET "https://connect.zyronstack.com/api/v1/connections/<CONNECTION_ID>/profile" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Respostas

200	Perfil retornado.
422	Conexão não é Oficial.

Exemplo de resposta

{
  "data": {
    "connection_id": "<CONNECTION_ID>",
    "about": "Atendimento das 8h às 18h",
    "description": "Automação de WhatsApp para operações comerciais.",
    "email": "contato@zyronstack.com",
    "vertical": "PROF_SERVICES",
    "websites": ["https://connect.zyronstack.com"],
    "profile_picture_url": "https://..."
  }
}

PATCH/connections/:id/profileEscopo: writeOficial (Meta)Requer plano Oficial ou Agency

Atualiza o perfil de negócio.

Somente os campos enviados são alterados. about aceita até 139 caracteres; websites aceita até 2 URLs http(s); vertical usa o catálogo da Meta (RETAIL, PROF_SERVICES, HEALTH…).

Parâmetros de caminho

Campo	Tipo	Descrição
`id`obrigatório	uuid	ID da conexão Oficial.

Parâmetros de query

Sem parâmetros adicionais.

Campos do corpo

Campo	Tipo	Descrição
`about`opcional	string	Texto do perfil (1 a 139 caracteres).
`address`opcional	string	Endereço do negócio (até 256).
`description`opcional	string	Descrição (até 512).
`email`opcional	string	E-mail de contato.
`vertical`opcional	string	Segmento no catálogo da Meta.
`websites`opcional	string[]	Até 2 URLs http(s).

Exemplos prontos

curl -X PATCH "https://connect.zyronstack.com/api/v1/connections/<CONNECTION_ID>/profile" \
  -H "Authorization: Bearer SUA_CHAVE_API" \
  -H "content-type: application/json" \
  -d '{
  "about": "Atendimento das 8h às 18h",
  "websites": ["https://connect.zyronstack.com"]
}'

Respostas

200	Perfil atualizado; retorna o estado atual.
422	Campo inválido ou conexão não Oficial.