RCS

Die seven RCS-API bietet die Möglichkeit, die leistungsstarken Funktionen von RCS in Ihrer Anwendung zu integrieren und damit eine reichhaltige, interaktive Kommunikation mit Ihren Nutzern zu ermöglichen. In dieser Dokumentation werden die verschiedenen Endpunkte, Parameter und Funktionen der RCS-API detailliert beschrieben. Entdecken Sie die vielfältigen Möglichkeiten, die RCS bietet, um Messaging, Dateiaustausch, Standortfreigabe und vieles mehr zu verbessern.

Für den Versand von RCS Nachrichten ist eine Registrierung eines sogenannten Agenten bei jedem Netzbetreiber, zu dem Sie RCS Nachrichten senden möchten, zwingend erforderlich. Der Agent ist sozusagen der verifizierte Absender der RCS und in Ihrem CI gestaltet.

  1. 1

    Agenten registrieren

    Der Registrierungsprozess kann derzeit nur manuell ablaufen. Senden Sie auf unserer RCS Produktseite das Formular, um mit RCS starten zu können. Danach werden wir Sie umgehend kontaktieren, um einige Daten zwecks Einrichtung des Agenten abzufragen.

  2. 2

    RCS API integrieren

    Nachdem Ihr Agent eingerichtet wurde, können Sie direkt mit der Implementierung der API beginnen.

  3. 3

    RCS testen

    Überprüfen Sie Ihre Integration auf Herz und Nieren. Sie können zu diesem Zeitpunkt ausschließlich die für den Agenten hinterlegten Testnummern verwenden.

  4. 4

    Freigabe beantragen

    Sobald Sie RCS implementiert und ausreichend und erfolgreich getestet haben, können wir die Freigabe des Agenten bei den gewünschten Netzbetreibern beantragen. Dieser Prozess dauert meist ein paar Werktage und ist häufig mit Rückfragen verbunden.

  5. 5

    RCS senden 🚀

    Sie sind startklar und können ab sofort RCS Nachrichten versenden!


POST/api/rcs/messages

RCS senden

Dieser Endpunkt ermöglicht Ihnen den Versand von RCS Nachrichten an Nutzer. Vor dem Versand einer RCS sollten Sie idealerweise die Fähigkeiten der Rufnummer abfragen, um ein bestmögliches Nutzererlebnis zu gewährleisten.

Parameter

  • Name
    to
    Type
    string
    Description

    Die Empfängerrufnummer für Ihre RCS Nachricht. Dies kann auch ein Kontaktname oder eine Gruppenname sein.

  • Name
    text
    Type
    string
    Description

    Text der RCS Nachricht. Für den Versand einer einfachen RCS Nachricht (ohne Bilder, vorgeschlagene Antworten etc.) geben Sie hier nur den reinen Text der Nachricht an. Ansonsten verwenden Sie ein RCS Objekt.

  • Name
    from
    Type
    string
    Optional
    Optional
    Description

    Die eindeutige ID Ihres Agenten. Diese können Sie in den Einstellungen Ihres Accounts einsehen. Wenn nicht angegeben, wird der erste RCS fähige Absender verwendet.

  • Name
    delay
    Type
    timestamp
    Optional
    Optional
    Description

    Datum/Zeit für zeitversetzten Versand. Wahlweise Unix-Timestamp oder ein Zeitstempel im Format yyyy-mm-dd hh:ii.

  • Name
    ttl
    Type
    integer
    Optional
    Optional
    Description

    Gibt die Gültigkeitsdauer der RCS in Minuten an. Der Standard liegt bei 2880, also 48 Stunden.

  • Name
    label
    Type
    string
    Optional
    Optional
    Description

    Setzen Sie optional für jede SMS ein eigenes Label, um diese in Ihren Statistiken zuordnen zu können. Max. 100 Zeichen, erlaubte Zeichen: a-z, A-Z, 0-9, .-_@.

  • Name
    performance_tracking
    Type
    boolean
    Optional
    Optional
    Description

    Klick und Performance Tracking für im SMS Text gefundene URLs aktivieren. Damit wird gleichzeitig der URL Kürzer aktiviert.

  • Name
    foreign_id
    Type
    string
    Optional
    Optional
    Description

    Geben Sie Ihre eigene ID für diese Nachricht an. Sie erhalten die foreign_id wiederum zurück bei Callbacks für Statusberichte etc. Max. 64 Zeichen, erlaubte Zeichen: a-z, A-Z, 0-9, .-_@.

  • Name
    fallback
    Type
    enum
    Description

    Sollte eine RCS Versand nicht möglich sein, weil zum Beispiel das Empfängergerät RCS nicht unterstützt, kann die Nachricht automatisch über einen alternativen Kanal gesendet werden. Falls kein Fallback angegeben wird, ist dieser deaktiviert.

    sms - Sendet eine SMS mit dem Text der RCS Nachricht als Inhalt
    webview - Sendet eine SMS einem Link zu einer Webansicht der RCS Nachricht

