API de WhatsApp y CRM
POST/devices/{deviceId}/catalog

Consultar catálogo

Consulta la información del catálogo de WhatsApp Business de cualquier número de WhatsApp Business.

API de WhatsApp y CRM
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
POST https://api.getincloud.ai/v1/devices/{deviceId}/catalog

Consulta la información del catálogo de WhatsApp Business de cualquier número de WhatsApp Business.

Si el número no existe o el catálogo no está disponible, se devolverá un error.

Las consultas del catálogo de negocio tienen una cuota limitada según el plan, de la siguiente manera:

  • Plan Professional = 2000 consultas por mes
  • Plan Business = 5000 consultas por mes
  • Plan Enterprise = 10000 consultas por mes

Importante: este endpoint de la API no está disponible en las suscripciones del plan Gateway.


Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y juega con el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluyendo JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Cuerpo de la petición

CampoTipoObligatorioDescripción
phonestringSíNúmero de teléfono de WhatsApp Business minLength: 6 · maxLength: 16
sizeintegerNoProductos del catálogo que se van a recuperar. El máximo de elementos permitido por WhatsApp es 500 minimum: 1 · maximum: 500 · default: 100

Respuestas

CódigoDescripción
200Catálogo de WhatsApp Business
400Datos de consulta o del cuerpo de la solicitud no válidos
401Acceso no autorizado debido a un token de API no válido
403Token de API ausente o no autorizado
404Dispositivo o catálogo no encontrado
409El dispositivo no está activo o el plan no es compatible
429Se superó la cuota permitida de consultas de catálogo para el período de facturación actual
500Error inesperado
501No implementado
503La sesión del número de WhatsApp no está en línea o no está disponible
// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Query WhatsApp Business catalog
curl --request POST \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/catalog \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"phone":"+123456789"}'
AnteriorConceder acceso a un usuarioSiguienteCrear canal
¿Te sirvió esta página?