API құрастырушы

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/callback

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

Назар аударыңыз: қосымша беретін кез келген параметрлер айнымалыда сақталады

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

Кілтті жасау кезіндегі кіру рұқсаты: "Клиент туралы ақпаратты өзгерту/жою рұқсаты".

Жол

api key* - кіру токені

Дене

client_phone - клиентті іздеу үшін пайдаланылатын телефон нөмірі

client_email - клиентті іздеу үшін пайдаланылатын электрондық пошта

client_id - құрастырушыдағы клиент идентификаторы

message - хабарлама мәтіні

resume_bot - True (міндетті емес параметр). Егер бот тоқтатылған болса, оны қайта іске қосу үшін пайдаланылады.

Мысалы: resume_bot = True

time_shift - сан. Егер көрсетілсе, хабарлама ағымдағы уақыттан берілген секунд санынан кейін жіберіледі.

send_time - "%Y-%m-%d %H:%M:%S" форматындағы күн мен уақыт (мысалы, "2024-10-16 13:15:59"). Бұл хабарламаны жіберу күні мен уақытын орнатады. Егер time_shift және send_time екеуі де көрсетілсе, time_shift басымдыққа ие болады.

import requests
import json

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

URL сұрауы: https://chatter.mavibot.ai/api/\<api_key>/whatsapp_callback>

Бұл әдіс клиент веб-сайтта тіркелгеннен кейін немесе телефон нөмірімен сұрау жібергеннен кейін WhatsApp ботын іске қоса алады.

Ескерту: қосымша берілген кез келген параметрлер айнымалыда сақталады

Кілтті жасау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Жол

api key* - қол жеткізу токені

Дене

name - клиент аты
message - хабарлама мәтіні
phone - клиенттің телефон нөмірі
bot_id - бот идентификаторы
resume_bot - True (міндетті емес параметр). Егер бот тоқтатылған болса, оны қайта іске қосу үшін пайдаланыңыз. Мысалы: resume_bot = True

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

send_time - "%Y-%m-%d %H:%M:%S" форматындағы күн мен уақыт (мысалы, "2024-10-16 13:15:59"). Бұл хабарламаны жіберу күні мен уақытын белгілейді. Егер time_shift және send_time екеуі де көрсетілсе, time_shift басымдыққа ие болады.

URL сұрауы: https://chatter.mavibot.pro/api/#{api\_key}/tg\_callback

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

Ескерту: қосымша берілген кез келген параметрлер айнымалыларда сақталады.

Кілтті жасау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Жол

api key* - қол жеткізу токені

Дене

message - хабарлама мәтіні
user_id - Telegram пайдаланушы идентификаторы
group_id - бот атауы (bot деп аяқталады)
resume_bot - True (міндетті емес параметр). Егер бот тоқтатылған болса, оны қайта іске қосу үшін пайдаланыңыз. Мысалы: resume_bot = True

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

send_time - "%Y-%m-%d %H:%M:%S" форматындағы күн мен уақыт (мысалы, "2024-10-16 13:15:59"). Бұл хабарламаны жіберу күні мен уақытын белгілейді. Егер time_shift және send_time екеуі де көрсетілсе, time_shift басымдыққа ие болады.

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/send\_callback\_by\_platform\_id

Тізімдегі platform_id бар клиенттер жобадан табылған кезде, callback_text өрісіндегі мәтінмен кері қоңырау жіберіледі.
Шектеу: 1 сұрау = ең көбі 300 жіберу

