Сұраулар POST әдісімен URL мекенжайына, яғни https://chatter.mavibot.ai/api/{api\_key}/{action} жіберіледі.

Ол қайда орналасқан: api_key — API-ға кіру кілті, ол жоба параметрлерінде алынады:

Кіру кілтін #{api_key} айнымалысын пайдаланып алуға болады. Ол жасалған тиісті кілтті сақтайды. Қолданар алдында оны жасауды ұмытпаңыз.

Осы беттегі сұрау URL-ін көшірген кезде, оған бос орын қойылады, оны шақырған кезде жою керек.

Сілтемені қате көшіру мысалы: https://chatter.mavibot.ai/api/callback 

.pro-дан кейінгі бос орынды байқамау оңай, бірақ ол орнында қалса, сұрау жұмыс істемейді.

GET әдісімен сұрау жіберген кезде, тыйым салынған сөздерді қолданбаңыз. GET сұрауларын дұрыс құрастыруды қараңыз.

Жоба параметрлерінде көрсетілген Webhook URL мекенжайына хабарламаларды қалай алуға болады

Жоба параметрлері

Әрбір кіріс немесе шығыс хабарлама келесі json POST сұрауларымен бірге келеді:

{
    'id': жүйедегі хабарламаның идентификаторы,
    'client': {
        'id': жүйедегі клиенттің идентификаторы,
        'recepient': мессенджердегі клиенттің идентификаторы,
        'client_type': мессенджер түрі,
        'name': клиенттің аты,
        'avatar': клиенттің аватары,
        'created_at': клиенттің жасалған күні,
        'tag': жазылу кілті,
        'group': клиент байланған бот,
    },
    'message': хабарлама мәтіні,
    'attachments': файлдарға сілтемелер массиві,
    'message_id': хабарлама жіберілген блоктың идентификаторы,
    'project_id': жобаның идентификаторы,
    'is_input': 1, егер хабарлама клиенттен болса, 0, егер боттан болса,
    'delivered': 1, егер хабарлама сәтті жіберілсе, 0, егер қате болса,
    'error_message': қатені түсіндіретін хабарлама
}

Егер сұрау қатемен қайтарылса, ол қайта жіберілмейді. Егер сервер қатемен жауап берсе, хабарландырулар бұған қарамастан келе береді.

Әмбебап вебхукты қалай пайдалануға болады

Бұл әдістерді енді POST және GET сұраулары арқылы іске қосуға болады.

Бұрын параметрлер (клиенттердің әдістері іске қосылған, яғни client_id) біздің әдістерде өте қатаң жазылған және бұл үшінші тарап қызметтерімен пайдалану кезінде кейбір шектеулерді енгізетін.

Енді сіз Mavibot пайдаланушының идентификаторын сұраудың қай параметрінен іздейтінін көрсете аласыз: бұл үшін value_ префиксі бар параметр қолданылады, мысалы value_user_id және value_group_id.

Сондай-ақ, callback кері шақыруды жіберу әдісін электрондық пошта (client_email) және клиенттің телефон нөмірі (client_phone) арқылы іске қосуға болады.

callback және whatsapp_callback әдістері параметрлердің атауларына байланбаған. Сіз қай параметрде клиенттің телефон нөмірі, электрондық поштасы және идентификаторы болатынын көрсете аласыз.

Бұл вебхукты басқа сайт арқылы қабылдауды орнату кезінде пайдалы.

Қай айнымалыда client_id бар екенін көрсету үшін value_client_id мәнін беріп, осы мәні бар параметрдің атын атау керек.

Қай айнымалыда телефон бар екенін көрсету үшін value_phone мәнін беріп, осы мәні бар параметрдің атын атау керек.

Қай айнымалыда электрондық пошта бар екенін көрсету үшін value_email мәнін беріп, осы мәні бар параметрдің атын атау керек.

Қай айнымалыда user_id бар екенін көрсету үшін value_user_id мәнін беріп, осы мәні бар параметрдің атын атау керек.

