Help Center Betreiberberechtigung und Deep Links

Betreiberberechtigung und Deep Links

In dieser Anleitung wird erläutert, wie Sie über die API ein gültiges Autorisierungstoken für Bediener im System erhalten und wie Sie Deep-Links verwenden, um zum Chat-Panel zu navigieren.

API-Basis-URL: „https://chatapi.smsbat.com/“. Swagger: „https://chatapi.smsbat.com/index.html“.

Hinweis: Sie können den Header „X-Authorization-Key“ mit Ihrem Token (verfügbar in Ihrem Profil im Dashboard) anstelle der „Bearer“-Autorisierung für Anfragen auf Unternehmensebene verwenden.

1. Besorgen Sie sich ein Firmen-Token

Um das Unternehmenstoken zu erhalten, senden Sie eine HTTP-POST-Anfrage an „/api/company/get-token“, die die Anmeldeinformationen des Unternehmens enthält.

Anfrage

  • Methode: POST
  • URL: https://chatapi.smsbat.com/api/company/get-token
  • Header: Content-Type: application/json

Text:

{
  "login": "string",
  "password": "string"
}

Antwort

  • Statuscode: 200 (OK)
  • Body: String-Token („your_token_string“`)

Hinweis: Speichern Sie das empfangene Token für spätere Anfragen.

2. Organisationsliste abrufen

Senden Sie eine GET-Anfrage an „/api/company/organization“ und verwenden Sie dabei das Unternehmenstoken, um Ihre Organisationen aufzulisten.

Anfrage

  • Methode: GET
  • URL: https://chatapi.smsbat.com/api/company/organization
  • Überschriften:
    • „Autorisierung: Inhaber {Token}“.
    • „Akzeptieren: Text/Plain“.

Antwort

  • Statuscode: 200 (OK)
  • Text:
[
  {
    "id": 6,
    "name": "string"
  }
]

3. Operatoren nach Organisation abrufen

Senden Sie eine GET-Anfrage an „/api/operator“ mit dem Parameter „organizationId“.

Anfrage

  • Methode: GET
  • URL: https://chatapi.smsbat.com/api/operator?organizationId={id}
  • Überschriften:
    • „Autorisierung: Inhaber {Token}“.
    • „Akzeptieren: Text/Plain“.

Antwort

  • Statuscode: 200 (OK)
  • Text:
[
  {
    "id": 21,
    "name": "string",
    "status": 1,
    "organization": {
      "id": 24,
      "name": "test_costs"
    }
  }
]

4. Operatoren zum System hinzufügen

Verwenden Sie das Unternehmenstoken, um auf diesen Endpunkt zuzugreifen und Bediener mit dem System zu synchronisieren.

Anfrage

  • Methode: POST
  • URL: https://chatapi.smsbat.com/api/operator/synchronize
  • Überschriften:
    • „Autorisierung: Inhaber {Token}“.
    • „Inhaltstyp: application/json“.

Text:

[
  {
    "organizationId": 24,
    "name": "string"
  }
]

Antwort

  • Statuscode: 200 (OK)
  • Text:
[
  {
    "id": 21,
    "status": 0,
    "name": "string"
  }
]

Mögliche Betreiberstatus:

  • Aktiv: „0“.
  • Inaktiv: „1“.
  • Gelöscht: „2“.

5. Besorgen Sie sich das Operator-Token

Autorisieren Sie mit dem Firmen-Token, einen Token für einen bestimmten Betreiber zu erhalten.

Anfrage

  • Methode: POST
  • URL: https://chatapi.smsbat.com/api/operator/get-token
  • Überschriften:
    • „Autorisierung: Inhaber {Token}“.
    • „Inhaltstyp: application/json“.

Text:

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}

expiresAt ist erforderlich und bestimmt die Sitzungsdauer des Operators (maximal „+24 Stunden“).

Antwort

  • Statuscode: 200 (OK)
  • Body: String-Token

6. Operator-Token validieren

Überprüfen Sie die Gültigkeit des Tokens eines Betreibers.

Anfrage

  • Methode: POST
  • URL: https://chatapi.smsbat.com/api/operator/validate-token
  • Überschriften:
    • „Autorisierung: Inhaber {Token}“.
    • „Inhaltstyp: application/json“.

Body: "operator_token_string"

Gültige Antwort (200 OK):

{
  "isValid": true,
  "operatorId": 0,
  "clientId": 0,
  "expiresAt": "2024-12-28T14:04:15.861Z",
  "error": null
}

7. Deep Linking zum Operator-Chat-Panel

Externe Systeme (CRM, ERP, interne Websites) können das Chat-Panel direkt öffnen und dabei die Deep-Links nutzen, indem sie das JWT-Operator-Token als Parameter übergeben. Wenn das Token ungültig oder abgelaufen ist, wird der Benutzer zur Anmeldeschnittstelle weitergeleitet.

Format 1: Nach Chat-ID

https://chat.smsbat.com/?chat_raw_id=<chat_id>&token=<jwt_token>

Format 2: Nach Telefonnummer

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>

Die Telefonnummer muss im internationalen Format E.164 vorliegen.

Format 3: Nach Alpha-Name und Telefon

https://chat.smsbat.com/?from=<bm_id>&phone=<phone_number>&token=<jwt_token>

Format 4: Vollständige Zieldetails

Geben Sie genau an, von welcher Quelle Nachrichten abgefangen werden sollen:

https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>

Chat-Quellen:

  • 0 - Viber
  • „1“ – ViberBot
  • „2“ – TelegramBot
  • „3“ – WhatsApp
  • „4“ – Widget
  • 5 - Rozetka
  • „6“ – Facebook
  • „7“ – Instagram