Pembina API

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/callback

Kaedah ini boleh digunakan untuk mencetuskan corong untuk pelanggan atau mengesahkan tindakan pada sumber luaran. Pelanggan tidak akan melihat mesej ini.

Sila ambil perhatian: sebarang parameter yang anda hantar tambahan akan disimpan dalam pembolehubah

Kaedah panggil balik kini juga boleh dicetuskan menggunakan e-mel pelanggan (client_email) atau nombor telefon pelanggan (client_phone).

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai/memadam maklumat pelanggan".

Laluan

api key* - token akses

Badan

client_phone - nombor telefon yang digunakan untuk mencari pelanggan

client_email - e-mel yang digunakan untuk mencari pelanggan

client_id - ID pelanggan dalam pembina

message - teks mesej

resume_bot - True (parameter pilihan). Jika bot dijeda, ini digunakan untuk menyambung semula.

Contoh: resume_bot = True

time_shift - nombor. Jika dinyatakan, mesej akan dihantar selepas bilangan saat yang diberikan dari masa semasa.

send_time - tarikh dan masa dalam format "%Y-%m-%d %H:%M:%S" (cth., "2024-10-16 13:15:59"). Ini menetapkan tarikh dan masa untuk menghantar mesej. Jika kedua-dua time_shift dan send_time dinyatakan, time_shift akan diutamakan.

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 request: https://chatter.mavibot.ai/api/\\<api_key>/whatsapp_callback

Kaedah ini boleh mencetuskan bot WhatsApp selepas pelanggan mendaftar di laman web atau menghantar permintaan dengan nombor telefon mereka.

Sila ambil perhatian: sebarang parameter yang anda tambah secara tambahan akan disimpan dalam pembolehubah

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

name - nama pelanggan
message - teks mesej
phone - nombor telefon pelanggan
bot_id - ID bot
resume_bot - True (parameter pilihan). Jika bot dijeda, gunakan ini untuk menyambung semula. Contoh: resume_bot = True

time_shift - nombor. Jika dinyatakan, mesej akan dihantar selepas bilangan saat yang diberikan dari masa semasa.

send_time - tarikh dan masa dalam format "%Y-%m-%d %H:%M:%S" (contohnya, "2024-10-16 13:15:59"). Ini menetapkan tarikh dan masa untuk menghantar mesej. Jika kedua-dua time_shift dan send_time dinyatakan, time_shift akan diutamakan.

URL request: https://chatter.mavibot.pro/api/#{api\\_key}/tg\\_callback

Kaedah ini boleh digunakan untuk mencetuskan corong untuk pelanggan atau mengesahkan tindakan di laman web luaran. Pelanggan tidak akan melihat mesej ini.

Sila ambil perhatian: sebarang parameter yang anda tambah secara tambahan akan disimpan dalam pembolehubah.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

message - teks mesej
user_id - ID pengguna Telegram
group_id - nama bot (berakhir dengan bot)
resume_bot - True (parameter pilihan). Jika bot dijeda, gunakan ini untuk menyambung semula. Contoh: resume_bot = True

time_shift - nombor. Jika dinyatakan, mesej akan dihantar selepas bilangan saat yang diberikan dari masa semasa.

send_time - tarikh dan masa dalam format "%Y-%m-%d %H:%M:%S" (contohnya, "2024-10-16 13:15:59"). Ini menetapkan tarikh dan masa untuk menghantar mesej. Jika kedua-dua time_shift dan send_time dinyatakan, time_shift akan diutamakan.

URL request: https://chatter.mavibot.ai/api/#{api\\_key}/send\\_callback\\_by\\_platform\\_id

Apabila pelanggan dengan platform_id daripada senarai ditemui dalam projek, panggil balik akan dihantar dengan teks dari medan callback_text.
\ Had: 1 permintaan = maksimum 300 penghantaran