Қай айнымалыда group_id бар екенін көрсету үшін value_group_id мәнін беріп, осы мәні бар параметрдің атын атау керек.

Мысал:

Мекенжайға value_client_id = my_client деп теріңіз.

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hello world"}

Сұрау төмендегі сұрауға балама болады:

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}

Көріп отырғаныңыздай, атауды сақтайтын параметрдің атауы value_ префиксімен ерекшеленеді.

Ботты қалай іске қосуға болады

Ботты іске қосу

POST https://chatter.mavibot.ai/api/<api_key>/callback

Бұл әдіс клиент үшін жұмыс процесін іске қосу немесе үшінші тарап қызметіндегі әрекетті растау үшін пайдаланылуы мүмкін. Бұл хабарлама клиентке көрінбейді.
Қосымша берілген параметрлер айнымалыларда сақталады.
Кері шақыруды жіберу әдісін енді электрондық поштаны (client_email) немесе клиенттің телефон нөмірін (client_phone) бөлісу арқылы қосуға болады.

Жол параметрлері

Аты Түрі Сипаттама
api_key string кіру токені

Сұрау денесі

Аты Түрі Сипаттама
client_phone string клиент табылатын телефон нөмірі
client_email string клиент табылатын электрондық пошта
client_id string редактордағы клиенттің идентификаторы
message string хабарлама мәтіні

**200: OK **

import requests
import json
 
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/callback'
requests.post(url, json=params)

Ботты WhatsApp-тағы нөмір арқылы іске қосу

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback

Бұл әдіс клиент сайт арқылы тіркелгеннен кейін немесе телефон нөмірімен өтініш қалдырғаннан кейін WhatsApp-та ботты іске қосады.
Қосымша берілген параметрлер айнымалыларда сақталады.

Жол параметрлері

Аты Түрі Сипаттама
api_key string кіру токені

Сұрау денесі

Аты Түрі Сипаттама
name string клиенттің аты
message string хабарлама мәтіні
phone string клиенттің телефон нөмірі
bot_id string боттың идентификаторы

**200: OK **

{
    // Жауап
}

Ботты Telegram идентификаторы арқылы іске қосу

POST https://chatter.mavibot.ai/api/<api_key>/tg_callback

Бұл әдіс жұмыс процесін іске қосу немесе үшінші тарап сайтындағы әрекеттерді растау үшін пайдаланылуы мүмкін. Бұл хабарлама клиентке көрінбейді.

Қосымша берілген параметрлер айнымалыларда сақталады.

Жол параметрлері

Аты Түрі Сипаттама
api_key string кіру токені

Сұрау денесі

Аты Түрі Сипаттама
message string хабарлама мәтіні
user_id string Telegram-дағы пайдаланушының идентификаторы
group_id string боттың аты (bot әріптерімен аяқталуы керек)

**200: OK **

{
    // Жауап
}

Хабарламалармен қалай жұмыс істеуге болады

Хабарламаларды жіберуге арналған параметрлер

attachment_type келесі мәндерді қабылдай алады: image, video, link, file, audio
Тіркемелерді жіберу кезінде message параметрі міндетті емес.

buttons хабарламаға тіркелетін түймелерді анықтайды. Түймелердің пішімі түйменің кеңейтілген параметрлерімен салыстыруға болады. Түймелерді жіберудің екі нұсқасы мүмкін: түймелері жоқ мессенджерлердегі кеңес және онсыз.

Міне, buttons параметрінің мысалы:

"buttons": {"hint": "Бұл мәтін WhatsApp-та көрсетіледі",
 "buttons": [
    {"type": "reply", 
     "text": "Біз қандай қызметтерді ұсына аламыз", 
     "line": 0, "index_in_line": 0}, 
       
    {"type": "reply", 
     "text": "Төлем туралы ақпарат", 
     "line": 0, 
     "index_in_line": 1}, 
        
    {"type": "reply", 
     "text": "Біздің байланыс ақпаратымыз", 
     "line": 1, "index_in_line": 0}, 
        
    {"type": "reply", 
     "text": "Өтініш қалдыру", 
     "line": 1, "index_in_line": 1}
   ] 
}

