Avtorizacija operaterja in globinske povezave
Ta priročnik pojasnjuje, kako pridobiti veljaven avtorizacijski žeton za operaterje v sistemu prek API-ja in kako uporabiti globoke povezave za navigacijo do plošče za klepet.
Osnovni URL API-ja: https://chatapi.smsbat.com/
Bahanje: https://chatapi.smsbat.com/index.html
Opomba: Z žetonom lahko uporabite glavo
X-Authorization-Key(na voljo v vašem profilu na nadzorni plošči) namesto pooblastilaBearerza zahteve na ravni podjetja.
1. Pridobite žeton podjetja
Če želite pridobiti žeton podjetja, pošljite zahtevo HTTP POST na /api/company/get-token, ki vsebuje poverilnice za prijavo podjetja.
Zahteva
- Metoda: POST
- URL:
https://chatapi.smsbat.com/api/company/get-token - Glave:
Content-Type: application/json
Telo:
{
"login": "string",
"password": "string"
}
Odziv
- Statusna koda: 200 (OK)
- Telo: Žeton niza (
"your_token_string")
Opomba: Shranite prejeti žeton za naslednje zahteve.
2. Pridobite seznam organizacij
Pošljite zahtevo GET na /api/company/organization z uporabo žetona podjetja, da navedete svoje organizacije.
Zahteva
- Metoda: GET
- URL:
https://chatapi.smsbat.com/api/company/organization - Glave:
Avtorizacija: Nosilec {token}Sprejmi: besedilo/navadno
Odziv
- Statusna koda: 200 (OK)
- Telo:
[
{
"id": 6,
"name": "string"
}
]
3. Pridobite operaterje po organizaciji
Pošljite zahtevo GET na /api/operator z uporabo parametra organizationId.
Zahteva
- Metoda: GET
- URL:
https://chatapi.smsbat.com/api/operator?organizationId={id} - Glave:
Avtorizacija: Nosilec {token}Sprejmi: besedilo/navadno
Odziv
- Statusna koda: 200 (OK)
- Telo:
[
{
"id": 21,
"name": "string",
"status": 1,
"organization": {
"id": 24,
"name": "test_costs"
}
}
]
4. Sistemu dodajte operaterje
Za dostop do te končne točke in sinhronizacijo operaterjev s sistemom uporabite žeton podjetja.
Zahteva
- Metoda: POST
- URL:
https://chatapi.smsbat.com/api/operator/synchronize - Glave:
Avtorizacija: Nosilec {token}Vrsta vsebine: aplikacija/json
Telo:
[
{
"organizationId": 24,
"name": "string"
}
]
Odziv
- Statusna koda: 200 (OK)
- Telo:
[
{
"id": 21,
"status": 0,
"name": "string"
}
]
Možni statusi operaterja:
- Aktivno:
0 - Neaktivno:
1 - Izbrisano:
2
5. Pridobite žeton operaterja
Pooblastite z žetonom podjetja za pridobitev žetona za določenega operaterja.
Zahteva
- Metoda: POST
- URL:
https://chatapi.smsbat.com/api/operator/get-token - Glave:
Avtorizacija: Nosilec {token}Vrsta vsebine: aplikacija/json
Telo:
{
"id": 0,
"expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt je zahtevan in določa trajanje seje operaterja (največ +24 ur).
Odziv
- Statusna koda: 200 (OK)
- Telo: Žeton niza
6. Preverjanje žetona operaterja
Preverite veljavnost operaterjevega žetona.
Zahteva
- Metoda: POST
- URL:
https://chatapi.smsbat.com/api/operator/validate-token - Glave:
Avtorizacija: Nosilec {token}Vrsta vsebine: aplikacija/json
Telo: "operator_token_string"
Veljaven odgovor (200 OK):
{
"isValid": true,
"operatorId": 0,
"clientId": 0,
"expiresAt": "2024-12-28T14:04:15.861Z",
"error": null
}
7. Globinsko povezovanje s ploščo za klepet operaterja
Zunanji sistemi (CRM, ERP, interna spletna mesta) lahko neposredno odprejo ploščo za klepet z uporabo globokih povezav s posredovanjem žetona operaterja JWT kot parametra. Če je žeton neveljaven ali je potekel, bo uporabnik preusmerjen na vmesnik za prijavo.
Oblika 1: Po ID-ju klepeta
https://chat.smsbat.com/?chat_raw_id=<chat_id>&token=<jwt_token>
Oblika 2: po telefonski številki
https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Telefonska številka mora biti v mednarodnem formatu E.164.
Format 3: po alfa imenu in telefonu
https://chat.smsbat.com/?from=<bm_id>&phone=<phone_number>&token=<jwt_token>
Oblika 4: popolne podrobnosti cilja
Natančno določite, iz katerega vira želite prestreči sporočila:
https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>
Viri klepeta:
0- Viber1- ViberBot2- TelegramBot3- Whatsapp4- Pripomoček5- Rozetka6- Facebook7- Instagram