WhatsApp · Conexões — API Zyron Connect Suite

Módulo

WhatsApp · Conexiones

Empieza aquí: descubre los números y capacidades reales antes de enviar.

GET/connections/connections GET/connections/:id/connections/:id GET/connections/:id/health/connections/:id/health GET/connections/:id/profile/connections/:id/profile PATCH/connections/:id/profile/connections/:id/profile

GET/connectionsAlcance: readOficial + Básico

Lista conexiones y capacidades.

Devuelve connection_id sin exponer tokens o credenciales. capabilities es la fuente de verdad: Oficial (Meta) expone todos los tipos; la conexión del plan Básico expone provider "freemium" con solo text y send.

Parámetros de ruta

Sin parámetros adicionales.

Parámetros de query

Sin parámetros adicionales.

Campos del cuerpo

Este endpoint no recibe cuerpo JSON.

Ejemplos listos

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

Respuestas

200	Conexiones devueltas.

Ejemplo de respuesta

{
  "data": [{
    "id": "<CONNECTION_ID>",
    "type": "official",
    "status": "connected",
    "phone_number": "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",
    "capabilities": {
      "provider": "freemium",
      "message_types": ["text"],
      "actions": ["send"]
    }
  }]
}

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

Consulta una conexión.

Úsalo para confirmar estado y tipos soportados.

Parámetros de ruta

Campo	Tipo	Descripción
`id`obligatorio	uuid	ID de conexión.

Parámetros de query

Sin parámetros adicionales.

Campos del cuerpo

Este endpoint no recibe cuerpo JSON.

Ejemplos listos

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

Respuestas

200	Conexión devuelta.
404	Conexión no encontrada.

GET/connections/:id/healthAlcance: readOficial (Meta)Requiere plan Oficial o Agency

Salud y límites del número Oficial.

Consulta Meta en tiempo real: calidad, límite de conversaciones, throughput, verificación y health_status con el motivo cuando el número no puede enviar.

Parámetros de ruta

Campo	Tipo	Descripción
`id`obligatorio	uuid	ID de la conexión Oficial.

Parámetros de query

Sin parámetros adicionales.

Campos del cuerpo

Este endpoint no recibe cuerpo JSON.

Ejemplos listos

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

Respuestas

200	Detalle devuelto directo de Meta.
403	upgrade_required: plan Oficial/Agency.
422	La conexión no es Oficial.

Ejemplo de respuesta

{
  "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/profileAlcance: readOficial (Meta)Requiere plan Oficial o Agency

Perfil de negocio del número.

Devuelve el perfil mostrado en WhatsApp: about, dirección, descripción, e-mail, vertical, sitios y foto.

Parámetros de ruta

Campo	Tipo	Descripción
`id`obligatorio	uuid	ID de la conexión Oficial.

Parámetros de query

Sin parámetros adicionales.

Campos del cuerpo

Este endpoint no recibe cuerpo JSON.

Ejemplos listos

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

Respuestas

200	Perfil devuelto.
422	La conexión no es Oficial.

Ejemplo de respuesta

{
  "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/profileAlcance: writeOficial (Meta)Requiere plan Oficial o Agency

Actualiza el perfil de negocio.

Solo se alteran los campos enviados. about acepta hasta 139 caracteres; websites hasta 2 URLs; vertical usa el catálogo de Meta.

Parámetros de ruta

Campo	Tipo	Descripción
`id`obligatorio	uuid	ID de la conexión Oficial.

Parámetros de query

Sin parámetros adicionales.

Campos del cuerpo

Campo	Tipo	Descripción
`about`opcional	string	Texto del perfil (1 a 139).
`address`opcional	string	Dirección (hasta 256).
`description`opcional	string	Descripción (hasta 512).
`email`opcional	string	E-mail de contacto.
`vertical`opcional	string	Segmento del catálogo de Meta.
`websites`opcional	string[]	Hasta 2 URLs http(s).

Ejemplos listos

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"]
}'

Respuestas

200	Perfil actualizado; devuelve el estado actual.
422	Campo inválido o conexión no Oficial.