Клиентке хабарлама жіберу

POST https://chatter.mavibot.ai/api/<api_key>/message

Бұл әдіс хабарландырулары бар хабарламаларды жіберу үшін пайдаланылуы мүмкін. Егер сіз файл жібермесеңіз, message параметрі міндетті. Егер жіберсеңіз, мәтін қажет емес.

Жол параметрлері

Аты Түрі Сипаттама
api_key string кіру кілті

Сұрау денесі

Аты Түрі Сипаттама
message_id string жіберу блогының нөмірі
message string хабарлама мәтіні
client_id string редактордағы клиенттің идентификаторы
attachment_type string файлды көрсету түрі
attachment_url string файлдың URL мекенжайы
buttons object түймелер

**200: OK **

import requests
import json

params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

WhatsApp-та хабарламаларды жіберу

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message

Қосылған боттың атынан көрсетілген нөмірге хабарлама жіберуге мүмкіндік береді. whatsapp_bot_id "Мессенджерлер мен чаттар" бөлімінен алынуы керек. Әрбір қосылған WhatsApp беті бірегей идентификация алады.

Жол параметрлері

Аты Түрі Сипаттама
api_key string кіру кілті

Сұрау денесі

Аты Түрі Сипаттама
message_id string жіберу блогының нөмірі
whatsapp_bot_id number хабарламаны жіберетін WhatsApp боты
attachment_url string файлдың URL мекенжайы
attachment_type string файлды көрсету түрі
message string хабарлама мәтіні
phone string алушының телефон нөмірі

**200: OK **

import requests
import json

params = {"message": "some_text", "phone": "79875146788"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/whatsapp_message'
requests.post(url, json=params)

Хабарламаларды жаппай жіберу

POST https://chatter.mavibot.ai/api/<api_key>/broadcast

Әдіс хабарламаларды таратуға мүмкіндік береді. Егер clients параметрі көрсетілмесе, хабарлама барлық пайдаланушыларға жіберіледі. Файлды немесе мәтінді жіберу қажет.

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау денесі

Атауы Түрі Сипаттамасы
message_id string жіберу блогының нөмірі
list string алушылар нөмірлерінің тізімі
shift string хабарламалар арасындағы секунд саны. Әдепкі бойынша 0.2
message string хабарлама мәтіні
clients array алушылардың идентификаторлары
attachment_type string файлды көрсету түрі
attachment_url string файлдың URL мекенжайы
buttons string батырмалар

**200: OK **

{import requests
import json

params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

Хабарлама тарихын алу

GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=

Хабарлама тарихын алу. client_id параметрін ОСЫ ЖЕРДЕН алуға болады

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау параметрлері

Атауы Түрі Сипаттамасы
client_id string клиенттің идентификаторы

**200: OK **

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "CouCou",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true"
    },
  ]
}

Хабарлама тарихын тазалау

GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау параметрлері

Атауы Түрі Сипаттамасы
client_id string клиенттің идентификаторы

**200: OK **

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/clear_history?client_id=85856'
requests.get(url)

Клиенттерді қалай бөлуге болады

Клиентті қызметкерге тағайындау

GET https://chatter.mavibot.ai/api/<api_key>/assign_to_user

Әдіс клиентті қызметкерге тағайындауға мүмкіндік береді. email параметрі міндетті емес. Егер email көрсетілмесе, жүйе алгоритмі арқылы бөлінеді

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау параметрлері

Атауы Түрі Сипаттамасы
client_id String клиенттің идентификаторы
e-mail String қызметкердің электрондық поштасы (міндетті емес)

**200: OK **

import requests
import json

params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