Contoh parameter permintaan:
{"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

platform_ids - Senarai ID pelanggan dalam messenger
callback_text - teks panggil balik
group_id - ID bot

time_shift - nombor. Jika dinyatakan, mesej akan dihantar selepas bilangan saat yang diberikan dari masa semasa.

send_time - tarikh dan masa dalam format "%Y-%m-%d %H:%M:%S" (contohnya, "2024-10-16 13:15:59"). Ini menetapkan tarikh dan masa untuk menghantar mesej. Jika kedua-dua time_shift dan send_time dinyatakan, time_shift akan diutamakan.

URL request: https://chatter.mavibot.ai/api/#{api\\_key}/email\\_callback

Kaedah ini boleh mencetuskan bot e-mel selepas pelanggan mendaftar di laman web atau menghantar permintaan dengan e-mel mereka. Kaedah ini akan mencari e-mel pelanggan atau menciptanya jika tidak ditemui.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Sila ambil perhatian: sebarang parameter yang anda tambah secara tambahan akan disimpan dalam pembolehubah

Path

api key* - token akses

Body

name - nama pelanggan
message - teks mesej
email - alamat e-mel
email_id_bot - alamat e-mel bot
resume_bot - True (parameter pilihan).

Jika bot dijeda, gunakan ini untuk menyambung semula. Contoh: resume_bot = True

time_shift - nombor. Jika dinyatakan, mesej akan dihantar selepas bilangan saat yang diberikan dari masa semasa.

send_time - tarikh dan masa dalam format "%Y-%m-%d %H:%M:%S" (contohnya, "2024-10-16 13:15:59"). Ini menetapkan tarikh dan masa untuk menghantar mesej. Jika kedua-dua time_shift dan send_time dinyatakan, time_shift akan diutamakan.

URL permintaan: https://chatter.mavibot.ai/api/#{api\\_key}/message

Kaedah ini boleh digunakan untuk menghantar mesej pemberitahuan. Parameter mesej diperlukan melainkan anda menghantar fail. Jika anda menghantar fail, teks adalah pilihan.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

message_id - nombor blok untuk penghantaran
message - teks mesej
client_id - ID pelanggan dalam pembina
attachment_type - jenis paparan fail. Diperlukan jika attachment_url disediakan.
attachment_url - URL fail
buttons - butang

time_shift - nombor. Jika dinyatakan, mesej akan dihantar selepas bilangan saat yang diberikan dari masa semasa.

send_time - tarikh dan masa dalam format "%Y-%m-%d %H:%M:%S" (contohnya, "2024-10-16 13:15:59"). Ini menetapkan tarikh dan masa untuk menghantar mesej. Jika kedua-dua time_shift dan send_time dinyatakan, time_shift akan diutamakan.

import requests
import json

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

# Menghantar lampiran
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)

# Dalam 'attachment_type', nyatakan sama ada 'video', 'image', atau 'file'
# bergantung pada jenis lampiran: video, imej, atau dokumen.

URL permintaan: https://chatter.mavibot.pro/api/\\<api_key>/whatsapp_message

Membolehkan anda menghantar mesej bagi pihak bot yang disambungkan ke nombor yang ditentukan. whatsapp_bot_id mesti diambil dari bahagian "Messengers and chats". Setiap akaun WhatsApp yang disambungkan diberikan pengecam unik oleh pembina.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

message_id - nombor blok untuk penghantaran
whatsapp_bot_id - ID bot WhatsApp dari mana mesej harus dihantar
attachment_url - URL fail
attachment_type - jenis paparan fail. Diperlukan jika attachment_url disediakan.
message - teks mesej
phone - nombor telefon penerima

time_shift - nombor. Jika dinyatakan, mesej akan dihantar selepas bilangan saat yang diberikan dari masa semasa.

send_time - tarikh dan masa dalam format "%Y-%m-%d %H:%M:%S" (contohnya, "2024-10-16 13:15:59"). Ini menetapkan tarikh dan masa untuk menghantar mesej. Jika kedua-dua time_shift dan send_time dinyatakan, time_shift akan diutamakan.

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 request: https://chatter.mavibot.ai/api/#{api\\_key}/broadcast

Kaedah ini membolehkan anda memulakan siaran.

Anda boleh menggunakan salah satu daripada pilihan saling eksklusif berikut:

1. parameter list — siaran akan dihantar ke senarai pelanggan yang ditentukan.
2. parameter clients — siaran akan dihantar ke tatasusunan ID pelanggan.
3. parameter platform_ids dan group_id — siaran akan dihantar ke tatasusunan platform_ids (ID messenger) untuk bot yang ditentukan (group_id).
4. Jika tiada parameter di atas disediakan, siaran tidak akan dihantar.

Parameter yang diperlukan: message (dan/atau attachment_type dan attachment_url) atau message_id.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

list - nombor senarai yang mana siaran harus dihantar

clients - ID pelanggan dalam pembina

message - teks mesej

platform_ids - ID penerima dalam messenger. Mesti digunakan bersama dengan parameter group_id yang diperlukan

group_id - diperlukan hanya apabila menggunakan platform_ids. Diabaikan dengan pilihan lain. Menentukan bot untuk penghantaran ke platform_ids yang diberikan

attachment_url - URL fail

attachment_type - jenis paparan fail. Diperlukan jika attachment_url disediakan.

buttons - butang

message_id - nombor blok untuk penghantaran

shift — bilangan saat antara mesej. Lalai ialah 0.2.

time_shift - nombor. Jika dinyatakan, mesej akan dihantar selepas bilangan saat yang diberikan dari masa semasa.

send_time - tarikh dan masa dalam format "%Y-%m-%d %H:%M:%S" (contohnya, "2024-10-16 13:15:59"). Ini menetapkan tarikh dan masa untuk menghantar mesej. Jika kedua-dua time_shift dan send_time dinyatakan, time_shift akan diutamakan.

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)

Permintaan URL: https://chatter.mavibot.ai/api/#{api\_key}/get\_history?client\_id=

Parameter client_id boleh diperoleh di sini. pautan

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat pelanggan".

Laluan

api key* - token akses

Badan

client_id - ID pelanggan

limit - bilangan item dalam respons. Lalai: 2000, maksimum: 2000

start_date - tarikh mula tempoh pemilihan (diperlukan jika stop_date dinyatakan), format: dd.mm.yyyy

stop_date - tarikh tamat tempoh pemilihan (diperlukan jika start_date dinyatakan), format: 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]"
    },
  ]
}

Permintaan URL: https://chatter.mavibot.ai/api/#{api\_key}/clear\_history?client\_id=

Memadam sejarah sembang

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai/memadam maklumat pelanggan".

Laluan

api key* - token akses

Badan

client_id - ID pelanggan

import requests
import json


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

Permintaan URL: https://chatter.mavibot.ai/api/#{api\_key}/assign\_to\_user

Kaedah ini membolehkan anda menetapkan pelanggan kepada pekerja. Parameter e-mel adalah pilihan. Jika tiada e-mel diberikan, sistem akan menetapkan pelanggan mengikut algoritmanya.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai/memadam maklumat pelanggan".

Laluan

api key* - token akses

Badan

client_id - ID pelanggan
email - e-mel pekerja (pilihan)

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)

Permintaan URL: https://chatter.mavibot.pro/api/#{api\_key}/load\_clients

Kaedah ini membolehkan anda mengimport pelanggan ke dalam sistem. Semasa memuat naik pelanggan WhatsApp, anda boleh memberikan nombor dalam sebarang format, sama ada dengan pengakhiran @s.whatsapp.net atau tanpanya.

ID kumpulan (group_id) boleh diperoleh DI SINI melalui /api/<api_key>/connected_channels. (Jika client_type = 13 (telefoni), maka group_id ialah rentetan kosong: ""). pautan

Jenis utusan dari mana pelanggan datang (client_type) boleh didapati DI SINI. pautan

Contoh: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Laluan

api key* - token akses

Badan

platform_id - nombor telefon
group_id - ID kumpulan
client_type - jenis utusan dari mana pelanggan datang

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)
# jika berjaya, fungsi akan mengembalikan ID dan status penambahan untuk setiap item
# contoh respons
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

Permintaan URL: https://chatter.mavibot.ai/api/\<api_key>/add_to_list

Menambah pelanggan ke senarai

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Laluan

api key* - token akses

Badan

list_id - nombor senarai
clients - tatasusunan ID pelanggan

Contoh:
Parameter JSON
{"list_id":1170282, "clients":[411262772, 646410963]}