Сұрау параметрлерінің мысалы:
{"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}

Кілтті жасау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Жол

api key* - қол жеткізу токені

Дене

platform_ids - мессенджердегі клиент идентификаторларының тізімі
callback_text - кері қоңырау мәтіні
group_id - бот идентификаторы

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

send_time - "%Y-%m-%d %H:%M:%S" форматындағы күн мен уақыт (мысалы, "2024-10-16 13:15:59"). Бұл хабарламаны жіберу күні мен уақытын белгілейді. Егер time_shift және send_time екеуі де көрсетілсе, time_shift басымдыққа ие болады.

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/email\_callback

Бұл әдіс клиент веб-сайтта тіркелгеннен кейін немесе электрондық поштасымен сұрау жібергеннен кейін электрондық пошта ботын іске қоса алады. Әдіс клиенттің электрондық поштасын табады немесе табылмаса, оны жасайды.

Кілтті жасау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Ескерту: қосымша берілген кез келген параметрлер айнымалыда сақталады

Жол

api key* - қол жеткізу токені

Дене

name - клиент аты
message - хабарлама мәтіні
email - электрондық пошта мекенжайы
email_id_bot - боттың электрондық пошта мекенжайы
resume_bot - True (міндетті емес параметр).

Егер бот тоқтатылған болса, оны қайта іске қосу үшін пайдаланыңыз. Мысалы: resume_bot = True

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

send_time - "%Y-%m-%d %H:%M:%S" форматындағы күн мен уақыт (мысалы, "2024-10-16 13:15:59"). Бұл хабарламаны жіберу күні мен уақытын белгілейді. Егер time_shift және send_time екеуі де көрсетілсе, time_shift басымдыққа ие болады.

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/message

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

Кілтті жасау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Жол

api key* - қол жеткізу токені

Дене

message_id - жіберуге арналған блок нөмірі
message - хабарлама мәтіні
client_id - құрастырушыдағы клиент идентификаторы
attachment_type - файлды көрсету түрі. Егер attachment_url берілсе, міндетті.
attachment_url - файл URL-і
buttons - түймелер

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

send_time - "%Y-%m-%d %H:%M:%S" форматындағы күн мен уақыт (мысалы, "2024-10-16 13:15:59"). Бұл хабарламаны жіберу күні мен уақытын белгілейді. Егер time_shift және send_time екеуі де көрсетілсе, time_shift басымдыққа ие болады.

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)

# Тіркеме жіберу
params = {
    "message": "some message",
    "client_id": "1234565",
    "attachment_type": "video/image/file",
    "attachment_url": "https://qwreqw"
}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# 'attachment_type' ішінде тіркеме түріне байланысты 'video', 'image' немесе 'file' көрсетіңіз:
# бейне, сурет немесе құжат.

URL сұрауы: https://chatter.mavibot.pro/api/\<api_key>/whatsapp_message>

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

Кілтті жасау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Жол

api key* - қол жеткізу токені

Дене

message_id - жіберуге арналған блок нөмірі
whatsapp_bot_id - хабарлама жіберілуі тиіс WhatsApp ботының идентификаторы
attachment_url - файл URL-і
attachment_type - файлды көрсету түрі. Егер attachment_url берілсе, міндетті.
message - хабарлама мәтіні
phone - алушының телефон нөмірі

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

send_time - "%Y-%m-%d %H:%M:%S" форматындағы күн мен уақыт (мысалы, "2024-10-16 13:15:59"). Бұл хабарламаны жіберу күні мен уақытын белгілейді. Егер time_shift және send_time екеуі де көрсетілсе, time_shift басымдыққа ие болады.

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)

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/broadcast

Бұл әдіс хабар таратуды бастауға мүмкіндік береді.

Келесі өзара алып тастайтын опциялардың біреуін пайдалануға болады:

1. list параметрі — хабар тарату көрсетілген клиенттер тізіміне жіберіледі.
2. clients параметрі — хабар тарату клиент идентификаторларының массивіне жіберіледі.
3. platform_ids және group_id параметрлері — хабар тарату көрсетілген бот (group_id) үшін platform_ids (мессенджер идентификаторлары) массивіне жіберіледі.
4. Егер жоғарыдағы параметрлердің ешқайсысы берілмесе, хабар тарату жіберілмейді.

Міндетті параметрлер: message (және/немесе attachment_type және attachment_url) немесе message_id.

Кілтті жасау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Жол

api key* - қол жеткізу токені

Дене

list - хабар тарату жіберілуі тиіс тізім нөмірі

clients - құрастырушыдағы клиент идентификаторлары

message - хабарлама мәтіні

platform_ids - мессенджердегі алушы идентификаторлары. Міндетті group_id параметрімен бірге пайдаланылуы керек

group_id - тек platform_ids пайдаланылғанда міндетті. Басқа опциялармен еленбейді. Берілген platform_ids үшін жіберуге арналған ботты көрсетеді

attachment_url - файл URL-і

attachment_type - файлды көрсету түрі. Егер attachment_url берілсе, міндетті.

buttons - түймелер

message_id - жіберуге арналған блок нөмірі

shift — хабарламалар арасындағы секунд саны. Әдепкі мәні 0.2.

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

send_time - "%Y-%m-%d %H:%M:%S" форматындағы күн мен уақыт (мысалы, "2024-10-16 13:15:59"). Бұл хабарламаны жіберу күні мен уақытын белгілейді. Егер time_shift және send_time екеуі де көрсетілсе, time_shift басымдыққа ие болады.

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)

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/get\_history?client\_id=

client_id параметрін осы жерден алуға болады. сілтеме

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты оқу рұқсаты".

Жол

api key* - қолжетімділік токені

Дене

client_id - клиент идентификаторы

