Kalo te përmbajtja

Autorizimi i operatorit dhe lidhjet e thella

Ky udhëzues shpjegon se si të merrni një shenjë të vlefshme autorizimi për operatorët në sistem nëpërmjet API dhe si të përdorni lidhje të thella për të lundruar në panelin e bisedës.

URL-ja bazë e API: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

Shënim: Ju mund të përdorni titullin "X-Authorization-Key" me token tuaj (i disponueshëm në profilin tuaj në panelin e kontrollit) në vend të autorizimit "Bartësi" për kërkesat e nivelit të kompanisë.

1. Merrni Tokenin e Kompanisë

Për të marrë shenjën e kompanisë, dërgoni një kërkesë HTTP POST te /api/company/get-token që përmban kredencialet e identifikimit të kompanisë.

kërkesë - Metoda: POST - URL: https://chatapi.smsbat.com/api/company/get-token - Titujt: Lloji i përmbajtjes: aplikacion/json

Trupi: 

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

Përgjigje - Kodi i statusit: 200 (OK) - Trupi: Shenja e vargut ("vargu_juaj_token")

Shënim: Ruani tokenin e marrë për kërkesat pasuese.

2. Merrni listën e organizatave

Dërgoni një kërkesë GET tek /api/company/organization duke përdorur tokenin e kompanisë për të listuar organizatat tuaja.

kërkesë - ** Metoda: ** MERRNI - URL: https://chatapi.smsbat.com/api/company/organization - Titujt: - Autorizimi: Bartësi {token} - Prano: tekst/i thjeshtë

Përgjigje - Kodi i statusit: 200 (OK) - Trupi: KODI_BLOCK_1

3. Merr operatorët sipas organizatës

Dërgo një kërkesë GET tek /api/operator duke përdorur parametrin organizationId.

kërkesë - ** Metoda: ** MERRNI - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Titujt: - Autorizimi: Bartësi {token} - Prano: tekst/i thjeshtë

Përgjigje - Kodi i statusit: 200 (OK) - Trupi: 

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

4. Shtoni operatorët në sistem

Përdorni tokenin e kompanisë për të hyrë në këtë pikë fundore dhe për të sinkronizuar operatorët në sistem.

kërkesë - Metoda: POST - URL: https://chatapi.smsbat.com/api/operator/synchronize - Titujt: - Autorizimi: Bartësi {token} - Lloji i përmbajtjes: aplikacion/json

Trupi: KODI_BLOCK_3

Përgjigje - Kodi i statusit: 200 (OK) - Trupi: 

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

Statuset e mundshme të operatorit: - Aktiv: 0 - Joaktiv: 1 - U fshi: 2

5. Merrni Tokenin e Operatorit

Autorizoni me shenjën e kompanisë për të marrë një shenjë për një operator specifik.

kërkesë - Metoda: POST - URL: https://chatapi.smsbat.com/api/operator/get-token - Titujt: - Autorizimi: Bartësi {token} - Lloji i përmbajtjes: aplikacion/json

Trupi: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
ExpiresAt kërkohet dhe përcakton kohëzgjatjen e sesionit të operatorit (maksimumi +24 orë).

Përgjigje - Kodi i statusit: 200 (OK) - Trupi: Shenja e vargut

6. Vërtetoni Tokenin e Operatorit

Verifikoni vlefshmërinë e shenjës së një operatori.

kërkesë - Metoda: POST - URL: https://chatapi.smsbat.com/api/operator/validate-token - Titujt: - Autorizimi: Bartësi {token} - Lloji i përmbajtjes: aplikacion/json

Trupi: "operator_token_string"

Përgjigje e vlefshme (200 OK): 

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

7. Lidhje e thellë me panelin e bisedës së operatorit

Sistemet e jashtme (CRM, ERP, faqet e brendshme të internetit) mund të hapin drejtpërdrejt panelin Chat duke shfrytëzuar lidhjet e thella duke kaluar si parametër tokenin e operatorit JWT. Nëse token është i pavlefshëm ose i skaduar, përdoruesi do të ridrejtohet në ndërfaqen e hyrjes.

Formati 1: Me ID Chat

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

Formati 2: Me numrin e telefonit

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Numri i telefonit duhet të jetë në formatin ndërkombëtar E.164.

Formati 3: Sipas emrit dhe telefonit alfa

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

Formati 4: Plotësoni Detajet e Synimit

Specifikoni saktësisht se nga cili burim do të përgjoni mesazhet: 

https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>
Burimet e bisedës: - 0 - Viber - 1 - ViberBot - 2 - TelegramBot - 3 - Whatsapp - 4 - Miniaplikacioni - 5 - Rozetka - 6 - Facebook - 7 - Instagram