Клиенттерді жүйеге жүктеу

GET https://chatter.mavibot.ai/api/<api_key>/load_clients

Әдіс клиенттерді жүйеге жүктеуге мүмкіндік береді. WhatsApp клиенттерін жүктеу кезінде нөмірді @s.whatsapp.net соңымен немесе онсыз еркін бере аласыз.

Топ идентификаторын (group_id) осы жерден /api/<api_key>/connected_channels арқылы алуға болады

(егер client_type=13 (телефония) болса, онда group_id=””)

Клиент келген мессенджердің түрін (client_type) көре аласыз

Мыс.: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау денесі

Атауы Түрі Сипаттамасы
platform_id String телефон нөмірі
group_id String топ идентификаторы
client_type String клиент келген мессенджердің түрі

**200: OK **

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/load_clients'

params = [{ "platform_id": 274827917, "group_id": 169166236, "client_type":0},
{"platform_id":"[email protected]", "group_id": "1hwF7lwEjv4SKYIGFhQnBw==", "client_type": 6}]
requests.post(url, json=params)
# сәтті болған жағдайда функция әрбір элементке оның идентификаторын және қосу күйін қайтарады
# жауап мысалы
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

Клиенттерді тізімге қосу

POST https://chatter.mavibot.ai/api/<api_key>/add_to_list

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау денесі

Атауы Түрі Сипаттамасы
list_id integer тізімнің нөмірі
clients array клиенттер нөмірлерінің массиві

**200: OK **

{
    // Жауап
}

Клиенттерді тізімнен алып тастау

POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау денесі

Атауы Түрі Сипаттамасы
list_id integer тізімнің нөмірі
clients array клиенттер нөмірлерінің массиві

**200: OK **

{
    // Жауап
}

Клиенттер тізімін алу

POST https://chatter.mavibot.ai/api/<api_key>/get_clients

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау параметрлері

Атауы Түрі Сипаттамасы
offset string бірінші элементтен ығысу
limit integer жауаптағы элементтер саны. Әдепкі бойынша 500, ең көбі 500
list string тізімнің нөмірі

200: OK Элементтердің күйін және массивін қайтарады

{
"status":"success",
"clients":[{
    "id":44483,
    "platform_id":"146467928",
    "client_type":0,
    "name":null,
    "avatar":null,
    "message_id":null,
    "project_id":1,
    "created_at":1588248599,
    "updated_at":1588248599,
    "custom_answer":null,
    "tag":null,
    "group":"143414131",
    "operator_start_dialog":null
    }
]
}

Кез келген мессенджердегі жазылушылар тізімін алу

POST https://chatter.mavibot.ai/api/<api_key>/subscribers

Таңдалған мессенджердегі клиенттер туралы ақпаратты алу

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау параметрлері

Атауы Түрі Сипаттамасы
page integer
tag string жазылу бетінде көрсетілген тег
group integer жазылушы байланыстырылған топтың идентификаторы
date_from integer олар жазылғаннан кейінгі күннің timestamp мәні
date_to integer олар жазылғанға дейінгі күннің timestamp мәні
client_type integer тізімді алу қажет мессенджердің идентификаторы. егер ештеңе өзгертпесеңіз, барлық клиенттер шығады

**200: OK **

[
  {
    "id": 44886,
    "tag": null,
    "created_at": 1609867984,
    "name": "John Smith",
    "tg_id": "146467928",
    "group": "155824294",
    "variables": null
  },
  {
    "id": 44889,
    "tag": null,
    "created_at": 1609867984,
    "name": "Jane Austen",
    "tg_id": "1609867984",
    "group": "155824294",
    "variables": {
      "utm_source": "some_value"
    }
  }
]

Клиенттерді жоюға рұқсат

POST ``https://chatter.mavibot.ai/api/<api_key>/get_clients

Кілтті генерациялау кезіндегі кіру рұқсаты: “Клиенттерді жоюға рұқсат”