limit - жауаптағы элементтер саны. Әдепкі: 2000, максимум: 2000

start_date - таңдау кезеңінің басталу күні (stop_date көрсетілсе, міндетті), пішімі: dd.mm.yyyy

stop_date - таңдау кезеңінің аяқталу күні (start_date көрсетілсе, міндетті), пішімі: dd.mm.yyyy

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "Meow meow",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true",
      "manager_id": 12486,
      "manager_email": "[email protected]"
    },
  ]
}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/clear\_history?client\_id=

Чат тарихын жояды

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту/жою рұқсаты".

Жол

api key* - қолжетімділік токені

Дене

client_id - клиент идентификаторы

import requests
import json


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

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/assign\_to\_user

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

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту/жою рұқсаты".

Жол

api key* - қолжетімділік токені

Дене

client_id - клиент идентификаторы
email - қызметкердің электрондық поштасы (міндетті емес)

import requests
import json

params = {"client_id":"#{client_id}","email":"[email protected]"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

URL сұрауы: https://chatter.mavibot.pro/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* - қолжетімділік токені

Дене

platform_id - телефон нөмірі
group_id - топ идентификаторы
client_type - клиент келген мессенджер түрі

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}]}

URL сұрауы: https://chatter.mavibot.ai/api/\<api_key>/add_to_list

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

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту немесе жою рұқсаты".

Жол

api key* - қолжетімділік токені

Дене

list_id - тізім нөмірі
clients - клиент идентификаторларының массиві

Мысал:
JSON параметрлері
{"list_id":1170282, "clients":[411262772, 646410963]}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/remove\_from\_list

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

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту немесе жою рұқсаты".

Жол

api key* - қолжетімділік токені

Дене

list_id - тізім нөмірі
clients - Mavibot конструкторындағы клиент нөмірлерінің массиві (client_id мәндері)

URL сұрауы: https://chatter.mavibot.a/aipi/\<api_key>/get_clients

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту немесе жою рұқсаты".

Жол

api key* - қолжетімділік токені

Дене

offset – Бірінші элементтен ығысу

limit – Жауаптағы элементтер саны / Әдепкі: 500, Максимум: 500

list – Тізім нөмірі

reverse – Кері сұрыптауды көрсетеді (ең ескі жазбадан ең жаңаға қарай). Бұл параметр тізім көрсетілмеген жағдайда ғана жұмыс істейді.

Күй мен элементтер массивін қайтарады.

{
"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
    }
]
}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/subscribers

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

Ескерту! Бұл әдіс айнымалыларды қайтармайды.

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту немесе жою рұқсаты".

Жол

api key* - қолжетімділік токені

Дене

page
tag – Жазылу бетінде көрсетілген тег
group – Жазылушы байланыстырылған VK тобының идентификаторы
date_from – Осы күннен кейін жазылған (timestamp)\ndate_to – Осы күнге дейін жазылған (timestamp)\nclient_type – Жазылушылар тізімін алу үшін мессенджер идентификаторы. Егер көрсетілмесе, барлық клиенттер қайтарылады

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

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/save\_variables

!** **Бұл сұрауға ешқандай шектеу қолданылмайды.

Лидте де, клиентте де айнымалыларды сақтауға мүмкіндік береді. Әдепкі бойынша, айнымалыларды тағайындау сұрауы оларды мәміле айнымалыларына қосады. Клиент профиліндегі айнымалыларды жаңарту үшін client. префиксін пайдаланыңыз. Мысалы, телефон үшін: client.phone.

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту немесе жою рұқсаты".

Жаңарту: clients параметрі айнымалыларды топтап тағайындауға мүмкіндік береді.
Мысал: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

Жол

api key* - қолжетімділік токені

Дене

clients – Айнымалыларды тағайындау үшін клиент идентификаторларының массиві

client_id – Клиент идентификаторы

variables – Айнымалылар хэші (кілт-мән жұптары)

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)

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/get\_variables?client\_id=

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту немесе жою рұқсаты".

Мысал: https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get\_variables?client\_id=49177759

Жол

api key* - қолжетімділік токені

Дене

client_id - клиент идентификаторы

import requests
import json


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

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_platform\_id

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту немесе жою рұқсаты".

Жол

api key* - қолжетімділік токені

Дене

platform_ids - мессенджердегі идентификаторлар массиві
group_id - бот идентификаторы

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"ОЛЬГА БЕЛИК",
"avatar":"https:\/\/files.mavibot.ai\/uploads\/avatars\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@belik"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"John Smith",
"avatar":"https:\/\/files.mavibot.ai\/uploads\/avatars\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@jsmith61"}
}]

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/online\_chat\_client\_id?recipient=

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

