Keri sisuni

Operaatori autoriseerimine ja sügavad lingid

See juhend selgitab, kuidas hankida API kaudu süsteemi operaatoritele kehtiv autoriseerimisluba ja kuidas kasutada vestluspaneelile navigeerimiseks sügavaid linke.

API baas-URL: https://chatapi.smsbat.com/ Swagger: "https://chatapi.smsbat.com/index.html".

Märkus. Ettevõtte tasemel päringute jaoks saate kasutada päist „X-Authorization-Key” koos oma märgiga (saadaval armatuurlaual teie profiilis) volituse „kandja” asemel.

1. Hankige ettevõtte tunnus

Ettevõtte loa hankimiseks saatke aadressile `/api/company/get-token' HTTP POST-i päring, mis sisaldab ettevõtte sisselogimismandaate.

Taotlus - Meetod: POSTITA - URL: https://chatapi.smsbat.com/api/company/get-token - Päised: "Sisutüüp: rakendus/json".

Keha: 

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

Vastus - Olekukood: 200 (OK) - Keha: Stringi tunnus ("teie_märgi_string")

Märkus. Salvestage saadud žetoon järgmisteks päringuteks.

2. Hankige organisatsioonide loend

Saatke GET-i päring aadressile „/api/company/organization”, kasutades oma organisatsioonide loetlemiseks ettevõtte luba.

Taotlus - Meetod: HANGI - URL: https://chatapi.smsbat.com/api/company/organization - Päised: - „Volitis: kandja {märk}”. - "Nõustu: tekst/lihtne".

Vastus - Olekukood: 200 (OK) - Kere: 

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

3. Otsi operaatorid organisatsiooni järgi

Saatke GET-päring aadressile „/api/operator”, kasutades parameetrit „organizationId”.

Taotlus - Meetod: HANGI - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Päised: - „Volitis: kandja {märk}”. - "Nõustu: tekst/lihtne".

Vastus - Olekukood: 200 (OK) - Kere: 

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

4. Lisage süsteemi operaatorid

Kasutage sellele lõpp-punktile juurdepääsuks ja operaatorite süsteemiga sünkroonimiseks ettevõtte luba.

Taotlus - Meetod: POSTITA - URL: https://chatapi.smsbat.com/api/operator/synchronize - Päised: - „Volitis: kandja {märk}”. - "Sisutüüp: rakendus/json".

Keha: 

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

Vastus - Olekukood: 200 (OK) - Kere: 

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

Võimalikud operaatori staatused: - Aktiivne: "0". - Mitteaktiivne: "1". - Kustutatud: "2".

5. Hankige operaatori tunnus

Lubage ettevõtte märgiga, et hankida konkreetsele operaatorile token.

Taotlus - Meetod: POSTITA - URL: https://chatapi.smsbat.com/api/operator/get-token - Päised: - „Volitis: kandja {märk}”. - "Sisutüüp: rakendus/json".

Keha: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt on nõutav ja määrab operaatori seansi kestuse (maksimaalselt +24 tundi).

Vastus - Olekukood: 200 (OK) - Keha: Stringi tunnus

6. Kinnitage operaatori tunnus

Kontrollige operaatori märgi kehtivust.

Taotlus - Meetod: POSTITA - URL: https://chatapi.smsbat.com/api/operator/validate-token - Päised: - „Volitis: kandja {märk}”. - "Sisutüüp: rakendus/json".

Keha: `"operaatori_token_string"".

Kehtiv vastus (200 OK): 

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

7. Sügav linkimine operaatori vestluspaneeliga

Välised süsteemid (CRM, ERP, siseveebisaidid) saavad otse avada vestluspaneeli, kasutades sügavaid linke, edastades parameetrina JWT operaatori märgi. Kui luba on kehtetu või aegunud, suunatakse kasutaja sisselogimisliidesesse.

Vorming 1: vestluse ID järgi

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

Vorming 2: telefoninumbri järgi

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Telefoninumber peab olema rahvusvahelises vormingus E.164.

Vorming 3: Alfa nime ja telefoninumbri järgi

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

Vorming 4: täitke sihtmärgi üksikasjad

Määrake täpselt, millisest allikast sõnumeid pealt kuulata: 

https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>
Vestluse allikad: - "0" - Viber - "1" - ViberBot - "2" - TelegramBot - "3" - Whatsapp - "4" - Vidin - "5" - Rozetka - "6" - Facebook - "7" - Instagram