I-skip tungo sa nilalaman

Awtorisasyon ng Operator at Mga Deep Link

Ipinapaliwanag ng gabay na ito kung paano makakuha ng wastong authorization token para sa mga operator sa system sa pamamagitan ng API at kung paano gumamit ng mga deep link upang mag-navigate sa chat panel.

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

Tandaan: Maaari mong gamitin ang header ng X-Authorization-Key kasama ang iyong token (available sa iyong Profile sa dashboard) sa halip na pahintulot ng Bearer para sa mga kahilingan sa antas ng kumpanya.

1. Kumuha ng Token ng Kumpanya

Upang makuha ang token ng kumpanya, magpadala ng kahilingan sa HTTP POST sa /api/company/get-token na naglalaman ng mga kredensyal sa pag-log in ng kumpanya.

Kahilingan - Paraan: POST - URL: https://chatapi.smsbat.com/api/company/get-token - Mga Header: Uri ng Nilalaman: application/json

Katawan: 

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

Tugon - Status Code: 200 (OK) - Katawan: String token ("iyong_token_string")

Tandaan: I-save ang natanggap na token para sa mga susunod na kahilingan.

2. Kunin ang Listahan ng Organisasyon

Magpadala ng kahilingan sa GET sa /api/company/organization gamit ang token ng kumpanya upang ilista ang iyong mga organisasyon.

Kahilingan - Paraan: GET - URL: https://chatapi.smsbat.com/api/company/organization - Mga Header: - Awtorisasyon: Tagadala ng {token} - Tanggapin: text/plain

Tugon - Status Code: 200 (OK) - Katawan: 

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

3. Kunin ang mga Operator ayon sa Organisasyon

Magpadala ng kahilingan sa GET sa /api/operator gamit ang parameter na organizationId.

Kahilingan - Paraan: GET - URL: https://chatapi.smsbat.com/api/operator?organizationId={id} - Mga Header: - Awtorisasyon: Tagadala ng {token} - Tanggapin: text/plain

Tugon - Status Code: 200 (OK) - Katawan: 

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

4. Magdagdag ng mga Operator sa System

Gamitin ang token ng kumpanya para ma-access ang endpoint na ito at i-synchronize ang mga operator sa system.

Kahilingan - Paraan: POST - URL: https://chatapi.smsbat.com/api/operator/synchronize - Mga Header: - Awtorisasyon: Tagadala ng {token} - Uri ng Nilalaman: application/json

Katawan: 

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

Tugon - Status Code: 200 (OK) - Katawan: 

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

Mga Posibleng Katayuan ng Operator: - Aktibo: 0 - Hindi aktibo: 1 - Tinanggal: 2

5. Kumuha ng Token ng Operator

Pahintulutan ang token ng kumpanya upang makakuha ng token para sa isang partikular na operator.

Kahilingan - Paraan: POST - URL: https://chatapi.smsbat.com/api/operator/get-token - Mga Header: - Awtorisasyon: Tagadala ng {token} - Uri ng Nilalaman: application/json

Katawan: 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
Kinakailangan ang expiresAt at tinutukoy ang tagal ng session ng operator (max +24 na oras).

Tugon - Status Code: 200 (OK) - Katawan: String token

6. I-validate ang Operator Token

I-verify ang validity ng token ng operator.

Kahilingan - Paraan: POST - URL: https://chatapi.smsbat.com/api/operator/validate-token - Mga Header: - Awtorisasyon: Tagadala ng {token} - Uri ng Nilalaman: application/json

Katawan: "operator_token_string"

** Wastong Tugon (200 OK):** 

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

7. Deep Linking sa Operator Chat Panel

Ang mga panlabas na system (CRM, ERP, mga panloob na website) ay maaaring direktang buksan ang Chat panel sa paggamit ng mga malalim na link sa pamamagitan ng pagpasa sa JWT Operator token bilang isang parameter. Kung ang token ay hindi wasto o nag-expire, ang user ay ire-redirect sa login interface.

Format 1: Sa pamamagitan ng Chat ID

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

Format 2: Sa Numero ng Telepono

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Ang numero ng telepono ay dapat nasa internasyonal na format na E.164.

Format 3: Sa Pangalan ng Alpha at Telepono

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

Format 4: Kumpletuhin ang Mga Detalye ng Target

Tukuyin kung aling pinagmulan ang haharang ng mga mensahe mula sa: 

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