Permintaan URL: https://chatter.mavibot.ai/api/#{api\_key}/remove\_from\_list

Mengalih keluar pelanggan daripada senarai

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Laluan

api key* - token akses

Badan

list_id - nombor senarai
clients - tatasusunan nombor pelanggan dalam pembina Mavibot (nilai client_id)

Permintaan URL: https://chatter.mavibot.a/aipi/\<api_key>/get_clients

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Laluan

api key* - token akses

Badan

offset – Offset daripada elemen pertama

limit – Bilangan item dalam respons / Lalai: 500, Maksimum: 500

list – Nombor senarai

reverse – Menunjukkan pengisihan terbalik (daripada rekod tertua kepada yang terbaharu). Parameter ini berfungsi hanya jika senarai tidak dinyatakan.

Mengembalikan status dan tatasusunan item.

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

Permintaan URL: https://chatter.mavibot.ai/api/#{api\_key}/subscribers

Mendapatkan maklumat pelanggan daripada utusan yang dipilih.

Nota! Kaedah ini tidak mengembalikan pembolehubah.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Laluan

api key* - token akses

Badan

page
tag – Tag yang dinyatakan pada halaman langganan
group – ID kumpulan VK yang dikaitkan dengan pelanggan
date_from – Dilanggan selepas tarikh ini (timestamp)
date_to – Dilanggan sebelum tarikh ini (timestamp)
client_type – ID utusan yang mana senarai pelanggan akan diambil. Jika tidak dinyatakan, semua pelanggan akan dikembalikan

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

Permintaan URL: https://chatter.mavibot.ai/api/#{api\_key}/save\_variables

!** **Tiada had dikenakan pada permintaan ini.

Membolehkan anda menyimpan pembolehubah dalam kedua-dua petunjuk dan pelanggan.
Secara lalai, permintaan penetapan pembolehubah menambahkannya ke pembolehubah urusan.
Untuk mengemas kini pembolehubah dalam profil pelanggan, gunakan awalan client. Contohnya, untuk telefon: client.phone.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Kemas kini: Parameter clients membolehkan penetapan pembolehubah secara pukal.
Contoh: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

Laluan

api key* - token akses

Badan

clients – Tatasusunan ID pelanggan untuk penetapan pembolehubah

client_id – ID pelanggan

variables – Hash pembolehubah (pasangan kunci-nilai)

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)

Permintaan URL: https://chatter.mavibot.ai/api/#{api\_key}/get\_variables?client\_id=

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Contoh: https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get\_variables?client\_id=49177759

Laluan

api key* - token akses

Badan

client_id - ID pelanggan

import requests
import json


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

Permintaan URL: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_platform\_id

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Laluan

api key* - token akses

Badan

platform_ids - Tatasusunan ID dalam utusan
group_id - ID bot

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

Permintaan URL: https://chatter.mavibot.ai/api/#{api\_key}/online\_chat\_client\_id?recipient=

Kaedah ini membolehkan anda menyepadukan laman web dengan bot sembang. Contohnya, jika pengguna melawati halaman promosi, anda boleh segera menghantar mesej dalam sembang dengan tawaran yang diperibadikan.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

tag - tag (tag pelanggan)\nname - nama pelanggan\nrecipient - ID dialog di laman web

Di mana untuk mendapatkan recipient?

Anda boleh mendapatkannya di laman web dengan sembang dalam talian Mavibot.ai, gunakan JS untuk mendapatkan sifat MavibotAi.recipient_id.

{ "client_id": 36553 }

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/whatsapp\_client\_id?phone=

Kaedah ini mengembalikan ID pelanggan untuk membuat permintaan API jika anda mengetahui nombor telefon WhatsApp pelanggan.
Jika tiada pelanggan wujud dengan nombor tersebut, kaedah akan mengembalikan ralat 404.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

phone - nombor telefon\ngroup_id - ID bot

URL permintaan: https://chatter.mavibot.ai/api/\<api_key>/find_client_id_by_phone?phone=

Kaedah ini mengembalikan ID pelanggan untuk membuat permintaan API.

Carian dilakukan di kalangan pelanggan WhatsApp dan melalui pemboleh ubah.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

