Help Center Údarú Oibreora agus Naisc dhomhain

Údarú Oibreora agus Naisc dhomhain

Míníonn an treoir seo conas comhartha údaraithe bailí a fháil d’oibreoirí sa chóras trí API agus conas naisc dhomhain a úsáid chun dul chuig an bpainéal comhrá.

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

Tabhair faoi deara: Is féidir leat an ceanntásc X-Authorization-Key a úsáid le do chomhartha (ar fáil i do Phróifíl ar an deais) in ionad údarú Bearer le haghaidh iarratais ar leibhéal na cuideachta.


1. Faigh Comhartha Cuideachta

Chun an comhartha cuideachta a fháil, seol iarratas POST HTTP chuig /api/company/get-token ina bhfuil dintiúir logáil isteach na cuideachta.

Iarratas

  • Modh: POST
  • URL: https://chatapi.smsbat.com/api/company/get-token
  • Ceanntásca: Cineál Ábhar: iarratas/json

Comhlacht: CÓD_BLOCK_0_

Freagra

  • Cód Stádais: 200 (OK)
  • ** Comhlacht:** Comhartha teaghrán ("do_token_string")

Tabhair faoi deara: Sábháil an comhartha faighte le haghaidh iarratais ina dhiaidh sin.


2. Aisghabh Liosta Eagraíochta

Seol iarratas GET chuig /api/company/organisation agus úsáid á baint agat as comhartha na cuideachta chun d’eagraíochtaí a liostú.

Iarratas

  • Modh: FAIGH
  • URL: https://chatapi.smsbat.com/api/company/organization
  • Ceanntásca:
    • Údarú: Iompróir {token}
    • `Glac le: téacs/gnáth’

Freagra

  • Cód Stádais: 200 (OK)
  • Comhlacht: CÓD_BLOCK_1_

3. Aisghabh Oibreoirí de réir Eagraíochta

Seol iarratas GET chuig /api/operator ag baint úsáide as an bparaiméadar organizationId.

Iarratas

  • Modh: FAIGH
  • URL: https://chatapi.smsbat.com/api/operator?organizationId={id}
  • Ceanntásca:
    • Údarú: Iompróir {token}
    • `Glac le: téacs/gnáth’

Freagra

  • Cód Stádais: 200 (OK)
  • Comhlacht: CÓD_BLOCK_2_

4. Cuir Oibreoirí leis an gCóras

Bain úsáid as comhartha na cuideachta chun rochtain a fháil ar an gcríochphointe seo agus sioncrónaigh oibreoirí leis an gcóras.

Iarratas

  • Modh: POST
  • URL: https://chatapi.smsbat.com/api/operator/synchronize
  • Ceanntásca:
    • Údarú: Iompróir {token}
    • Cineál Ábhar: iarratas/json

Comhlacht: CÓD_BLOCK_3_

Freagra

  • Cód Stádais: 200 (OK)
  • Comhlacht: CÓD_BLOCK_4_

Stáisiúin Oibreora Féideartha:

  • Gníomhach: 0
  • Neamhghníomhach: 1
  • Scriosta: 2

5. Faigh Comhartha Oibreora

Údarú leis an gcuideachta comhartha chun chomhartha a fháil d’oibreoir sonrach.

Iarratas

  • Modh: POST
  • URL: https://chatapi.smsbat.com/api/operator/get-token
  • Ceanntásca:
    • Údarú: Iompróir {token}
    • Cineál Ábhar: iarratas/json

Comhlacht: CÓD_BLOCK_5_ Tá gá le “expiresAt' agus socróidh sé fad seisiún an oibreora (uasmhéid +24 uair`).

Freagra

  • Cód Stádais: 200 (OK)
  • Comhlacht: Comhartha teaghrán

6. Bailíochtaigh Comhartha Oibreora

Fíoraigh bailíocht chomhartha oibreora.

Iarratas

  • Modh: POST
  • URL: https://chatapi.smsbat.com/api/operator/validate-token
  • Ceanntásca:
    • Údarú: Iompróir {token}
    • Cineál Ábhar: iarratas/json

Comhlacht: "operator_token_string"

Freagra Bailí (200 ceart go leor): CÓD_BLOCK_6_


7. Nasc domhain le Painéal Comhrá an Oibreora

Is féidir le córais sheachtracha (CRM, ERP, láithreáin ghréasáin inmheánacha) an painéal Comhrá a oscailt go díreach agus na naisc dhomhain a ghiaráil trí chomhartha Oibreora JWT a rith mar pharaiméadar. Má tá an comhartha neamhbhailí nó má théann sé in éag, déanfar an t-úsáideoir a atreorú chuig an gcomhéadan logáil isteach.

Formáid 1: Trí ID Comhrá

CÓD_BLOCK_7_

Formáid 2: De réir Uimhir Theileafóin

CÓD_BLOCK_8_ Caithfidh an uimhir theileafóin a bheith san fhormáid idirnáisiúnta E.164.

Formáid 3: De réir Alfa Ainm & Fón

CÓD_BLOCK_9_

Formáid 4: Críochnaigh Sonraí na sprice

Sonraigh go díreach cén fhoinse chun teachtaireachtaí a thascradh uaithi: CÓD_BLOCK_10_ Foinsí Comhrá:

  • 0 - Viber
  • 1 - ViberBot
  • 2 - TelegramBot
  • 3 - Whatsapp
  • 4 - Giuirléid
  • 5 - Rozetka
  • 6 - Facebook
  • 7 - Instagram