Sari la conținut

Autorizarea operatorului și Deep Links

Acest ghid explică cum să obțineți un jeton de autorizare valid pentru operatorii din sistem prin intermediul API și cum să utilizați link-uri profunde pentru a naviga la panoul de chat.

Adresa URL de bază a API: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

Notă: puteți utiliza antetul X-Authorization-Key cu simbolul dvs. (disponibil în profilul dvs. din tabloul de bord) în loc de autorizarea Bearer pentru solicitările la nivel de companie.

1. Obțineți tokenul companiei

Pentru a obține indicativul companiei, trimiteți o solicitare HTTP POST către /api/company/get-token, care conține datele de conectare ale companiei.

Solicitare - Metodă: POST - URL: https://chatapi.smsbat.com/api/company/get-token - Headers: Content-Type: application/json

Corpul: 

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

Răspuns - Cod de stare: 200 (OK) - Body: String token (""your_token_string"`)

Notă: Salvați simbolul primit pentru solicitările ulterioare.

2. Preluați lista organizațiilor

Trimiteți o solicitare GET către „/api/company/organization” folosind simbolul companiei pentru a vă lista organizațiile.

Solicitare - Metoda: GET - URL: https://chatapi.smsbat.com/api/company/organization - Anteturi: - Autorizare: Purtător {token} - Accept: text/plain

Răspuns - Cod de stare: 200 (OK) - Corpul: 

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

3. Preluați operatori în funcție de organizație

Trimiteți o solicitare GET către /api/operator folosind parametrul organizationId.

Solicitare - Metoda: GET - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Anteturi: - Autorizare: Purtător {token} - Accept: text/plain

Răspuns - Cod de stare: 200 (OK) - Corpul: 

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

4. Adăugați operatori la sistem

Utilizați simbolul companiei pentru a accesa acest punct final și pentru a sincroniza operatorii cu sistemul.

Solicitare - Metodă: POST - URL: https://chatapi.smsbat.com/api/operator/synchronize - Anteturi: - Autorizare: Purtător {token} - Content-Type: application/json

Corpul: 

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

Răspuns - Cod de stare: 200 (OK) - Corpul: 

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

Stari posibile ale operatorului: - Activ: 0 - Inactiv: 1 - Șters: 2

5. Obțineți Token de operator

Autorizați cu jetonul companiei să obțineți un jeton pentru un anumit operator.

Solicitare - Metodă: POST - URL: https://chatapi.smsbat.com/api/operator/get-token - Anteturi: - Autorizare: Purtător {token} - Content-Type: application/json

Corpul: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt este necesar și determină durata sesiunii operatorului (max +24 ore).

Răspuns - Cod de stare: 200 (OK) - Corps: Jeton șir

6. Validați tokenul operatorului

Verificați validitatea simbolului unui operator.

Solicitare - Metodă: POST - URL: https://chatapi.smsbat.com/api/operator/validate-token - Anteturi: - Autorizare: Purtător {token} - Content-Type: application/json

Body: "operator_token_string"

Răspuns valid (200 OK): 

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

7. Legături profunde la panoul de chat al operatorului

Sistemele externe (CRM, ERP, site-uri web interne) pot deschide direct panoul de chat utilizând legăturile profunde prin transmiterea simbolului operatorului JWT ca parametru. Dacă simbolul este invalid sau a expirat, utilizatorul va fi redirecționat către interfața de conectare.

Format 1: După ID de chat

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

Format 2: După numărul de telefon

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Numărul de telefon trebuie să fie în format internațional E.164.

Format 3: După nume alfa și telefon

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

Format 4: Completează detaliile țintei

Specificați exact ce sursă să interceptați mesajele de la: 

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