Hyppää sisältöön

Operaattorin valtuutus ja syvälinkit

Tässä oppaassa kerrotaan, kuinka hankitaan kelvollinen valtuutustunnus järjestelmän operaattoreille API:n kautta ja kuinka chat-paneeliin navigointiin käytetään täsmälinkkejä.

API-perus-URL-osoite: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

Huomaa: Voit käyttää 'X-Authorization-Key'-otsikkoa tunnuksesi kanssa (saatavilla profiilissasi kojelaudassa) 'Bearer'-valtuutuksen sijaan yritystason pyyntöihin.

1. Hanki yrityksen tunnus

Saat yrityksen tunnuksen lähettämällä HTTP POST -pyynnön osoitteeseen `/api/company/get-token', joka sisältää yrityksen kirjautumistiedot.

Pyyntö - Menetelmä: POST - URL-osoite: https://chatapi.smsbat.com/api/company/get-token - Otsikot: "Sisältötyyppi: sovellus/json".

Runko: 

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

Vastaus - Tilakoodi: 200 (OK) - Body: Merkkijonotunnus ("oma_tunnus_merkkijonosi")

Huomaa: Tallenna vastaanotettu tunnus myöhempiä pyyntöjä varten.

2. Hae organisaatioluettelo

Lähetä GET-pyyntö osoitteeseen `/api/company/organisation' käyttämällä yritystunnusta organisaatiosi luetteloimiseksi.

Pyyntö - Menetelmä: HANKI - URL-osoite: https://chatapi.smsbat.com/api/company/organization - Otsikot: - "Valtuutus: Haltija {tunnus}". - "Hyväksy: teksti/tavallinen".

Vastaus - Tilakoodi: 200 (OK) -Runko: 

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

3. Hae operaattorit organisaation mukaan

Lähetä GET-pyyntö osoitteeseen "/api/operator" organizationId-parametrilla.

Pyyntö - Menetelmä: HANKI - URL-osoite: https://chatapi.smsbat.com/api/operator?organizationId={id} - Otsikot: - "Valtuutus: Haltija {tunnus}". - "Hyväksy: teksti/tavallinen".

Vastaus - Tilakoodi: 200 (OK) -Runko: 

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

4. Lisää operaattorit järjestelmään

Käytä yritystunnusta päästäksesi tähän päätepisteeseen ja synkronoidaksesi operaattorit järjestelmään.

Pyyntö - Menetelmä: POST - URL-osoite: https://chatapi.smsbat.com/api/operator/synchronize - Otsikot: - "Valtuutus: Haltija {tunnus}". - "Sisältötyyppi: sovellus/json".

Runko: 

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

Vastaus - Tilakoodi: 200 (OK) -Runko: 

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

Mahdolliset operaattorin tilat: - Aktiivinen: "0". - Ei-aktiivinen: "1". - Poistettu: "2".

5. Hanki operaattoritunnus

Valtuuta yritystunnuksella hankkimaan tunnus tietylle operaattorille.

Pyyntö - Menetelmä: POST - URL-osoite: https://chatapi.smsbat.com/api/operator/get-token - Otsikot: - "Valtuutus: Haltija {tunnus}". - "Sisältötyyppi: sovellus/json".

Runko: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt vaaditaan ja määrittää operaattorin istunnon keston (enintään +24 tuntia).

Vastaus - Tilakoodi: 200 (OK) - Runko: Merkkijonomerkki

6. Vahvista operaattoritunnus

Tarkista operaattorin tunnuksen kelpoisuus.

Pyyntö - Menetelmä: POST - URL-osoite: https://chatapi.smsbat.com/api/operator/validate-token - Otsikot: - "Valtuutus: Haltija {tunnus}". - "Sisältötyyppi: sovellus/json".

Body: "operaattorin_tunnusmerkkijono"

Pätevä vastaus (200 OK): 

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

7. Syvälinkitys operaattorin keskustelupaneeliin

Ulkoiset järjestelmät (CRM, ERP, sisäiset verkkosivustot) voivat avata suoraan Chat-paneelin hyödyntäen täsmälinkkejä välittämällä JWT-operaattorin tunnuksen parametrina. Jos tunnus on virheellinen tai vanhentunut, käyttäjä ohjataan kirjautumisliittymään.

Muoto 1: Chat ID:n mukaan

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

Muoto 2: Puhelinnumeron mukaan

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Puhelinnumeron on oltava kansainvälisessä E.164-muodossa.

Muoto 3: Alfa-nimellä ja -puhelimella

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

Muoto 4: Täytä kohteen tiedot

Määritä tarkalleen, mistä lähteestä viestit siepataan: 

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