Enviar mensajes a traves del API

VideoTutorial

En esta sección, aprenderás a enviar mensajes de texto utilizando la aplicación Postman, interactuando con nuestra API. El proceso es simple y consta de varios pasos clave, como configurar la solicitud, autorizar el acceso con tu API key y definir el cuerpo del mensaje. Si lo deseas, también podrás agregar imágenes o archivos adjuntos al mensaje. A continuación, te detallamos los pasos a seguir para enviar tus mensajes correctamente

Para mas información accede a la documentacion del API https://crminbox.io/api-docs/

Manual Paso a Paso

1 En la aplicacion de Postman en el signo de mas para agregar una nueva peticion, seleccionamos de tipo POST, colocamos la URL de la siguiente manera: https://{tu_dominio}.crminbox.com/api/devices/{id_dispositivo}/messages

2 Vamos a la pestaña de Authorization, seleccionamos el tipo API Key, en key colocamos Authorization, en value colocamos Api-key espacio y despues el api key que se le genero a su empresa

3 En la pestaña de body seleccionamos form-data, agregamos en key y en value colocamos el numero al que se le enviara mensaje, luego colocamos en key message y en value colocamos el mensaje, Si deseamos agregar una imagen en el mensaje colocamos key file y lo colocamos de tipo file y en value subimos la imagen, la imagen es opcional.

4 Luegos le damos click en Send y en la seccion de abajo en Body tendremos el mensaje que nos devolvio el API

Mensaje con imagen

Mensaje con texto

Preguntas Frecuentes

¿Dónde obtengo mi API key para configurar la autorización?
El API key es generado exclusivamente para tu empresa, solo se genera 1 vez y se visualiza en el dashboard. Si no cuentas con esta información, contacta al personal de soporte.

¿Dónde encuentro el ID del dispositivo que necesito en la URL?
El ID del dispositivo lo puedes encontrar en Dispositivos -> Lista, Cada dispositivo vinculado tiene un identificador único que debes utilizar en la URL de la petición.

¿Es obligatorio enviar una imagen o archivo en cada mensaje?
No, el campo "file" es completamente opcional. Puedes enviar mensajes solo con texto utilizando únicamente los campos "number" y "message". Solo agrega el campo "file" cuando desees adjuntar una imagen o documento.

¿Qué formato debe tener el número de teléfono al que enviaré el mensaje?
El número debe incluir el código de país sin el signo "+" ni espacios. Por ejemplo, para México sería: 521234567890. Consulta la documentación completa del API en https://crminbox.io/api-docs/ para más detalles.

¿Cómo sé si mi mensaje se envió correctamente?
Después de dar clic en "Send", revisa la sección de respuesta en la parte inferior de Postman (Body). El API devolverá un mensaje de confirmación o un código de estado que indica si el envío fue exitoso o si hubo algún error.

Nov. 2, 2023, 9:50 p.m. - Visitas: 7418