Кілтті жасау кезіндегі қолжетімділік рұқсаты: "Клиент туралы ақпаратты өзгерту немесе жою рұқсаты".

Path

api key* - access token

Body

tag - тег (клиент тегі)\nname - клиент аты\nrecipient - веб-сайттағы диалог идентификаторы

recipient қайдан алуға болады?

Оны Mavibot.ai онлайн чаты бар веб-сайттан алуға болады, MavibotAi.recipient_id қасиетін алу үшін JS пайдаланыңыз.

{ "client_id": 36553 }

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/whatsapp\_client\_id?phone=

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

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Path

api key* - access token

Body

phone - телефон нөмірі\ngroup_id - бот идентификаторы

URL сұрауы: https://chatter.mavibot.ai/api/\<api_key>/find_client_id_by_phone?phone=

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

Іздеу WhatsApp клиенттері арасында да, айнымалылар арқылы да жүргізіледі.

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Path

api key* - access token

Body

phone - телефон нөмірі

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_email?email=&#x20;

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

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Path

api key* - access token

Body

email - іздеуге арналған электрондық пошта

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_var?var=\&val=

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

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын оқу рұқсаты"

Path

api key* - access token

Body

var - іздеуге арналған айнымалы атауы\nval - айнымалы мәні\ngroup_id - топ идентификаторы\nsearch_in - мәміле айнымалыларында іздеу үшін 'order' мәнін беріңіз; жоба клиенттері үшін үш айнымалыға дейін іздейді және барлық көрсетілген айнымалылары бар клиенттер тізімін қайтарады.

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/find\_latest\_client\_id\_by\_var ?var=&val=

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

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын оқу рұқсаты"

Path

api key* - access token

Body

var - іздеуге арналған айнымалы атауы\nval - айнымалы мәні

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_var?var=\&val=

Бұл әдіс көрсетілген айнымалысы бар және көрсетілген мәні бар клиент идентификаторларының тізімін қайтарады.

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын оқу рұқсаты"

Path

api key* - access token

Body

var - іздеуге арналған айнымалы атауы\nval - айнымалы мәні

{
    // Жауап
}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_several\_vars?var=val

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын оқу рұқсаты".

Path

api key* - access token

Body

variable1 - Мән1

variable2 - Мән2

variable3 - Мән3

{
 "status":"success","client_ids":[93891114]
}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/find\_clients

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

Әдепкі бойынша, іздеу клиент айнымалылары бойынша жүргізіледі (ұсынылады): {"q": {"result": "ok", "var": "home", "var": "60"}} – клиентте барлық көрсетілген айнымалылар болуы керек

Мәміле айнымалыларында іздеу, көрсетілген айнымалылардың кем дегенде біреуі болуы керек: {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}

Клиент айнымалысының атауы тізім мәндерінің біріне тең: {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}

Клиент айнымалысының атауы тізім мәндерінің ЕШҚАЙСЫНА тең ЕМЕС: {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}

Клиент айнымалысының атауы "Joe" тең емес: {"q": {"name": {"_not": "Joe"}}}

Ескерту: Сандарды салыстыру барлық клиенттерде ізделетін айнымалыда сандық мәндер болған жағдайда ғана жұмыс істейді. Егер кем дегенде бір клиентте жол болса, сұрау сәтсіз аяқталады.

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын оқу рұқсаты"

Параметрлер

Path

api key* - access token

Body

q – міндетті параметр, айнымалыларды іздеу шарттарын қамтиды

search_in – қай нысанның айнымалыларын іздеу керектігін көрсетеді; егер көрсетілмесе, іздеу клиент айнымалылары бойынша жүргізіледі. order мәнін қабылдай алады.

include_all – q-дағы барлық шарттар орындалуы керек пе;

False – егер кем дегенде бір шарт сәйкес келсе, нысан таңдалады

Сәтті
{"status":"success","client_ids":[41203, 5622354, 785212]} 
{"status":"success","client_ids":[]} 
{"status": "fail", "message": "Parameter "q" required"} {"status": "fail", "message": "Error in parameter format"}
Қате
{"status":"fail","message":"Something went wrong"}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/get\_current\_order\_id

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "CRM ақпаратын оқу рұқсаты".

Path

api key* - access token

Body

client_id - клиент идентификаторы

Сәтті жауап: {"status":"success","order_id":40632}, мұндағы
order_id - ағымдағы мәміле идентификаторы
Қате жауап: {"status":"client_not_found"}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/get\_orders

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "CRM ақпаратын оқу рұқсаты"

Path

