Gå till innehållet

Operatörsbehörighet och djuplänkar

Den här guiden förklarar hur man skaffar en giltig auktoriseringstoken för operatörer i systemet via API och hur man använder djuplänkar för att navigera till chattpanelen.

API-basadress: https://chatapi.smsbat.com/ Swagger: https://chatapi.smsbat.com/index.html

Obs: Du kan använda rubriken X-Authorization-Key med din token (tillgänglig i din profil i instrumentpanelen) istället för Bearer-auktorisering för förfrågningar på företagsnivå.

1. Skaffa företagstoken

För att få företagets token, skicka en HTTP POST-begäran till /api/company/get-token som innehåller företagets inloggningsuppgifter.

Begäran - Metod: POST - URL: https://chatapi.smsbat.com/api/company/get-token - Rubriker: Content-Type: application/json

Kroppen: 

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

Response - Statuskod: 200 (OK) - Body: String token ("din_token_string")

Obs! Spara den mottagna token för efterföljande förfrågningar.

2. Hämta organisationslista

Skicka en GET-förfrågan till /api/företag/organisation med hjälp av företagstoken för att lista dina organisationer.

Begäran - Metod: GET - URL: https://chatapi.smsbat.com/api/company/organization - Rubriker: - Auktorisering: Bärare {token} - Acceptera: text/oformaterad

Svar - Statuskod: 200 (OK) - Kroppen: 

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

3. Hämta operatörer efter organisation

Skicka en GET-förfrågan till /api/operator med hjälp av parametern organizationId.

Begäran - Metod: GET - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Rubriker: - Auktorisering: Bärare {token} - Acceptera: text/oformaterad

Svar - Statuskod: 200 (OK) - Kroppen: 

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

4. Lägg till operatörer till systemet

Använd företagets token för att komma åt denna slutpunkt och synkronisera operatörer till systemet.

Begäran - Metod: POST - URL: https://chatapi.smsbat.com/api/operator/synchronize - Rubriker: - Auktorisering: Bärare {token} - Content-Type: application/json

Kroppen: 

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

Svar - Statuskod: 200 (OK) - Kroppen: 

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

Möjliga operatörsstatusar: - Aktiv: 0 - Inaktiv: 1 - Raderad: 2

5. Skaffa operatörstoken

Auktorisera med företagets token för att få en token för en specifik operatör.

Begäran - Metod: POST - URL: https://chatapi.smsbat.com/api/operator/get-token - Rubriker: - Auktorisering: Bärare {token} - Content-Type: application/json

Kroppen: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt krävs och bestämmer operatörens sessionslängd (max +24 timmar).

Svar - Statuskod: 200 (OK) - Kroppen: String token

6. Validera operatörstoken

Verifiera giltigheten av en operatörs token.

Begäran - Metod: POST - URL: https://chatapi.smsbat.com/api/operator/validate-token - Rubriker: - Auktorisering: Bärare {token} - Content-Type: application/json

Brödtext: "operator_token_string"

Giltigt svar (200 OK): 

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

7. Djuplänkning till operatörschattpanelen

Externa system (CRM, ERP, interna webbplatser) kan direkt öppna chattpanelen och utnyttja djuplänkarna genom att skicka JWT Operator-token som en parameter. Om token är ogiltigt eller har gått ut kommer användaren att omdirigeras till inloggningsgränssnittet.

Format 1: Med chatt-ID

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

Format 2: Via telefonnummer

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Telefonnumret måste vara i E.164 internationellt format.

Format 3: Efter alfanamn och telefon

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

Format 4: Komplettera måldetaljer

Ange exakt vilken källa meddelanden ska fångas upp från: 

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