Help Center Üzemeltetői jogosultság és mélyhivatkozások

Üzemeltetői jogosultság és mélyhivatkozások

Ez az útmutató elmagyarázza, hogyan szerezhet be érvényes engedélyezési tokent a rendszer operátorai számára API-n keresztül, és hogyan használhatja a mélyhivatkozásokat a csevegőpanelre történő navigáláshoz.

API alap URL: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

Megjegyzés: A vállalati szintű kérésekhez használhatja az „X-Authorization-Key” fejlécet a tokenjével (ez elérhető a profiljában az irányítópulton).

1. Szerezzen vállalati tokent

A vállalati token beszerzéséhez küldjön egy HTTP POST-kérést a `/api/company/get-token’ címre, amely tartalmazza a vállalat bejelentkezési adatait.

Kérés

  • Módszer: POST
  • URL: https://chatapi.smsbat.com/api/company/get-token
  • Fejlécek: Tartalomtípus: Application/json

Test:

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

Válasz

  • Állapotkód: 200 (OK)
  • Törzs: Karakterlánc-token (“a_token_karakterlánc”`)

Megjegyzés: Mentse el a kapott tokent a későbbi kérésekhez.

2. Szervezeti lista lekérése

Küldjön GET-kérelmet a `/api/company/organization’ címre a vállalati token használatával a szervezetek felsorolásához.

Kérés

  • Módszer: GET
  • URL: https://chatapi.smsbat.com/api/company/organization
  • Fejlécek:
    • Engedélyezés: Tulajdonos {token}
    • Elfogadás: szöveges/egyszerű

Válasz

  • Állapotkód: 200 (OK)
  • Test:
[
  {
    "id": 6,
    "name": "string"
  }
]

3. Operátorok lekérése szervezet szerint

Küldjön GET-kérelmet az „/api/operator” címre a „organizationId” paraméter használatával.

Kérés

  • Módszer: GET
  • URL: https://chatapi.smsbat.com/api/operator?organizationId={id}
  • Fejlécek:
    • Engedélyezés: Tulajdonos {token}
    • Elfogadás: szöveges/egyszerű

Válasz

  • Állapotkód: 200 (OK)
  • Test:
[
  {
    "id": 21,
    "name": "string",
    "status": 1,
    "organization": {
      "id": 24,
      "name": "test_costs"
    }
  }
]

4. Adjon hozzá operátorokat a rendszerhez

A végpont eléréséhez és az operátorok rendszerrel való szinkronizálásához használja a vállalati tokent.

Kérés

  • Módszer: POST
  • URL: https://chatapi.smsbat.com/api/operator/synchronize
  • Fejlécek:
    • Engedélyezés: Tulajdonos {token}
    • “Tartalomtípus: alkalmazás/json”.

Test:

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

Válasz

  • Állapotkód: 200 (OK)
  • Test:
[
  {
    "id": 21,
    "status": 0,
    "name": "string"
  }
]

Lehetséges kezelői állapotok:

  • Aktív: “0”.
  • Inaktív: “1”.
  • Törölve: “2”.

5. Szerezze be a kezelői tokent

Engedélyezze a vállalati tokennel egy token beszerzését egy adott operátor számára.

Kérés

  • Módszer: POST
  • URL: https://chatapi.smsbat.com/api/operator/get-token
  • Fejlécek:
    • Engedélyezés: Tulajdonos {token}
    • “Tartalomtípus: alkalmazás/json”.

Test:

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

Az expiresAt kötelező, és meghatározza az operátor munkamenetének időtartamát (max. +24 óra).

Válasz

  • Állapotkód: 200 (OK)
  • Bordy: String token

6. Az operátori token érvényesítése

Ellenőrizze az operátori token érvényességét.

Kérés

  • Módszer: POST
  • URL: https://chatapi.smsbat.com/api/operator/validate-token
  • Fejlécek:
    • Engedélyezés: Tulajdonos {token}
    • “Tartalomtípus: alkalmazás/json”.

Body: "operator_token_string"

Érvényes válasz (200 OK):

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

7. Mélyhivatkozás a kezelői csevegőpanelhez

A külső rendszerek (CRM, ERP, belső webhelyek) közvetlenül megnyithatják a Chat panelt, kihasználva a mélyhivatkozásokat a JWT Operator token paraméterként történő átadásával. Ha a token érvénytelen vagy lejárt, a felhasználó a bejelentkezési felületre kerül átirányításra.

1. formátum: Chat ID szerint

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

2. formátum: telefonszám szerint

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

A telefonszámnak E.164 nemzetközi formátumban kell lennie.

3. formátum: Alfa név és telefonszám alapján

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

4. formátum: A cél részleteinek megadása

Pontosan adja meg, hogy melyik forrásból kell elkapni az üzeneteket:

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

Csevegés forrásai:

  • 0 - Viber
  • 1 - ViberBot
  • “2” - TelegramBot
  • “3” - Whatsapp
  • 4 - Widget
  • 5 - Rozetka
  • 6 - Facebook
  • “7” - Instagram