POST
/api/rcs/messages
curl -X POST "https://gateway.seven.io/api/rcs/messages" \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
  -d "text=Hello World!" \
  -d "to=49176123456789"
{
"success": "100",
"total_price": null,
"balance": 3218.988,
"debug": "false",
"sms_type": "direct",
"messages": [
    {
      "id": "77233319353",
      "sender": "myfancyagent",
      "recipient": "49176123456789",
      "text": "Hello World!",
      "encoding": "gsm",
      "label": null,
      "parts": 0,
      "udh": null,
      "is_binary": false,
      "price": 0,
      "channel": "RCS",
      "success": true,
      "error": null,
      "error_text": null
    },
    {
      "id": "77233319354",
      // ...
    }
  ]
}

DELETE/api/rcs/messages/:id

RCS löschen

Sie können eine RCS Nachricht, die noch nicht zugestellt worden ist, widerrufen. Diese API gibt sofort eine erfolgreiche Antwort zurück, unabhängig davon, ob die Nachricht gelöscht wurde oder nicht. Ein Widerruf ist nur möglich, wenn das Endgerät die REVOCATION Fähigkeit besitzt.

Pfadparameter

  • Name
    Nachrichten-ID
    Type
    string
    Description

    Die ID der Nachricht, die gelöscht werden soll.

Anfrage

DELETE
/api/rcs/messages/123456
curl -X DELETE "https://gateway.seven.io/api/rcs/messages/123456" \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL" 

Antwort

{
  "success": true
}

POST/api/rcs/events

Ereignisse

Senden Sie ein Ereignis an eine Rufnummer, um Nutzern eine authentischere Konversationserfahrung zu bieten. Nach Empfang einer Nachricht sollten Sie in angemessener Zeit das Ereignis READ und danach entsprechend IS_TYPING senden.

Parameter

  • Name
    to
    Type
    string
    Union
    Description

    Die Rufnummer, an die Sie das Ereignis senden möchten.

  • Name
    msg_id
    Type
    string
    Union
    Description

    Die ID der erhaltenen RCS, zu der Sie das Ereignis senden möchten.

  • Name
    event
    Type
    enum
    Description

    Das Ereignis, welches gesendet werden soll. Kann einen der folgenden Werte haben:

    Ereignisse anzeigen

    IS_TYPING - Der Agent schreibt gerade
    READ - Die vom Nutzer gesendete Nachricht wurde gelesen

Anfrage

POST
/api/rcs/events
curl -X POST "https://gateway.seven.io/api/rcs/events" \
  -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
  -d "to=49176123456789" \
  -d "event=IS_TYPING" \
  -d "from=myfancyagent"

Antwort

{
  "success": true
}

Zuletzt aktualisiert: Vor 4 Monaten