API de WhatsApp y CRM
POST/devices

Crear número

Crea un nuevo número con un plan de suscripción mensual específico (io-professional, io-business o io-enterprise).

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

Crea un nuevo número con un plan de suscripción mensual específico (io-professional, io-business o io-enterprise).

Nota: los planes gateway-* están obsoletos y ya no están disponibles para nuevas suscripciones. Si intentas usar un plan gateway-*, se devolverá un error 403.

Después de crear el número, deberás autorizar la sesión escaneando el código QR.

La sesión de un número nuevo puede tardar hasta 2 minutos en estar disponible y en proporcionar una imagen QR para escanear.

Puedes obtener la imagen del código QR llamando al endpoint: [/numbers/{numberId}/scan](#operation/scanQR).

Quizá tengas que reintentar la solicitud HTTP varias veces hasta que la imagen QR esté disponible y devuelva un código de estado 200.

NOTA IMPORTANTE:

Al crear un nuevo número, se cobrará a la tarjeta de pago predeterminada el precio del plan para el interval de facturación seleccionado.

Si tu cuenta es elegible para una prueba gratuita, el nuevo número la recibe, salvo que ya tengas un número de prueba que nunca se conectó: en ese caso, el nuevo número se cobra de inmediato. Al conectar ese número se usa la prueba en él. Para darle la prueba a un nuevo número, primero elimina ese número. Normalmente esto funciona, pero no si se crearon tres números en los últimos 30 días sin conectar ninguno: entonces se cobrará el siguiente número.

interval puede ser month (predeterminado) o year. year cobra 12 meses por adelantado, a 10 veces el precio mensual (2 meses gratis). La facturación anual solo está disponible en cuentas y planes elegibles; las demás cuentas recibirán un error 403 si se solicita year.

Si no tienes una tarjeta de pago añadida o el pago falla, este endpoint devolverá un error y el número no se creará.

Si necesitas más ayuda para automatizar la creación de números, contacta con soporte.


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.

Cuerpo de la petición

CampoTipoObligatorioDescripción
aliasstringSíminLength: 2 · maxLength: 30
billingPlanstringSíPlan de suscripción del número. Planes recomendados: io-professional, io-business, io-enterprise. Obsoleto: los planes gateway-* ya no están disponibles para nuevas suscripciones. enum: ['business', 'enterprise', 'professional', 'gateway-business', 'gateway-enterprise', 'gateway-professional', 'io-professional', 'io-business', 'io-enterprise']
intervalstringNoIntervalo de facturación de la suscripción. year (anual, 2 meses gratis) solo está disponible en los planes Platform para clientes directos. enum: ['month', 'year'] · default: month
agentsarray<string>NoRestringido a los planes Platform: opcionalmente, define los IDs de agentes para proporcionar acceso compartido al chat del nuevo dispositivo. También puedes añadir o revocar agentes de chat después de crear el dispositivo.
connectorstringNoModo de conexión del número de WhatsApp: usa web para la conexión estándar con la aplicación móvil de WhatsApp, o cloud para la conexión con la API de WhatsApp Cloud. enum: ['web', 'cloud'] · default: web
paymentIntentstringNominLength: 20 · maxLength: 80 · pattern: ^pi_

Respuestas

CódigoDescripción
201Nuevo número creado
400Solicitud incorrecta por un payload no válido
401No autorizado
403Faltan los permisos necesarios
404Recurso no encontrado
409Método de pago no disponible
429Demasiadas solicitudes: inténtalo de nuevo más tarde
500Error inesperado
501No implementado
503Servicio temporalmente no disponible: 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

// Create new number
curl --request POST \
  --url https://api.getincloud.ai/v1/numbers \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"alias":"My Business Name","description":"This is an optional description to identify the number","billingPlan":"io-professional"}'
AnteriorCrear grupoSiguienteCrear respuesta rápida
¿Te sirvió esta página?