api key* - access token

Body

client_id - клиент идентификаторы

order_status - мәміле кезеңі: \n0 - белсенді мәмілелер\n1 - сәтті мәмілелер\n2 - сәтсіз мәмілелер

Сәтті жауап: {"status":"success","order_id":[40338,40340,40341]} 
Қате жауап: {"status":"client_not_found"}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/move\_order\_to\_next\_state

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "CRM ақпаратын өзгерту/жою рұқсаты"

Path

api key* - access token

Body

client_id - клиент идентификаторы

order_id - мәміле идентификаторы

Сәтті жауап: 
{"status":"success","state_id":37}, мұндағы 
state_id - MavibotCRM кезең идентификаторы 
Қате жауап: 
{"status":"client_not_found"}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_vars

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "CRM ақпаратын оқу рұқсаты"

Path

api key* - access token

Body

client_id - клиент идентификаторы

order_id - мәміле идентификаторы

variables - айнымалылар массиві\n(формат:["var_name1", "var_name2"])

Сәтті жауап: 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

Қате мысалы: 
{"status":"client_not_found"}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_vars

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "CRM ақпаратын өзгерту/жою рұқсаты"

Path

api key* - access token

Body

client_id - клиент идентификаторы

order_id - мәміле идентификаторы

variables - айнымалылар сөздігі (кілт - айнымалы атауы, ал мән - осы айнымалыда сақталуы керек нәрсе)\n(формат:{"var_name": "var_value"})

Сәтті жауап: {"status":"success"} 
Қате жауап: {"status":"order 12345 not found"}

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/create\_order

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "CRM ақпаратын өзгерту/жою рұқсаты"

Path

api key* - access token

Body

client_id - клиент идентификаторы

name - мәміле атауы

description - мәміле сипаттамасы

budget - мәміле сомасы

Сұрауда келесі параметрлердің біреуін көрсету керек: client_id, email немесе phone.\nБірнеше параметр берілсе, тек біреуі ғана пайдаланылады. Басымдылық тәртібі: client_id > phone > email.\nЕгер phone немесе email берілсе және бұл телефон нөмірі немесе электрондық поштасы бар клиент жоқ болса, жаңа клиент жасалады.

Сәтті жауап: {"status":"success","order_id":40654}, 
мұндағы order_id - жаңа белсенді мәміленің идентификаторы.
Қате жауап: {"status":"client_not_found"}

MavibotCRM-дегі мәмілені кезеңге жылжыту

**POST** https://chatter.mavibot.ai/api/#{api_key}/set_order_state

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_state

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "CRM ақпаратын өзгерту/жою рұқсаты"

Жол

api key* - қол жеткізу токені

Дене

client_id - клиент идентификаторы

state_id - клиенттің мәмілесі жылжытылуы тиіс кезең нөмірі

Mavibot CRM-дегі воронка кезеңінің идентификаторын алу

**GET** https://chatter.mavibot.ai/api/#{api_key}/get_order_state

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_state

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "CRM ақпаратын оқу рұқсаты"

Жол

api key* - қол жеткізу токені

Дене

client_id - клиент идентификаторы

state_id - мәміле идентификаторы (егер көрсетілмесе, әдіс ағымдағы мәміленің кезең идентификаторын қайтарады)

Сәтті жауап мысалы:
{'status': 'success', 'state_id': 123456}

Сәтсіз жауап мысалы:
{'status': 'order not found'}

Қандай қосымша мүмкіндіктер бар?

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

**GET** https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp

URL сұрауы: https://chatter.mavibot.ai/api/#{api\_key}/check\_whatsapp

Бұл әдісті пайдалану үшін Mavibot-қа WhatsApp қосылған болуы керек.

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

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

Жол

api key* - қол жеткізу токені

Дене

phone - тексерілетін телефон нөмірі

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

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

URL сұрауы: https://chatter.mavibot.ai/api/\<api_key>/connected_channels

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

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

WhatsApp үшін ол келесі мәндерге ие бола алатын status өрісін де қайтарады:

NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

Жол

api key* - қол жеткізу токені

{'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': [], 
'avito': [], 
'ok': [], 
'vkontakte': [{
        'id': 33, 
        'group': '143414131',
        'group_id': '143414131'}]
}

Бот ағынынан блоктар тізімін алу

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

URL сұрауы: https://chatter.mavibot.ai/api/\<api_key>/get_messages

Кілтті генерациялау кезіндегі қол жеткізу рұқсаты: "Клиент ақпаратын өзгерту немесе жою рұқсаты".

Жол

api key* - қол жеткізу токені

Кірістірілген клиент деректерін алу

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