Параметрлер

Жол
api key* — кіру токені

Дене
client_ids — жойылатын клиент идентификаторларының тізімі. Ең көбі 500. Мысалы: [199571, 199707, 1935722]

Айнымалылармен қалай жұмыс істеу керек

Айнымалыларды тағайындау

POST https://chatter.mavibot.ai/api/<api_key>/save_variables

Қолданбада және клиентте айнымалыларды сақтауға мүмкіндік береді.
Айнымалыларды тағайындау сұрауы әдепкі бойынша транзакция айнымалыларына қосады.
Егер профильдегі айнымалыларды өзгерту қажет болса, client префиксін қосу керек.
Мыс. мобильді үшін: client.phone

clients параметрі айнымалыларды топтамамен тағайындауға мүмкіндік береді

Мыс.: {"client_id":49177759, "variables":
{"client.phone":"1234567890"}}

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау денесі

Атауы Түрі Сипаттамасы
clients array айнымалыларды тағайындауға арналған клиент идентификаторларының массиві
client_id string клиенттің идентификаторы
variables object айнымалылар хэші (кілт мәні)

**200: OK **

import requests
import json

params = {"client_id": "25554", "variables": {"var_name": "var_value"}}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/save_variables'
requests.post(url, json=params)

Айнымалыларды алу

GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру токені

Сұрау параметрлері

Атауы Түрі Сипаттамасы
client_id string клиент идентификаторы

**200: OK **

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/get_variables?client_id=85856'
requests.get(url)

client_id қалай алуға болады

platform_id мәні бойынша client_id алу

POST https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_platform_id

Бұл әдіс API сұрауларын орындау үшін клиент идентификаторын қайтарады.

Параметрлер мысалы: {"platform_ids": ["571830542", "256865200"]}

Жол параметрлері

Атауы Түрі Сипаттамасы
string кілт кіру

Сұрау денесі

Атауы Түрі Сипаттамасы
platform_ids string мессенджердегі идентификаторлар массиві

**200: OK **

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"Oscar Wilde",
"avatar":"https:\/\/files.mavibot.pro\/uploads\/avatars\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@wildeo"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"Freddie Mercury",
"avatar":"https:\/\/files.mavibot.pro\/uploads\/avatars\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@freddieisqueen"}
}]

Онлайн чатта клиент идентификаторын қалай алуға болады

GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=

Бұл әдіс сайт пен чат-ботты біріктіруге мүмкіндік береді, яғни егер адам арнайы ұсынысы бар бетке кірсе, чатта ұсыныс туралы хабарламаны лезде жіберуге болады.

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру токені

Сұрау параметрлері

Атауы Түрі Сипаттамасы
tag string клиент тегі
name string клиенттің аты
recipient string сайттағы диалог идентификаторы

**200: OK **

{ "client_id": 36553 }

Recipient-ті қайдан алуға болады? "Mavibot.ai" онлайн чатын орнатқан сайтта JS көмегімен MaviBotPro.recipient_id мүмкіндігін алу керек.

WhatsApp нөмірі бойынша клиент идентификаторын қалай алуға болады

GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=

Бұл әдіс, егер сіз клиенттің WhatsApp-тағы телефон нөмірін білсеңіз, API сұрауларын орындау үшін клиент идентификаторын қайтарады.
Егер мұндай нөмірі бар клиент болмаса, сіз 404 қатесін аласыз.

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру токені

Сұрау параметрлері

Атауы Түрі Сипаттамасы
phone string телефон нөмірі

**200: OK **

{
    // Жауап
}

Телефон нөмірі бойынша клиент идентификаторын алу

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=

Бұл әдіс API сұрауларын орындау үшін клиент идентификаторын қайтарады.
Іздеу WhatsApp клиенттері арқылы, сондай-ақ айнымалылар арқылы жүзеге асырылады.

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру токені

Сұрау параметрлері

