Obtener números

Lista los números de WhatsApp, opcionalmente filtrados por parámetros de búsqueda.

API de WhatsApp y CRM

Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.

GET https://api.getincloud.ai/v1/devices

Lista los números de WhatsApp, opcionalmente filtrados por parámetros de búsqueda.

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 prueba la API en el probador en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos 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.

Parámetros

Campo	Dónde	Tipo	Obligatorio	Descripción
`ids`	query	array	No	Busca números por ID. Para varios IDs, usa valores separados por comas. Ej: 11b37a069cba0c15d6c81000,21b37a069cba0c15d6c81111 `maxLength: 50`
`connector`	query	array	No	Busca números por tipo de conector. Ej: `web`, `cloud`. Se permiten varios valores separados por comas.
`status`	query	string	No	Busca números por estado. Ej: operative, pending, disabled, removed `enum: ['any', 'invalid', 'banned', 'removed', 'disabled', 'unpaid', 'preload', 'pending', 'authorized', 'verified', 'operative']` · `default: any`
`sessionStatus`	query	string	No	Busca números por estado de sesión. Ej: authorize, online, timeout, offline, error `enum: ['any', 'online', 'offline', 'timeout', 'timeout_sync', 'conflict', 'blocked', 'error', 'authorize', 'authorizing', 'new', 'loading', 'offline_panel', 'offline_modal']`
`search`	query	string	No	Busca números por número de teléfono, alias o ID. Para búsquedas con varios valores, usa valores separados por comas. Ej: +1234567890,61b37a069cba0c15d6c81000 `maxLength: 100`
`page`	query	number	No	`minimum: 0` · `maximum: 50` · `default: 0` · `format: integer`
`size`	query	number	No	`minimum: 1` · `maximum: 100` · `default: 20` · `format: integer`

Respuestas

Código	Descripción
`200`	Mensajes
`400`	Datos de consulta o de cuerpo de la solicitud no válidos
`401`	No autorizado: token de API no válido o ausente
`403`	Faltan los permisos requeridos
`404`	Recurso no encontrado
`409`	Conflicto
`429`	Demasiadas solicitudes: inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio no disponible temporalmente: inténtalo de nuevo más tarde

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// List numbers
curl --request GET \
  --url 'https://api.getincloud.ai/v1/numbers?size=10&page=0' \
  --header 'Token: <api token goes here>'


// Get operative numbers
curl --request GET \
  --url 'https://api.getincloud.ai/v1/numbers?status=operative' \
  --header 'Token: <api token goes here>'


// Get pending numbers
curl --request GET \
  --url 'https://api.getincloud.ai/v1/numbers?status=pending' \
  --header 'Token: <api token goes here>'

AnteriorObtener número por ID SiguienteObtener perfil

¿Te sirvió esta página?