Escanear imagen QR

Obtiene la imagen QR que debes escanear para vincular la sesión del número de WhatsApp al sistema.

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

Obtiene la imagen QR que debes escanear para vincular la sesión del número de WhatsApp al sistema.

Por defecto, la imagen se devuelve en formato SVG (image/svg+xml) como texto plano. Usa encoding=json para obtener el contenido de la imagen SVG como JSON.

Puedes cambiar este comportamiento mediante el parámetro de consulta opcional encoding. Consulta más detalles a continuación.

Si la sesión ya está autenticada, la API devolverá un error a menos que especifiques el parámetro de consulta ?force=true, en cuyo caso se cerrará la sesión anterior y se creará una nueva.

También puedes obtener la imagen QR en Base64, en una cadena compatible con Base64 URI y en formato URI sin procesar, especificando el parámetro de consulta opcional ?encoding=base64|base64_uri|uri.

Importante: en las versiones recientes de Chrome, mostrar imágenes SVG grandes en Base64 dejó de funcionar; usa encoding=image o encoding=json en su lugar.

Por ejemplo, al especificar la codificación base64_uri o uri, puedes mostrar fácilmente la imagen QR al usuario en código HTML de esta forma:

<img src="data:image/svg+xml;base64,...image data in base64...">

O también usando CSS:

background-image: url("data:image/svg+xml;base64,...image data in base64...");

Nota: este endpoint puede devolver un error cuando la sesión del número se está inicializando y el código QR aún no está disponible. Debes reintentar la solicitud varias veces hasta obtener un estado de respuesta 200 válido.

¿Cómo mostrar el QR al usuario?

Si quieres mostrar el QR al usuario, por ejemplo en una aplicación web, debes solicitar un nuevo QR cada 2 segundos y mostrarlo rápidamente al usuario, dado que el QR cambia con frecuencia y escanear uno obsoleto mostrará un error de escaneo al usuario.

Recomendamos obtener el QR en formato SVG, ya que es más fácil de mostrar en código HTML sin procesar en cualquier aplicación web.

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

Respuestas

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

// Get QR code
curl --request GET \
  --url https://api.getincloud.ai/v1/devices/{deviceId}/scan \
  --header 'Token: <api token goes here>'