Атауы Түрі Сипаттамасы
phone string телефон нөмірі

**200: OK **

{
    // Жауап
}

Электрондық пошта арқылы клиент идентификаторын алу

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=

Бұл әдіс API сұрауларын орындау үшін клиент идентификаторын қайтарады. Іздеу айнымалылар арқылы жүзеге асырылады.

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру токені

Сұрау параметрлері

Атауы Түрі Сипаттамасы
email string іздеуге арналған электрондық пошта

**200: OK **

{
    // Жауап
}

Айнымалы мәні бойынша клиент идентификаторын алу

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=

Бұл әдіс API сұрауларын орындау үшін клиент идентификаторын қайтарады.

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру токені

Сұрау параметрлері

Атауы Түрі Сипаттамасы
var string іздеу жүргізілетін айнымалының атауы
val string айнымалы мәні

**200: OK **

{
    // Жауап
}

Басқа қандай мүмкіндіктер бар

Мәмілені MavibotCRM күйіне ауыстыру

POST https://chatter.mavibot.ai/api/<api_key>/set_order_state

Мәміле нөмірін MavibotCRM жұмыс ағынын өңдеу терезесінде алуға болады.

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау денесі

Атауы Түрі Сипаттамасы
client_id string клиенттің идентификаторы
state_id string клиенттің мәмілесі ауыстырылатын күй нөмірі

**200: OK **

{
    // Жауап
}

Адамның Instagram аккаунтына жазылғанын тексеру

GET https://chatter.mavibot.ai/api/<api_key>/check_insta_subscription

POST әдісімен де, GET әдісімен де шақыруға болады.

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру кілті

Сұрау денесі

Атауы Түрі Сипаттамасы
user_name string тексергіңіз келетін клиенттің пайдаланушы аты
login string тексерілетін боттың логині

200: OK Адамның жазылғаны туралы ақпарат is_follower өрісінде сақталады

{
"username": "beyonce",
"account_id": "1463220603",
"avatar": "https://instagram.fhel6-1.fna.fbcdn.net/v/t51.2885-19/1060168..",
"real_name": "Beyonce",
"is_follower": true,
"status": 200
}

Телефон нөмірінде WhatsApp бар-жоғын тексеру

GET https://chatter.mavibot.ai/api/<api_key>/check_whatsapp

Әдісті пайдалану үшін WhatsApp және Mavibot қосылған болуы КЕРЕК

POST әдісімен де, GET әдісімен де шақыруға болады.
Телефон нөмірін кез келген форматта беруге болады.

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру токені

Сұрау денесі

Атауы Түрі Сипаттамасы
phone string телефон нөмірі

**200: OK **

{
    // Жауап
}

Жобаға қосылған мессенджерлер тізімін алу (group_id қоса)

GET https://chatter.mavibot.ai/api/<api_key>/connected_channels

Функция әрбір мессенджерге group_id параметрін қайтарады және клиенттерді жүктеу кезінде дәл осы параметрді беру қажет. \

WhatsApp үшін status өрісі де қайтарылады, оның мәні:
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру токені

**200: OK **

{'project_id': 1, 
'viber': [{
        'id': 14, 
        'uri': 'mavibotstage', 
        'name': 'mavibotstage', 
        'enabled': true,
        'group_id': 11}], 
'facebook': [], 
'telegram': [{
        'id': 23, 
        'short_name': 'bulls_vs_bears_bot', 
        'name': 'bulls_vs_bears_bot', 
        'enabled': true,
        'group_id': 'bulls_vs_bears_bot'}], 
'whatsapp': [] 
}

Бот схемасынан блоктар тізімін алу

GET https://chatter.mavibot.ai/api/<api_key>/get_messages

Жол параметрлері

Атауы Түрі Сипаттамасы
api_key string кіру токені

**200: OK **

{
    // Жауап
}

Қосымша әдістер қажет болса, клиенттерді қолдау қызметіне хабарласыңыз.