Gå til indholdet

Operatørautorisation og dybe links

Denne vejledning forklarer, hvordan man opnår et gyldigt autorisationstoken til operatører i systemet via API, og hvordan man bruger dybe links til at navigere til chatpanelet.

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

Bemærk: Du kan bruge 'X-Authorization-Key'-headeren med dit token (tilgængelig i din profil på dashboardet) i stedet for 'Bearer'-autorisation til anmodninger på virksomhedsniveau.

1. Få firmatoken

For at få virksomhedens token skal du sende en HTTP POST-anmodning til /api/company/get-token, der indeholder virksomhedens loginoplysninger.

Anmodning - Metode: POST - URL: https://chatapi.smsbat.com/api/company/get-token - Overskrifter: Content-Type: application/json

Krop: 

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

Svar - Statuskode: 200 (OK) - Body: String token ("din_token_string"`)

Bemærk: Gem det modtagne token til efterfølgende anmodninger.

2. Hent organisationsliste

Send en GET-anmodning til /api/company/organisation ved at bruge firmatokenet til at liste dine organisationer.

Anmodning - Metode: FÅ - URL: https://chatapi.smsbat.com/api/company/organization - Overskrifter: - Autorisation: Bærer {token} - Acceptér: tekst/almindelig

Svar - Statuskode: 200 (OK) - Krop: 

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

3. Hent operatører efter organisation

Send en GET-anmodning til /api/operator ved hjælp af parameteren organizationId.

Anmodning - Metode: FÅ - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Overskrifter: - Autorisation: Bærer {token} - Acceptér: tekst/almindelig

Svar - Statuskode: 200 (OK) - Krop: 

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

4. Tilføj operatører til systemet

Brug firmatokenet til at få adgang til dette slutpunkt og synkronisere operatører til systemet.

Anmodning - Metode: POST - URL: https://chatapi.smsbat.com/api/operator/synchronize - Overskrifter: - Autorisation: Bærer {token} - Content-Type: application/json

Krop: 

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

Svar - Statuskode: 200 (OK) - Krop: 

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

Mulige operatørstatusser: - Aktiv: 0 - Inaktiv: 1 - Slettet: 2

5. Få operatørtoken

Tillad med virksomhedens token at få et token til en bestemt operatør.

Anmodning - Metode: POST - URL: https://chatapi.smsbat.com/api/operator/get-token - Overskrifter: - Autorisation: Bærer {token} - Content-Type: application/json

Krop: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt er påkrævet og bestemmer operatørens sessionsvarighed (maks. +24 timer).

Svar - Statuskode: 200 (OK) - Krop: String token

6. Valider operatørtoken

Bekræft gyldigheden af en operatørs token.

Anmodning - Metode: POST - URL: https://chatapi.smsbat.com/api/operator/validate-token - Overskrifter: - Autorisation: Bærer {token} - Content-Type: application/json

Body: "operator_token_string"

Gyldigt svar (200 OK): 

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

Eksterne systemer (CRM, ERP, interne websteder) kan åbne chatpanelet direkte ved at udnytte de dybe links ved at videregive JWT Operator-token som en parameter. Hvis tokenet er ugyldigt eller udløbet, vil brugeren blive omdirigeret til login-grænsefladen.

Format 1: Efter chat-id

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

Format 2: Efter telefonnummer

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Telefonnummer skal være i E.164 internationalt format.

Format 3: Efter alfanavn og telefon

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

Format 4: Fuldfør måldetaljer

Angiv præcis, hvilken kilde meddelelser skal opsnappes fra: 

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