Անցնել պարունակությանը

Զրույցներ և հաղորդագրություններ

API մեթոդներ՝ ChatHub զրույցի մետատվյալները բեռնելու, կարգավիճակները կառավարելու և պատմական հաղորդագրությունների շղթաները վերանայելու համար:

URL՝ «https://chatapi.smsbat.com»:

1. Ստացեք բոլոր զրույցները

Ստացեք զրույցների ցանկ՝ դինամիկ զտիչով և էջադրմամբ:

խնդրանք - Մեթոդ. GET - URL: «/api/chat/chats»: - Թույլտվություն. «Կրողի նշան» (պահանջվում է)

Հարցման պարամետրեր

Պարամետր Տեսակ Նկարագրություն
«էջ» «ամբողջ թիվ» Էջի համարը. Կանխադրված՝ «1»
«մեկ_էջ» «ամբողջ թիվ» Նյութեր մեկ էջի համար: Կանխադրված՝ «20»
«որոնում» «լարային» Տեքստի որոնում (օրինակ՝ անուն, հեռախոս)
«աղբյուր» «ամբողջ թիվ» Chat Source Enum (օրինակ՝ «1» Viber Bot-ի համար, «2» Telegram-ի համար)
«ամսաթիվ» «ամսաթիվ» Վերցնում է զրույցները երկու ամսաթվերի միջև (անհրաժեշտ է երկու նույնական պարամետրերի բանալիներ URL-ում): Օրինակ՝ «?ամսաթիվ=2026-01-28&ամսաթիվ=2026-01-29»
tg_user_id «ամբողջ թիվ» Telegram Օգտվողի ID
«հեռախոս» «լարային» Հեռախոսահամար
«կարգավիճակ» «ամբողջ թիվ» «0» = Նոր, «1» = Բաց, «2» = Սպասում, «3» = Ընդմիջում, «4» = Փակված
«organizationId» «ամբողջ թիվ» Կազմակերպության կողմից նեղ
«օպերատորի ID» «ամբողջ թիվ» Նեղացնել ըստ նշանակված օպերատորի

**Պատասխան (200 OK) ** 

{
  "total": 124,
  "items": [
    {
       "id": 123,
       "theme": "Support Ticket #491",
       "operator": {
           "id": 21,
           "name": "Jane",
           "photo": "url_to_photo.png"
       },
       "chatStatus": 1,
       "countUnread": 3
    }
  ]
}

2. Փոխել Զրույցի կարգավիճակը

Թարմացնում է կոնկրետ զրույցի նստաշրջանի հանձնարարված կարգավիճակը:

խնդրանք - Մեթոդ: PUT - URL: «/api/chat/status»: - Թույլտվություն. «Կրողի նշան». - Վերնագրեր. «Բովանդակության տեսակը. հավելված/json»:

** Մարմինը:** 

{
  "id": 123,
  "status": 1
}

** Կարգավիճակի թվային արժեքներ.** - 0. Նոր (նոր ձևավորված) - «1»՝ բաց (ակտիվորեն մշակվում է օպերատորի կողմից) - 2: Սպասում է (սպասում է օգտվողի պատասխանին) - «3»՝ միացված դադար (դադարեցված վիճակ) - «4»՝ փակված (արխիվացված)

3. Ջնջել զրույցը

Ընդմիշտ ջնջում է զրույցը իր եզակի ID-ի միջոցով:

խնդրանք - Մեթոդ. ՋՆՋԵԼ - URL: /api/chat/chats/{id} - Թույլտվություն. «Կրողի նշան».

**Պատասխան (200 OK) ** Վերադարձնում է HTTP «200»՝ հաջող ջնջումը հաստատելու համար: Մարմինը սովորաբար դատարկ է կամ խիստ «Լավ» է:

4. Առբերեք զրույցի հաղորդագրությունները

Հեռացնում է պատմականորեն ուղարկված և ստացված բոլոր հաղորդագրությունները որոշակի չաթում:

խնդրանք - Մեթոդ. GET - URL: /api/chat/chats/{chatId}/messages - Թույլտվություն. «Կրողի նշան».

Պատասխան (200 OK) ** 

[
  {
        "id": 1,
        "chatId": 123,
        "message": "Hello, how can I help?",
        "phone": "380936670003",
        "author": 0,
        "status": 3,
        "date": "2025-04-01T09:46:24.687Z",
        "operator": {
          "id": 21,
          "name": "Jane"
        },
        "messageType": 0
  }
]
Հեղինակներ:** - «0»՝ օպերատոր - «1»՝ հաճախորդ - 2: Համակարգի բոտ - «3»՝ Viber բիզնես հաշիվ

** Հաղորդագրության տեսակները. - 0: Տեքստ - «1»: Լուսանկար - 2: Ֆայլ

5. Թարմացրեք հաղորդագրությունների կարգավիճակը

Նշում է հաղորդագրություն (կամ մի քանի հաղորդագրություն) ակտիվ զրույցի ներսում առաքման նոր կարգավիճակներով:

խնդրանք - Մեթոդ: PUT - URL: «/api/chat/messages/status»: - Թույլտվություն. «Կրողի նշան». - Վերնագրեր. «Բովանդակության տեսակը. հավելված/json»:

** Մարմինը: 

{
  "status": 3,
  "messageIds": [1, 2, 3]
}
(«3» կարգավիճակը նշում է ուղարկված հաղորդագրության ID-ները որպես «Կարդացված»)