Preskočiť na obsah

Autorizácia operátora a priame odkazy

Táto príručka vysvetľuje, ako získať platný autorizačný token pre operátorov v systéme prostredníctvom rozhrania API a ako používať priame odkazy na navigáciu na panel rozhovoru.

Základná adresa URL rozhrania API: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

Poznámka: Namiesto autorizácie na úrovni spoločnosti môžete použiť hlavičku „X-Authorization-Key“ s vaším tokenom (dostupný vo vašom profile na informačnom paneli).

1. Získajte token spoločnosti

Ak chcete získať token spoločnosti, odošlite požiadavku HTTP POST na adresu /api/company/get-token obsahujúcu prihlasovacie údaje spoločnosti.

Žiadosť - Spôsob: POST - URL: https://chatapi.smsbat.com/api/company/get-token – Hlavičky: „Typ obsahu: application/json“.

Telo: 

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

Odpoveď - Stavový kód: 200 (OK) - Text: Token reťazca ("your_token_string")

Poznámka: Uložte prijatý token pre ďalšie požiadavky.

2. Získať zoznam organizácií

Pošlite žiadosť GET na adresu /api/company/organization pomocou tokenu spoločnosti, aby ste uviedli svoje organizácie.

Žiadosť - Spôsob: GET - URL: https://chatapi.smsbat.com/api/company/organization - Hlavičky: - Oprávnenie: Nositeľ {token} - "Prijať: text/obyčajný".

Odpoveď - Stavový kód: 200 (OK) - Telo: 

[
  {
    "id": 6,
    "name": "string"
  }
]

3. Získajte operátorov podľa organizácie

Pošlite požiadavku GET na /api/operator pomocou parametra organizationId.

Žiadosť - Spôsob: GET - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Hlavičky: - Oprávnenie: Nositeľ {token} - "Prijať: text/obyčajný".

Odpoveď - Stavový kód: 200 (OK) - Telo: 

[
  {
    "id": 21,
    "name": "string",
    "status": 1,
    "organization": {
      "id": 24,
      "name": "test_costs"
    }
  }
]

4. Pridajte operátorov do systému

Použite token spoločnosti na prístup k tomuto koncovému bodu a synchronizáciu operátorov so systémom.

Žiadosť - Spôsob: POST - URL: https://chatapi.smsbat.com/api/operator/synchronize - Hlavičky: - Oprávnenie: Nositeľ {token} - Typ obsahu: application/json

Telo: 

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

Odpoveď - Stavový kód: 200 (OK) - Telo: 

[
  {
    "id": 21,
    "status": 0,
    "name": "string"
  }
]

Možné stavy operátora: - Aktívne: "0". – Neaktívne: „1“. - Vymazané: "2".

5. Získajte token operátora

Autorizujte pomocou firemného tokenu na získanie tokenu pre konkrétneho operátora.

Žiadosť - Spôsob: POST - URL: https://chatapi.smsbat.com/api/operator/get-token - Hlavičky: - Oprávnenie: Nositeľ {token} - Typ obsahu: application/json

Telo: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
Požaduje sa „expiresAt“ a určuje trvanie relácie operátora (max. „+24 hodín“).

Odpoveď - Stavový kód: 200 (OK) - Text: Token reťazca

6. Overte token operátora

Overte platnosť tokenu operátora.

Žiadosť - Spôsob: POST - URL: https://chatapi.smsbat.com/api/operator/validate-token - Hlavičky: - Oprávnenie: Nositeľ {token} - Typ obsahu: application/json

Text: "operator_token_string"

Platná odpoveď (200 OK): 

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

7. Priame prepojenie na panel chatu operátora

Externé systémy (CRM, ERP, interné webové stránky) môžu priamo otvoriť panel Chat pomocou priamych odkazov odovzdaním tokenu operátora JWT ako parametra. Ak je token neplatný alebo mu vypršala platnosť, používateľ bude presmerovaný do prihlasovacieho rozhrania.

Formát 1: Podľa ID rozhovoru

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

Formát 2: Podľa telefónneho čísla

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Telefónne číslo musí byť v medzinárodnom formáte E.164.

Formát 3: Podľa mena alfa a telefónu

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

Formát 4: Vyplňte podrobnosti o cieli

Presne špecifikujte, z ktorého zdroja sa majú zachytávať správy: 

https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>
Zdroje četu: - "0" - Viber - "1" - ViberBot - "2" - TelegramBot - "3" - Whatsapp - "4" - Widget - 5 - Rozetka - "6" - Facebook - "7" - Instagram