phone - nombor telefon

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_email?email=&#x20;

Kaedah ini mengembalikan ID pelanggan untuk membuat permintaan API.
Carian dilakukan menggunakan pemboleh ubah.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Path

api key* - token akses

Body

email - e-mel untuk carian

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_var?var=\&val=

Kaedah ini mengembalikan ID pelanggan untuk membuat permintaan API.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat pelanggan"

Path

api key* - token akses

Body

var - nama pemboleh ubah untuk dicari
val - nilai pemboleh ubah
group_id - ID kumpulan
search_in - hantar nilai 'order' untuk mencari dalam pemboleh ubah urusan; mencari sehingga tiga pemboleh ubah untuk pelanggan projek dan mengembalikan senarai pelanggan yang mempunyai semua pemboleh ubah yang ditentukan.

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/find\_latest\_client\_id\_by\_var ?var=&val=

Kaedah ini mengembalikan ID pelanggan yang paling baru dibuat untuk membuat permintaan API. Ia mencari kedua-dua pemboleh ubah pelanggan dan urusan.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat pelanggan"

Path

api key* - token akses

Body

var - nama pemboleh ubah untuk dicari
val - nilai pemboleh ubah

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_var?var=\&val=

Kaedah ini mengembalikan senarai ID pelanggan yang mempunyai pemboleh ubah yang ditentukan dengan nilai yang ditentukan.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat pelanggan"

Path

api key* - token akses

Body

var - nama pemboleh ubah untuk dicari
val - nilai pemboleh ubah

{
    // Respons
}

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_several\_vars?var=val

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat pelanggan".

Path

api key* - token akses

Body

pembolehubah1 - Nilai1

pembolehubah2 - Nilai2

pembolehubah3 - Nilai3

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

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/find\_clients

Kaedah ini mencari mengikut pemboleh ubah dan mengembalikan senarai ID pelanggan yang memenuhi syarat pertanyaan.

Secara lalai, carian dilakukan pada pemboleh ubah pelanggan (disyorkan): {"q": {"result": "ok", "var": "home", "var": "60"}} – pelanggan mesti mempunyai semua pemboleh ubah yang ditentukan

Cari dalam pemboleh ubah urusan, sekurang-kurangnya satu daripada pemboleh ubah yang ditentukan mesti ada: {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}

Nama pemboleh ubah pelanggan sama dengan salah satu nilai senarai: {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}

Nama pemboleh ubah pelanggan TIDAK sama dengan mana-mana nilai senarai: {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}

Nama pemboleh ubah pelanggan tidak sama dengan "Joe": {"q": {"name": {"_not": "Joe"}}}

Nota: Perbandingan nombor hanya berfungsi jika semua pelanggan mempunyai nilai angka dalam pemboleh ubah yang dicari. Jika walaupun seorang pelanggan mempunyai rentetan, permintaan akan gagal.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat pelanggan"

Parameter

Path

api key* - token akses

Body

q – parameter wajib, mengandungi syarat pertanyaan untuk mencari pemboleh ubah

search_in – menentukan entiti mana pemboleh ubahnya untuk dicari; jika tidak disediakan, carian dilakukan pada pemboleh ubah pelanggan. Boleh mengambil nilai order.

include_all – sama ada semua syarat dalam q mesti dipenuhi;

False – jika sekurang-kurangnya satu syarat sepadan, entiti dipilih

Berjaya
{"status":"success","client_ids":[41203, 5622354, 785212]} 
{"status":"success","client_ids":[]} 
{"status": "fail", "message": "Parameter "q" required"} {"status": "fail", "message": "Error in parameter format"}
Ralat
{"status":"fail","message":"Something went wrong"}

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/get\_current\_order\_id

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat CRM".

Path

api key* - token akses

Body

client_id - ID pelanggan

Respons berjaya: {"status":"success","order_id":40632}, di mana
order_id - ID urusan semasa
Respons ralat: {"status":"client_not_found"}

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/get\_orders

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat CRM"

Path

api key* - token akses

Body

client_id - ID pelanggan

order_status - peringkat urusan:
0 - urusan aktif
1 - urusan berjaya
2 - urusan tidak berjaya

