Pāriet uz saturu

Operatora autorizācija un dziļās saites

Šajā rokasgrāmatā ir paskaidrots, kā iegūt derīgu autorizācijas pilnvaru sistēmas operatoriem, izmantojot API, un kā izmantot dziļās saites, lai pārietu uz tērzēšanas paneli.

API bāzes URL: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

Piezīme. Uzņēmuma līmeņa pieprasījumiem varat izmantot galveni X-Authorization-Key ar savu pilnvaru (pieejama jūsu profilā informācijas panelī), nevis pilnvarojuma nesējs.

1. Iegūstiet uzņēmuma marķieri

Lai iegūtu uzņēmuma pilnvaru, nosūtiet HTTP POST pieprasījumu uz `/api/company/get-token', kurā ir iekļauti uzņēmuma pieteikšanās akreditācijas dati.

Pieprasījums - Metode: POSTĪT - URL: https://chatapi.smsbat.com/api/company/get-token - Galvenes: Satura veids: lietojumprogramma/json

Korpuss: 

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

Atbilde - Statusa kods: 200 (OK) - Body: Virknes marķieris ("jūsu_token_string")

Piezīme. Saglabājiet saņemto pilnvaru turpmākiem pieprasījumiem.

2. Izgūt organizāciju sarakstu

Nosūtiet GET pieprasījumu uz `/api/company/organization', izmantojot uzņēmuma pilnvaru, lai uzskaitītu savas organizācijas.

Pieprasījums - Metode: IEGŪT - URL: https://chatapi.smsbat.com/api/company/organization - Galvenes: - Atļauja: nesējs {token} - "Pieņemt: teksts/vienkāršs".

Atbilde - Statusa kods: 200 (OK) -Korpuss: 

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

3. Izgūstiet operatorus pēc organizācijas

Nosūtiet GET pieprasījumu uz “/api/operator”, izmantojot parametru “organizationId”.

Pieprasījums - Metode: IEGŪT - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Galvenes: - Atļauja: nesējs {token} - "Pieņemt: teksts/vienkāršs".

Atbilde - Statusa kods: 200 (OK) -Korpuss: 

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

4. Pievienojiet sistēmai operatorus

Izmantojiet uzņēmuma pilnvaru, lai piekļūtu šim galapunktam un sinhronizētu operatorus ar sistēmu.

Pieprasījums - Metode: POSTĪT - URL: https://chatapi.smsbat.com/api/operator/synchronize - Galvenes: - Atļauja: nesējs {token} - Satura veids: lietojumprogramma/json

Korpuss: 

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

Atbilde - Statusa kods: 200 (OK) -Korpuss: 

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

Iespējamie operatora statusi: - Aktīvs: "0". - Neaktīvs: "1". - Svītrots: "2".

5. Iegūstiet Operator Token

Autorizējieties ar uzņēmuma pilnvaru, lai iegūtu pilnvaru konkrētam operatoram.

Pieprasījums - Metode: POSTĪT - URL: https://chatapi.smsbat.com/api/operator/get-token - Galvenes: - Atļauja: nesējs {token} - Satura veids: lietojumprogramma/json

Korpuss: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt ir nepieciešams, un tas nosaka operatora sesijas ilgumu (maks. +24 stundas).

Atbilde - Statusa kods: 200 (OK) - Body: Virknes marķieris

6. Apstipriniet operatora pilnvaru

Pārbaudiet operatora pilnvaras derīgumu.

Pieprasījums - Metode: POSTĪT - URL: https://chatapi.smsbat.com/api/operator/validate-token - Galvenes: - Atļauja: nesējs {token} - Satura veids: lietojumprogramma/json

Body: "operatora_token_string"

Derīga atbilde (200 OK): 

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

7. Dziļā saite uz operatora tērzēšanas paneli

Ārējās sistēmas (CRM, ERP, iekšējās vietnes) var tieši atvērt tērzēšanas paneli, izmantojot dziļās saites, kā parametru nododot JWT operatora pilnvaru. Ja marķieris ir nederīgs vai beidzies derīguma termiņš, lietotājs tiks novirzīts uz pieteikšanās saskarni.

1. formāts: pēc tērzēšanas ID

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

2. formāts: pēc tālruņa numura

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Tālruņa numuram ir jābūt E.164 starptautiskajā formātā.

3. formāts: pēc alfabēta vārda un tālruņa numura

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

4. formāts: aizpildiet mērķa informāciju

Precīzi norādiet, no kura avota pārtvert ziņojumus: 

https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>
Tērzēšanas avoti: - 0 - Viber - 1 - ViberBot - 2 - TelegramBot - 3 - Whatsapp - 4 - Logrīks - 5 - Rozetka - 6 - Facebook - 7 - Instagram