Pereiti prie turinio

Operatoriaus įgaliojimas ir gilios nuorodos

Šiame vadove paaiškinama, kaip gauti galiojantį prieigos raktą operatoriams sistemoje naudojant API ir kaip naudoti giliąsias nuorodas norint pereiti į pokalbių skydelį.

API bazinis URL: https://chatapi.smsbat.com/ Swagger: „https://chatapi.smsbat.com/index.html“.

Pastaba: galite naudoti antraštę „X-Authorization-Key“ su savo prieigos raktu (pasiekiama jūsų profilyje prietaisų skydelyje), o ne „Nenešėjos“ įgaliojimą įmonės lygio užklausoms.

1. Gaukite įmonės žetoną

Norėdami gauti įmonės prieigos raktą, išsiųskite HTTP POST užklausą į „/api/company/get-token“, kurioje yra įmonės prisijungimo duomenys.

Prašymas - Metodas: PAST - URL: https://chatapi.smsbat.com/api/company/get-token – Antraštės: „Turinio tipas: programa/json“.

Kūnas: 

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

Atsakymas - Būsenos kodas: 200 (Gerai) – Turinys: Eilutės prieigos raktas („jūsų_tokeno_eilutė“)

Pastaba: Išsaugokite gautą prieigos raktą vėlesnėms užklausoms.

2. Gaukite organizacijų sąrašą

Išsiųskite GET užklausą į „/api/company/organization“, naudodami įmonės prieigos raktą, kad pateiktumėte savo organizacijas.

Prašymas - Metodas: GAUTI - URL: https://chatapi.smsbat.com/api/company/organization - Antraštės: - „Įgaliojimas: nešėjas {žetonas}“. - „Priimti: tekstas / paprastas“.

Atsakymas - Būsenos kodas: 200 (Gerai) -Kūnas: 

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

3. Gaukite operatorius pagal organizaciją

Išsiųskite GET užklausą į „/api/operator“, naudodami parametrą „organizationId“.

Prašymas - Metodas: GAUTI – URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Antraštės: - „Įgaliojimas: nešėjas {žetonas}“. - „Priimti: tekstas / paprastas“.

Atsakymas - Būsenos kodas: 200 (Gerai) -Kūnas: 

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

4. Pridėti operatorių prie sistemos

Norėdami pasiekti šį galinį tašką ir sinchronizuoti operatorius su sistema, naudokite įmonės prieigos raktą.

Prašymas - Metodas: PAST – URL: https://chatapi.smsbat.com/api/operator/synchronize - Antraštės: - „Įgaliojimas: nešėjas {žetonas}“. – „Turinio tipas: programa/json“.

Kūnas: 

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

Atsakymas - Būsenos kodas: 200 (Gerai) -Kūnas: 

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

Galimos operatoriaus būsenos: – Aktyvus: „0“. – Neaktyvus: „1“. – Išbraukta: „2“.

5. Gaukite operatoriaus žetoną

Įgaliokite įmonės prieigos raktą, kad gautumėte konkretaus operatoriaus žetoną.

Prašymas - Metodas: PAST – URL: https://chatapi.smsbat.com/api/operator/get-token - Antraštės: - „Įgaliojimas: nešėjas {žetonas}“. – „Turinio tipas: programa/json“.

Kūnas: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
„ExpiresAt“ yra būtinas ir nustato operatoriaus seanso trukmę (maks. „+24 valandos“).

Atsakymas - Būsenos kodas: 200 (Gerai) - Turinys: Stygos ženklas

6. Patvirtinkite operatoriaus prieigos raktą

Patikrinkite operatoriaus prieigos rakto galiojimą.

Prašymas - Metodas: PAST – URL: https://chatapi.smsbat.com/api/operator/validate-token - Antraštės: - „Įgaliojimas: nešėjas {žetonas}“. – „Turinio tipas: programa/json“.

Turinys: „operatoriaus_tokeno_string“.

** Galiojantis atsakymas (200 OK):** 

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

7. Gilus susiejimas su operatoriaus pokalbių skydeliu

Išorinės sistemos (CRM, ERP, vidinės svetainės) gali tiesiogiai atidaryti pokalbių skydelį, panaudodamos giliąsias nuorodas, kaip parametrą perduodamos JWT operatoriaus prieigos raktą. Jei prieigos raktas netinkamas arba pasibaigęs, vartotojas bus nukreiptas į prisijungimo sąsają.

1 formatas: pagal pokalbio ID

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

2 formatas: pagal telefono numerį

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Telefono numeris turi būti E.164 tarptautinio formato.

3 formatas: pagal alfa pavadinimą ir telefono numerį

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

4 formatas: užpildykite tikslinę informaciją

Tiksliai nurodykite, iš kurio šaltinio perimti pranešimus: 

https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>
Pokalbių šaltiniai: - "0" - Viber - "1" - ViberBot – „2“ – „TelegramBot“. - "3" - Whatsapp – „4“ – Valdiklis - "5" - Rozetka - 6 - Facebook - "7" - Instagram