Přeskočit obsah

Autorizace operátora a přímé odkazy

Tato příručka vysvětluje, jak získat platný autorizační token pro operátory v systému prostřednictvím rozhraní API a jak používat přímé odkazy k navigaci na panel chatu.

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

Poznámka: Pro požadavky na úrovni společnosti můžete použít záhlaví X-Authorization-Key se svým tokenem (dostupným ve vašem profilu na řídicím panelu) místo autorizace Bearer.

1. Získejte firemní token

Chcete-li získat token společnosti, odešlete požadavek HTTP POST na adresu /api/company/get-token obsahující přihlašovací údaje společnosti.

Žádost - Metoda: POST - URL: https://chatapi.smsbat.com/api/company/get-token - Headers: Content-Type: application/json

Tělo: 

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

Odpověď - Stavový kód: 200 (OK) - Text: Token řetězce ("řetězec_vašeho_tokenu")

Poznámka: Uložte přijatý token pro další požadavky.

2. Vyhledejte seznam organizací

Odešlete žádost GET do /api/company/organization pomocí tokenu společnosti, abyste uvedli své organizace.

Žádost - Metoda: GET - URL: https://chatapi.smsbat.com/api/company/organization - Záhlaví: - Oprávnění: Nositel {token} - Přijmout: text/prostý

Odpověď - Stavový kód: 200 (OK) - Tělo: 

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

3. Vyhledejte operátory podle organizace

Odešlete požadavek GET do /api/operator pomocí parametru organizationId.

Žádost - Metoda: GET - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Záhlaví: - Oprávnění: Nositel {token} - Přijmout: text/prostý

Odpověď - Stavový kód: 200 (OK) - Tělo: 

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

4. Přidejte operátory do systému

Použijte firemní token pro přístup k tomuto koncovému bodu a synchronizaci operátorů se systémem.

Žádost - Metoda: POST - URL: https://chatapi.smsbat.com/api/operator/synchronize - Záhlaví: - Oprávnění: Nositel {token} - Typ obsahu: aplikace/json

Tělo: 

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

Odpověď - Stavový kód: 200 (OK) - Tělo: 

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

Možné stavy operátora: - Aktivní: "0". - Neaktivní: "1". - Smazáno: "2".

5. Získejte token operátora

Autorizujte pomocí firemního tokenu k získání tokenu pro konkrétního operátora.

Žádost - Metoda: POST - URL: https://chatapi.smsbat.com/api/operator/get-token - Záhlaví: - Oprávnění: Nositel {token} - Typ obsahu: aplikace/json

Tělo: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt je povinný a určuje dobu trvání relace operátora (max +24 hodin).

Odpověď - Stavový kód: 200 (OK) - Text: Řetězec

6. Ověřte token operátora

Ověřte platnost tokenu operátora.

Žádost - Metoda: POST - URL: https://chatapi.smsbat.com/api/operator/validate-token - Záhlaví: - Oprávnění: Nositel {token} - Typ obsahu: aplikace/json

Text: "řetězec_tokenu operátora"

Platná odpověď (200 OK): 

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

7. Hluboké propojení s panelem chatu operátora

Externí systémy (CRM, ERP, interní webové stránky) mohou přímo otevřít panel Chat s využitím přímých odkazů předáním tokenu operátora JWT jako parametru. Pokud je token neplatný nebo vypršela jeho platnost, bude uživatel přesměrován do přihlašovacího rozhraní.

Formát 1: Podle ID chatu

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

Formát 2: Podle telefonního čísla

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Telefonní číslo musí být v mezinárodním formátu E.164.

Formát 3: Podle jména alfa a telefonu

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

Formát 4: Vyplňte podrobnosti o cíli

Přesně určete, ze kterého zdroje se mají zprávy zachytit: 

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