ოპერატორის ავტორიზაცია და ღრმა ბმულები

ეს სახელმძღვანელო განმარტავს, თუ როგორ უნდა მიიღოთ მოქმედი ავტორიზაციის ჟეტონი სისტემაში ოპერატორებისთვის API-ს მეშვეობით და როგორ გამოიყენოთ ღრმა ბმულები ჩატის პანელზე ნავიგაციისთვის.

API ბაზის URL: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

შენიშვნა: თქვენ შეგიძლიათ გამოიყენოთ X-Authorization-Key სათაური თქვენი ჟეტონით (ხელმისაწვდომია თქვენს პროფილში საინფორმაციო დაფაზე) კომპანიის დონის მოთხოვნებისთვის Bearer ავტორიზაციის ნაცვლად.

1. მიიღეთ კომპანიის ტოკენი

კომპანიის ტოკენის მისაღებად, გაგზავნეთ HTTP POST მოთხოვნა /api/company/get-token, რომელიც შეიცავს კომპანიის შესვლის სერთიფიკატებს.

** მოთხოვნა ** - მეთოდი: POST - URL: https://chatapi.smsbat.com/api/company/get-token - Headers: შინაარსის ტიპი: აპლიკაცია/json

** სხეული: **

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

პასუხი - სტატუსის კოდი: 200 (OK) - Body: სიმებიანი ნიშანი ("თქვენი_ტოკენის_სტრიქონი")

შენიშვნა: შეინახეთ მიღებული ჟეტონი შემდგომი მოთხოვნებისთვის.

2. მიიღეთ ორგანიზაციის სია

გაუგზავნეთ GET მოთხოვნა /api/კომპანია/ორგანიზაცია კომპანიის ჟეტონის გამოყენებით თქვენი ორგანიზაციების სიაში.

** მოთხოვნა ** - ** მეთოდი: ** GET - URL: https://chatapi.smsbat.com/api/company/organization - ** სათაურები:** - ავტორიზაცია: მატარებელი {ჟეტონი} - მიღება: ტექსტი/უბრალო

პასუხი - სტატუსის კოდი: 200 (OK) - ** სხეული:**

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

3. ოპერატორების მოძიება ორგანიზაციის მიხედვით

გაგზავნეთ GET მოთხოვნა /api/operator-ზე organizationId პარამეტრის გამოყენებით.

** მოთხოვნა ** - ** მეთოდი: ** GET - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - ** სათაურები:** - ავტორიზაცია: მატარებელი {ჟეტონი} - მიღება: ტექსტი/უბრალო

პასუხი - სტატუსის კოდი: 200 (OK) - ** სხეული:**

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

4. დაამატეთ ოპერატორები სისტემაში

გამოიყენეთ კომპანიის ჟეტონი ამ ბოლო წერტილზე წვდომისთვის და ოპერატორების სისტემაში სინქრონიზაციისთვის.

** მოთხოვნა ** - მეთოდი: POST - URL: https://chatapi.smsbat.com/api/operator/synchronize - ** სათაურები:** - ავტორიზაცია: მატარებელი {ჟეტონი} - კონტენტ-ტიპი: აპლიკაცია/json

** სხეული: **

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

პასუხი - სტატუსის კოდი: 200 (OK) - ** სხეული:**

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

** ოპერატორის შესაძლო სტატუსები: ** - აქტიური: 0 - არააქტიური: 1 - წაშლილია: 2

5. მიიღეთ ოპერატორის ტოკენი

ავტორიზაცია კომპანიის ჟეტონთან ერთად კონკრეტული ოპერატორისთვის ჟეტონის მისაღებად.

** მოთხოვნა ** - მეთოდი: POST - URL: https://chatapi.smsbat.com/api/operator/get-token - ** სათაურები:** - ავტორიზაცია: მატარებელი {ჟეტონი} - კონტენტ-ტიპი: აპლიკაცია/json

** სხეული: **

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

expiresAt აუცილებელია და განსაზღვრავს ოპერატორის სესიის ხანგრძლივობას (მაქსიმუმ +24 საათი).

პასუხი - სტატუსის კოდი: 200 (OK) - სხეული: სიმებიანი ნიშანი

6. ოპერატორის ტოკენის დადასტურება

გადაამოწმეთ ოპერატორის ჟეტონის მოქმედება.

** მოთხოვნა ** - მეთოდი: POST - URL: https://chatapi.smsbat.com/api/operator/validate-token - ** სათაურები:** - ავტორიზაცია: მატარებელი {ჟეტონი} - კონტენტ-ტიპი: აპლიკაცია/json

Body: "operator_token_string"

** მოქმედი პასუხი (200 OK):**

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

7. ღრმა დაკავშირება ოპერატორის ჩატის პანელთან

გარე სისტემებს (CRM, ERP, შიდა ვებსაიტები) შეუძლიათ პირდაპირ გახსნან ჩატის პანელი ღრმა ბმულების გამოყენებით JWT ოპერატორის ტოკენის პარამეტრად გადაცემით. თუ ჟეტონი არასწორია ან ვადაგასულია, მომხმარებელი გადამისამართდება შესვლის ინტერფეისზე.

ფორმატი 1: ჩატის ID-ით

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

ფორმატი 2: ტელეფონის ნომრით

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

ტელეფონის ნომერი უნდა იყოს E.164 საერთაშორისო ფორმატში.

ფორმატი 3: ალფა სახელით და ტელეფონით

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

ფორმატი 4: სრული მიზნის დეტალები

დააკონკრეტეთ ზუსტად რომელი წყაროდან მივიღოთ შეტყობინებები:

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

ჩეთის წყაროები: - 0 - Viber - 1 - ViberBot - 2 - TelegramBot - 3 - Whatsapp - 4 - ვიჯეტი - 5 - როზეტკა - 6 - ფეისბუქი - 7 - ინსტაგრამი