Actualizar número

Actualiza la información y la configuración de un número de WhatsApp por ID ---- Prueba este endpoint en el probador de API en vivo ¿Necesitas ayuda?

API de WhatsApp y CRM

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

PATCH https://api.getincloud.ai/v1/devices/{deviceId}

Actualiza la información y la configuración de un número de WhatsApp por ID

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, 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

Campo	Tipo	Obligatorio	Descripción
`enable`	boolean	No
`alias`	string	No	`minLength: 2` · `maxLength: 30`
`description`	string	No	`maxLength: 80`
`plan`	string	No	Opcionalmente, mejora o reduce el plan de facturación. Ten en cuenta que al mejorar el plan pueden aplicarse cargos. Las suscripciones de prueba no pueden cambiar de plan y devolverán un error; solo las suscripciones de pago pueden hacerlo. `enum: ['business', 'enterprise', 'professional', 'gateway-business', 'gateway-enterprise', 'gateway-professional', 'io-professional', 'io-business', 'io-enterprise']`
`settings`	object	No
`settings.rebootPolicy`	string	No	Define la política de reinicio de la sesión del dispositivo. Está deshabilitada por defecto. Puedes habilitarla para forzar un reinicio de la sesión de tu dispositivo cada cierto periodo de tiempo, desde 1 hora hasta 24 horas. Esto puede evitar que la sesión de tu dispositivo tenga problemas de rendimiento o de memoria, especialmente en dispositivos de Platform, donde las sesiones permanecen activas durante horas o incluso días. El reinicio provocará hasta 2 minutos de inactividad y retraso en el procesamiento de mensajes, pero no se perderá ningún mensaje durante el proceso. `enum: ['disabled', '10m', '15m', '20m', '25m', '30m', '45m', '1h', '2h', '3h', '4h', '5h', '6h', '8h', '10h', '12h', '18h']`
`settings.retentionPolicy`	string	No	Define la política de retención de datos utilizada para los datos del dispositivo actual, incluidos mensajes, chats, contactos y archivos. Esto no afecta a los datos de tu dispositivo físico. `enum: ['plan_defaults', 'never', '5m', '15m', '30m', '1h', '12h', '24h', '2d', '3d', '4d', '5d', '6d', '7d', '10d']`
`settings.deliverySpeed`	number	No	Velocidad máxima permitida de entrega de mensajes por minuto en el dispositivo actual. Usa "0" para el límite predeterminado del plan. Se aplica una velocidad máxima de entrega diferente según el plan de suscripción. Consulta las características del plan para más detalles. `enum: [150, 140, 120, 100, 90, 80, 70, 60, 50, 40, 30, 20, 15, 12, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0.9, 0.8, 0.7, 0.6, 0.5, 0.4, 0.3, 0.2, 0.1, 0]` · `format: float`
`settings.assignChatOnReply`	boolean	No	Asigna un chat al agente que lo responde cuando el chat no tiene asignado. Habilitado por defecto. Esta no es la política de asignación automática: se ejecuta en cada respuesta enviada desde la Consola Web, independientemente de esa política, por lo que desactivar la asignación automática no la detiene.
`settings.operativeHours`	object	No	Horario operativo opcional del dispositivo por día de la semana. Durante las horas no operativas, el dispositivo se pondrá en modo de suspensión y permanecerá sin conexión, lo que significa que no se procesarán ni entregarán mensajes salientes ni entrantes fuera del horario operativo, a menos que el usuario reactive explícitamente el dispositivo despertándolo desde la consola web o con el endpoint de activación de la API.
`webhooks`	array<string>	No	Opcionalmente, restringe las notificaciones de eventos de webhook del dispositivo a los IDs de endpoints de webhook indicados. Si no se define, se usarán en su lugar todos los endpoints de webhook a nivel de cuenta.

Respuestas

Código	Descripción
`202`	Número actualizado
`400`	Datos de consulta o cuerpo de la solicitud no válidos
`401`	Acceso no autorizado debido a un token de API no válido o vencido
`403`	Falta el token de API requerido
`404`	Número no encontrado
`409`	Conflicto
`429`	Demasiadas solicitudes. Inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio 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

// Update number
curl --request PATCH \
  --url https://api.getincloud.ai/v1/devices/{deviceId} \
  --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"}'

AnteriorActualizar la asignación automática de chats SiguienteActualizar perfil

¿Te sirvió esta página?