Օպերատորի թույլտվություն և խորը հղումներ

Այս ուղեցույցը բացատրում է, թե ինչպես ստանալ վավերական թույլտվության նշան համակարգի օպերատորների համար API-ի միջոցով և ինչպես օգտագործել խորը հղումներ՝ դեպի զրույցի վահանակ նավարկելու համար:

API բազային URL՝ «https://chatapi.smsbat.com/»: Սվագեր՝ «https://chatapi.smsbat.com/index.html»:

Նշում. դուք կարող եք օգտագործել «X-Authorization-Key» վերնագիրը ձեր նշանի հետ (հասանելի է ձեր պրոֆիլում վահանակում) ընկերության մակարդակի հարցումների համար «Bearer» թույլտվության փոխարեն:

1. Ստացեք ընկերության խորհրդանիշը

Ընկերության նշանը ստանալու համար ուղարկեք HTTP POST հարցում /api/company/get-token-ին, որը պարունակում է ընկերության մուտքի հավատարմագրերը:

խնդրանք - Մեթոդ: ՓՈՍՏ - URL: https://chatapi.smsbat.com/api/company/get-token - Վերնագրեր. «Բովանդակության տեսակը. հավելված/json»:

** Մարմինը:**

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

Պատասխան - ** Կարգավիճակի կոդ: 200 (OK) - Թեման.** Լարի նշան («your_token_string»)

Նշում. Պահպանեք ստացված նշանը հետագա հարցումների համար:

2. Առբերեք կազմակերպությունների ցուցակը

Ուղարկեք GET հարցում «/api/company/organization»՝ օգտագործելով ընկերության նշանը՝ ձեր կազմակերպությունները ցուցակագրելու համար:

խնդրանք - Մեթոդ. GET - URL: «https://chatapi.smsbat.com/api/company/organization» - ** Վերնագրեր: ** - «Թույլտվություն. կրող {token}»: - «Ընդունել՝ տեքստ/պարզ»:

Պատասխան - ** Կարգավիճակի կոդ: 200 (OK) - Մարմին:**

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

3. Առբերեք օպերատորներին ըստ կազմակերպության

Ուղարկեք GET հարցում `/api/operator`` օգտագործելով «organizationId» պարամետրը:

խնդրանք - Մեթոդ. GET - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - ** Վերնագրեր: ** - «Թույլտվություն. կրող {token}»: - «Ընդունել՝ տեքստ/պարզ»:

Պատասխան - ** Կարգավիճակի կոդ: 200 (OK) - Մարմին:**

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

4. Ավելացնել օպերատորներ համակարգին

Օգտագործեք ընկերության նշանը՝ այս վերջնակետին մուտք գործելու և օպերատորներին համակարգին համաժամացնելու համար:

խնդրանք - Մեթոդ: ՓՈՍՏ - URL: «https://chatapi.smsbat.com/api/operator/synchronize» - ** Վերնագրեր: ** - «Թույլտվություն. կրող {token}»: - «Content-Type. application/json»:

** Մարմինը:**

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

Պատասխան - ** Կարգավիճակի կոդ: 200 (OK) - Մարմին:**

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

Օպերատորի հնարավոր կարգավիճակները. - Ակտիվ՝ «0»: - Ոչ ակտիվ՝ «1»: - Ջնջված է՝ «2»:

5. Ստացեք օպերատորի նշան

Ընկերության նշանով լիազորեք որոշակի օպերատորի համար նշան ձեռք բերելու համար:

խնդրանք - Մեթոդ: ՓՈՍՏ - URL: «https://chatapi.smsbat.com/api/operator/get-token» - ** Վերնագրեր: ** - «Թույլտվություն. կրող {token}»: - «Content-Type. application/json»:

** Մարմինը:

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

expiresAt-ը պահանջվում է և որոշում է օպերատորի աշխատաշրջանի տևողությունը (առավելագույնը` +24 ժամ):

Պատասխան - ** Կարգավիճակի կոդ: 200 (OK) - Թափ:** Լարային նշան

6. Վավերացնել օպերատորի նշանը

Ստուգեք օպերատորի նշանի վավերականությունը:

խնդրանք - Մեթոդ: ՓՈՍՏ - URL: https://chatapi.smsbat.com/api/operator/validate-token - ** Վերնագրեր: ** - «Թույլտվություն. կրող {token}»: - «Content-Type. application/json»:

Թեման՝ «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. Chat 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» - Instagram