Der Endpunkt Send Message unter Umgehung des Aircall-Posteingangs in der Aircall Public API ermöglicht es Ihnen, SMS- oder MMS-Nachrichten von Ihren Aircall-Rufnummern zu senden. Dies ist nützlich, wenn Sie externe Tools oder benutzerdefinierte Anwendungen integrieren, die Nachrichten senden müssen, als würden sie von Aircall stammen.

Bevor Sie diesen Endpunkt verwenden, stellen Sie sicher, dass Sie den Artikel „About Aircall Messaging API“ gelesen haben. Darin werden die verfügbaren Messaging-Optionen, Preise, Vorschriften und Anfragenbegrenzung erklärt.

Achtung: Das Senden von Nachrichten über die API ist nur im Aircall Professional-Tarif verfügbar. Für ein Upgrade wenden Sie sich an unser Kundenerfolg-Team.

Eine Aircall-Rufnummer für API-Messaging einrichten

Zum Aktivieren von API-basiertem Messaging müssen Sie Ihre Aircall-Rufnummer mit dem Endpunkt messages/configuration konfigurieren. Dadurch wird die Rufnummer so vorbereitet, dass Nachrichten nur über die API gesendet werden können (nicht über die Aircall-App).

Schritte:

  1. Senden Sie eine POST-Anfrage an den API-Endpunkt messages/configuration.
  2. Verwenden Sie bei Bedarf den Endpunkt GET, um die Konfiguration zu bestätigen.
  3. Verwenden Sie den Endpunkt DELETE, um die Konfiguration zu entfernen, falls Sie API-Messaging jemals deaktivieren müssen.
Hinweis: Configuration ist erforderlich, bevor Sie SMS- oder MMS-Nachrichten über die API senden können.

Nachrichten über die API senden

Sobald Ihre Rufnummer konfiguriert ist, können Sie Nachrichten senden, indem Sie den Endpunkt messages/send aufrufen.

Schritte:

  1. Bereiten Sie Ihren Request-Body gemäß der API-Dokumentation vor.
  2. Senden Sie eine POST-Anfrage an den Endpunkt messages/send.
  3. Prüfen Sie den Response-Body, um den Nachrichtenstatus zu bestätigen.
Achtung: Über die API gesendete Nachrichten werden nirgends in der Aircall-Plattform erfasst oder angezeigt.

Beispielantwort für eine gesendete Nachricht

{
  "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"
}

Eingehende Nachrichten an Ihrer Callback-URL empfangen

Wenn Sie Ihre Rufnummer für API-Messaging konfigurieren, geben Sie auch eine Callback-URL an. Dieser Endpunkt empfängt alle eingehenden Nachrichten oder Antworten auf Nachrichten, die Sie gesendet haben.

Beispiel-Payload für eine empfangene Nachricht

{
  "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"
  }
}

Tutorials und weiterführendes Lernen

Ein technisches Tutorial ist verfügbar, das eine vollständige Implementierung der Aircall SMS API Schritt für Schritt erklärt. Die Durchsicht dieses Beispiels kann Ihnen helfen zu verstehen, wie Sie Ihre Integration effektiv aufbauen.

Benötigen Sie zusätzliche Unterstützung?

Wenn Sie keine Entwicklungsressourcen zur Verfügung haben, können das Team für Lösungsentwicklung von Aircall und zertifizierte Partner bei benutzerdefinierten Implementierungen helfen. Wenden Sie sich an unser Kundenerfolg-Team, um diese Optionen zu prüfen.