El endpoint Send Message Skipping Aircall Inbox en la API pública de Aircall le permite enviar mensajes SMS o MMS desde sus números de Aircall. Esto resulta útil al integrar herramientas externas o aplicaciones personalizadas que necesitan enviar mensajes como si se hubieran originado en Aircall.

Antes de usar este endpoint, asegúrese de haber revisado el artículo Acerca de la API de Mensajería de Aircall, que explica las opciones de mensajería disponibles, los precios, las normativas y la Tasa límite.

Importante: El envío de mensajes a través de la API solo está disponible en el plan Professional de Aircall. Para actualizar su plan, póngase en contacto con nuestro equipo de Éxito del cliente.

Configurar un número de Aircall para la mensajería por API

Para habilitar la mensajería basada en API, debe configurar su número de Aircall mediante el endpoint messages/configuration. Esto prepara el número para enviar mensajes solo a través de la API (no a través de la aplicación de Aircall).

Pasos:

  1. Realice una solicitud POST al endpoint de API messages/configuration.
  2. Use el endpoint GET para confirmar la configuración si es necesario.
  3. Use el endpoint DELETE para eliminar la configuración si en algún momento necesita desactivar la mensajería por API.
Nota: La configuración es obligatoria antes de que pueda enviar mensajes SMS o MMS a través de la API.

Enviar mensajes usando la API

Una vez que su número esté configurado, puede enviar mensajes llamando al endpoint messages/send.

Pasos:

  1. Prepare el cuerpo de su solicitud de acuerdo con la documentación de la API.
  2. Realice una solicitud POST al endpoint messages/send.
  3. Revise el cuerpo de la respuesta para confirmar el estado del mensaje.
Importante: Los mensajes enviados a través de la API no se registran ni se muestran en ningún lugar de la plataforma Aircall.

Ejemplo de respuesta para un mensaje enviado

{
  "id": "abcdSMc6Dc8ea2bc71ab19102c3de4f60ba18aa",
  "status": "pending",
  "direct_link": "https://api.aircall.io/v1/numbers/1234567/messages/abcdSMc6Dc8ea2bc71ab19102c3de4f60ba18aa",
  "direction": "outbound",
  "created_at": 1722758201825,
  "sent_at": 1722758201825,
  "updated_at": 1722758201825,
  "raw_digits": "13023063029",
  "number": {
    "id": 84848484,
    "direct_link": "https://api.aircall.io/v1/numbers/1234567",
    "name": "US SMS line 1",
    "digits": "+1 626-800-9000",
    "country": "US",
    "time_zone": "America/Chicago",
    "open": true,
    "created_at": "2024-07-17T13:12:10Z"
  },
  "body": "body of the message"
}

Recibir mensajes entrantes en su URL de callback

Cuando configura su número para la mensajería por API, también especifica una URL de callback. Este endpoint recibirá cualquier mensaje entrante o respuesta a los mensajes que haya enviado.

Ejemplo de payload para un mensaje recibido

{
  "resource": "message",
  "event_name": "message.received",
  "timestamp": 1722604989549,
  "token": "91aa69db-c65e-42d9-85e7-g346b1h2204aa",
  "data": {
    "id": "abdcSM11da5992cb15eed9f21bcdb26d264bb40a",
    "status": "received",
    "direct_link": "https://api.aircall.io/v1/numbers/1234567/messages/abdcSM11da5992cb15eed9f21bcdb26d264bb40a",
    "direction": "inbound",
    "created_at": 1722604989549,
    "sent_at": 1722604989549,
    "updated_at": 1722604989549,
    "raw_digits": "18704575426",
    "number": {
      "id": 84848484,
      "direct_link": "https://api.aircall.io/v1/numbers/1234567",
      "name": "US SMS line 1",
      "digits": "+1 626-800-9000",
      "country": "US",
      "time_zone": "America/Chicago",
      "open": true,
      "created_at": "2024-07-17T13:12:10Z"
    },
    "body": "Body of the message received"
  }
}

Tutoriales y aprendizaje adicional

Hay disponible un tutorial técnico que explica una implementación completa de la API de SMS de Aircall. Revisar este ejemplo puede ayudarle a comprender cómo crear su integración de manera eficaz.

¿Necesita ayuda adicional?

Si no dispone de recursos de desarrollo, el equipo de Ingeniería de soluciones de Aircall y los Partners certificados pueden ayudarle con implementaciones personalizadas. Póngase en contacto con nuestro equipo de Éxito del cliente para explorar estas opciones.