Help Center Awtorizzazzjoni tal-Operatur u Deep Links

Awtorizzazzjoni tal-Operatur u Deep Links

Din il-gwida tispjega kif tikseb token ta ‘awtorizzazzjoni validu għall-operaturi fis-sistema permezz tal-API u kif tuża links profondi biex tinnaviga lejn il-panel taċ-chat.

URL Bażi API: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

Nota: Tista’ tuża l-header X-Authorization-Key bit-token tiegħek (disponibbli fil-Profil tiegħek fid-dashboard) minflok awtorizzazzjoni Bearer għal talbiet fil-livell tal-kumpanija.

1. Ikseb Company Token

Biex tikseb it-token tal-kumpanija, ibgħat talba HTTP POST lil /api/company/get-token li jkun fiha l-kredenzjali tal-login tal-kumpanija.

Talba

  • Metodu: POST
  • URL: https://chatapi.smsbat.com/api/company/get-token
  • Headers: Content-Type: application/json

Korp:

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

Tweġiba

  • Kodiċi ta’ l-Istatus: 200 (OK)
  • Korp: String token (""your_token_string”`)

Nota: Issejvja t-token riċevut għal talbiet sussegwenti.

2. Irkupra l-Lista tal-Organizzazzjoni

Ibgħat talba GET lil /api/company/organization billi tuża t-token tal-kumpanija biex telenka l-organizzazzjonijiet tiegħek.

Talba

  • Metodu: IKOLLOK
  • URL: https://chatapi.smsbat.com/api/company/organization
  • Headers:
    • Awtorizzazzjoni: Bearer {token}
    • “Aċċetta: test/sempliċi”.

Tweġiba

  • Kodiċi ta’ l-Istatus: 200 (OK)
  • Korp:
[
  {
    "id": 6,
    "name": "string"
  }
]

3. Irkupra l-Operaturi skont l-Organizzazzjoni

Ibgħat talba GET lil /api/operator billi tuża l-parametru organizationId.

Talba

  • Metodu: IKOLLOK
  • URL: https://chatapi.smsbat.com/api/operator?organizationId={id}
  • Headers:
    • Awtorizzazzjoni: Bearer {token}
    • “Aċċetta: test/sempliċi”.

Tweġiba

  • Kodiċi ta’ l-Istatus: 200 (OK)
  • Korp:
[
  {
    "id": 21,
    "name": "string",
    "status": 1,
    "organization": {
      "id": 24,
      "name": "test_costs"
    }
  }
]

4. Żid Operaturi mas-Sistema

Uża t-token tal-kumpanija biex taċċessa dan l-endpoint u tissinkronizza l-operaturi mas-sistema.

Talba

  • Metodu: POST
  • URL: https://chatapi.smsbat.com/api/operator/synchronize
  • Headers:
    • Awtorizzazzjoni: Bearer {token}
    • “Tip ta’ Kontenut: applikazzjoni/json”.

Korp:

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

Tweġiba

  • Kodiċi ta’ l-Istatus: 200 (OK)
  • Korp:
[
  {
    "id": 21,
    "status": 0,
    "name": "string"
  }
]

Status ta’ Operatur Possibbli:

  • Attiv: “0”.
  • Inattiv: “1”.
  • Imħassar: “2”.

5. Ikseb Operator Token

Awtorizza mat-token tal-kumpanija biex tikseb token għal operatur speċifiku.

Talba

  • Metodu: POST
  • URL: https://chatapi.smsbat.com/api/operator/get-token
  • Headers:
    • Awtorizzazzjoni: Bearer {token}
    • “Tip ta’ Kontenut: applikazzjoni/json”.

Korp:

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

expiresAt hija meħtieġa u tiddetermina t-tul tas-sessjoni tal-operatur (massimu +24 siegħa).

Tweġiba

  • Kodiċi ta’ l-Istatus: 200 (OK)
  • Korp: String token

6. Ivvalida Token tal-Operatur

Ivverifika l-validità tat-token ta’ operatur.

Talba

  • Metodu: POST
  • URL: https://chatapi.smsbat.com/api/operator/validate-token
  • Headers:
    • Awtorizzazzjoni: Bearer {token}
    • “Tip ta’ Kontenut: applikazzjoni/json”.

Korp: "operator_token_string"

Tweġiba Valida (200 OK):

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

7. Deep Linking ma’ Operator Chat Panel

Is-sistemi esterni (CRM, ERP, websajts interni) jistgħu jiftħu direttament il-pannell taċ-Chat billi jisfruttaw il-links profondi billi jgħaddu t-token tal-Operatur JWT bħala parametru. Jekk it-token ma jkunx validu jew skada, l-utent jiġi ridirett lejn l-interface tal-login.

Format 1: Permezz tal-ID taċ-Chat

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

Format 2: Permezz tan-Numru tat-Telefon

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

In-numru tat-telefon għandu jkun fil-format internazzjonali E.164.

Format 3: Permezz ta’ Isem Alpha u Telefon

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

Format 4: Imla Dettalji tal-Mira

Speċifika eżatt minn liema sors tinterċetta l-messaġġi minn:

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

Sorsi taċ-Chat:

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