Respons berjaya: {"status":"success","order_id":[40338,40340,40341]} 
Respons ralat: {"status":"client_not_found"}

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/move\_order\_to\_next\_state

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai/memadam maklumat CRM"

Path

api key* - token akses

Body

client_id - ID pelanggan

order_id - ID urusan

Respons berjaya: 
{"status":"success","state_id":37}, di mana 
state_id - ID peringkat dalam MavibotCRM 
Respons ralat: 
{"status":"client_not_found"}

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_vars

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat CRM"

Path

api key* - token akses

Body

client_id - ID pelanggan

order_id - ID urusan

variables - tatasusunan pemboleh ubah
(format:["var_name1", "var_name2"])

Respons berjaya: 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

Contoh ralat: 
{"status":"client_not_found"}

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_vars

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai/memadam maklumat CRM"

Path

api key* - token akses

Body

client_id - ID pelanggan

order_id - ID urusan

variables - Kamus pemboleh ubah (kunci adalah nama pemboleh ubah, dan nilai adalah apa yang harus disimpan dalam pemboleh ubah itu)
(format:{"var_name": "var_value"})

Respons berjaya: {"status":"success"} 
Respons ralat: {"status":"order 12345 not found"}

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/create\_order

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai/memadam maklumat CRM"

Path

api key* - token akses

Body

client_id - ID pelanggan

name - nama urusan

description - penerangan urusan

budget - jumlah urusan

Anda mesti menentukan salah satu parameter berikut dalam permintaan: client_id, email, atau phone.
Jika berbilang parameter disediakan, hanya satu akan digunakan. Keutamaan adalah: client_id > phone > email.
Jika phone atau email disediakan dan tiada pelanggan wujud dengan nombor telefon atau e-mel tersebut, pelanggan baru akan dibuat.

Respons berjaya: {"status":"success","order_id":40654}, 
di mana order_id ialah ID urusan aktif baharu.
Respons ralat: {"status":"client_not_found"}

Pindahkan tawaran ke peringkat dalam MavibotCRM

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

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_state

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai/memadam maklumat CRM"

Laluan

api key* - token akses

Badan

client_id - ID pelanggan

state_id - nombor peringkat yang sepatutnya dipindahkan tawaran pelanggan

Dapatkan ID peringkat corong dalam Mavibot CRM

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

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_state

Kebenaran akses semasa menjana kunci: "Kebenaran untuk membaca maklumat CRM"

Laluan

api key* - token akses

Badan

client_id - ID pelanggan

state_id - ID tawaran (jika tidak dinyatakan, kaedah akan mengembalikan ID peringkat tawaran semasa)

Contoh respons berjaya:
{'status': 'success', 'state_id': 123456}

Contoh respons tidak berjaya:
{'status': 'order not found'}

Apakah keupayaan lain yang tersedia?

Semak sama ada nombor telefon mempunyai WhatsApp

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

URL permintaan: https://chatter.mavibot.ai/api/#{api\_key}/check\_whatsapp

Untuk menggunakan kaedah ini, WhatsApp mesti disambungkan ke Mavibot.

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Boleh dipanggil menggunakan sama ada GET atau POST.
Nombor telefon boleh diberikan dalam sebarang format.

Laluan

api key* - token akses

Badan

phone - nombor telefon untuk diperiksa

Dapatkan senarai utusan yang disambungkan ke projek

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

URL permintaan: https://chatter.mavibot.ai/api/\<api_key>/connected_channels

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Fungsi mengembalikan parameter group_id untuk setiap utusan, yang mesti digunakan semasa mengimport pelanggan.

Untuk WhatsApp, ia juga mengembalikan medan status, yang boleh mempunyai nilai berikut:

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

Laluan

api key* - token akses

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

Dapatkan senarai blok dari aliran bot

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

URL permintaan: https://chatter.mavibot.ai/api/\<api_key>/get_messages

Kebenaran akses semasa menjana kunci: "Kebenaran untuk mengubah suai atau memadam maklumat pelanggan".

Laluan

api key* - token akses

Dapatkan data pelanggan bersarang

Jika anda memerlukan kaedah tambahan, sila hubungi sokongan.