- Cara mendapatkan mesej pada URL Webhook yang ditentukan dalam tetapan projek
- Cara menggunakan webhook universal
- Cara melancarkan bot
- Cara bekerja dengan mesej
- Cara mengedarkan pelanggan
- Cara bekerja dengan pemboleh ubah
- Cara mendapatkan client_id
- Apakah kemungkinan lain yang ada
Permintaan dijalankan dengan kaedah POST pada URL iaitu https://chatter.mavibot.ai/api/{api\\_key}/{action}
Di mana ia terletak: api_key ialah kunci untuk mengakses API yang diperoleh dalam tetapan projek:

Anda boleh mendapatkan kunci akses dengan menggunakan pemboleh ubah #{api_key}. Ia memegang kunci yang dijana yang berkaitan. Jangan lupa untuk menjana satu sebelum menggunakannya.
Apabila menyalin url pertanyaan dari halaman ini, satu ruang diletakkan yang perlu dipadamkan semasa memanggil
Contoh menyalin pautan dengan cara yang salah: https://chatter.mavibot.ai/api/callback 
Ruang selepas .pro mudah untuk tidak disedari tetapi jika dibiarkan di tempatnya, pertanyaan tidak akan berfungsi
Semasa menghantar permintaan dengan kaedah GET, jangan gunakan perkataan yang dilarang. Lihat pembentukan permintaan GET yang betul
Cara mendapatkan mesej pada URL Webhook yang ditentukan dalam tetapan projek

Setiap mesej masuk atau keluar datang dengan permintaan json POST berikut:
{
'id': pengecam mesej dalam sistem,
'client': {
'id': pengecam pelanggan dalam sistem,
'recepient': pengecam pelanggan dalam utusan,
'client_type': jenis utusan,
'name': nama pelanggan,
'avatar': avatar pelanggan,
'created_at': tarikh pelanggan dicipta,
'tag': kunci langganan,
'group': bot yang pelanggan diikat,
},
'message': teks mesej,
'attachments': tatasusunan pautan ke fail,
'message_id': id blok dari mana mesej dihantar,
'project_id': id projek,
'is_input': 1 jika mesej daripada pelanggan, 0 jika daripada bot,
'delivered': 1 jika mesej dihantar berjaya, 0 jika terdapat ralat,,
'error_message': mesej yang menerangkan ralat
}
Jika permintaan kembali dengan ralat, ia tidak akan dihantar semula. Jika pelayan kembali dengan ralat, pemberitahuan akan tetap datang walaupun ini.
Cara menggunakan webhook universal
Kaedah ini kini boleh dilancarkan dengan kedua-dua permintaan POST dan GET.
Sebelum ini, parameter (dengan mana kaedah pelanggan dilancarkan, iaitu client_id) ditulis dengan sangat ketat dalam kaedah kami dan ia akan melaksanakan beberapa sekatan apabila menggunakannya dengan perkhidmatan pihak ketiga.
Kini anda boleh menunjukkan dalam parameter permintaan yang mana Mavibot akan mencari pengecam pengguna: untuk ini, parameter dengan awalan value_ digunakan, seperti value_user_id dan value_group_id.
Juga kaedah untuk menghantar panggilan balik callback boleh dilancarkan dengan menghantar e-mel (client_email) dan nombor telefon pelanggan (client_phone).
Kaedah callback dan whatsapp_callback tidak terikat dengan nama parameter. Anda boleh menentukan parameter mana yang akan memegang nombor telefon, e-mel dan id pelanggan.
Ia berguna apabila anda menyediakan penerimaan webhook melalui laman web lain.
Untuk menentukan pemboleh ubah mana yang memegang client_id anda perlu memindahkan value_client_id dan sebutkan nama parameter dengan nilai ini di dalamnya
Untuk menentukan pemboleh ubah mana yang memegang telefon anda perlu memindahkan value_phone dan sebutkan nama parameter dengan nilai ini di dalamnya
Untuk menentukan pemboleh ubah mana yang memegang e-mel anda perlu memindahkan value_email dan sebutkan nama parameter dengan nilai ini di dalamnya
Untuk menentukan pemboleh ubah mana yang memegang user_id anda perlu memindahkan value_user_id dan sebutkan nama parameter dengan nilai ini di dalamnya
Untuk menentukan pemboleh ubah mana yang memegang group_id anda perlu memindahkan value_group_id dan sebutkan nama parameter dengan nilai ini di dalamnya
Contoh:
Taipkan alamat value_client_id = my_client
https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hello world"}
Pertanyaan akan setara dengan pertanyaan di bawah:
https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}
Seperti yang anda lihat, nama parameter yang memegang nama dibezakan oleh awalan value_
Cara melancarkan bot
Pelancaran bot
POST https://chatter.mavibot.ai/api/<api_key>/callback
Kaedah ini boleh digunakan untuk melancarkan aliran kerja untuk pelanggan atau untuk meluluskan tindakan pada perkhidmatan pihak ketiga. Mesej ini tidak akan kelihatan kepada pelanggan.
Parameter yang dipindahkan tambahan disimpan dalam pemboleh ubah.
Kaedah untuk menghantar panggilan balik kini boleh dihidupkan dengan berkongsi e-mel (client_email) atau nombor telefon pelanggan (client_phone)
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| client_phone | string | nombor telefon yang digunakan untuk mencari pelanggan |
| client_email | string | e-mel yang digunakan untuk mencari pelanggan |
| client_id | string | id pelanggan dalam penyunting |
| message | string | teks mesej |
**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)
Melancarkan bot melalui nombor di WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
Kaedah ini melancarkan bot di WhatsApp selepas pelanggan mendaftar melalui laman web atau selepas mereka meninggalkan permintaan dengan nombor telefon mereka
Parameter yang dipindahkan tambahan disimpan ke pemboleh ubah
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| name | string | nama pelanggan |
| message | string | teks mesej |
| phone | string | nombor telefon pelanggan |
| bot_id | string | id bot |
**200: OK **
{
// Response
}
Pelancaran bot melalui id Telegram
POST https://chatter.mavibot.ai/api/<api_key>/tg_callback
Kaedah ini boleh digunakan untuk melancarkan aliran kerja atau mengesahkan tindakan di laman web pihak ketiga. Mesej ini tidak akan kelihatan kepada pelanggan.
Parameter yang dipindahkan tambahan disimpan ke pemboleh ubah
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| message | string | teks mesej |
| user_id | string | id pengguna dalam Telegram |
| group_id | string | nama bot (mesti berakhir dengan bot) |
**200: OK **
{
// Response
}
Cara bekerja dengan mesej
Parameter untuk menghantar mesej
attachment_type boleh mengambil nilai ini: image, video, link, file, audio
Semasa menghantar lampiran, parameter message tidak wajib
buttons mengenal pasti butang yang akan dilampirkan pada mesej. Format butang adalah setanding dengan tetapan lanjutan butang. Dua varian penghantaran butang adalah mungkin: satu dengan petunjuk dalam utusan tanpa butang dan satu tanpanya
Berikut adalah contoh parameter butang:
"buttons": {"hint": "Teks ini akan ditunjukkan di Whatsapp",
"buttons": [
{"type": "reply",
"text": "Perkhidmatan apa yang boleh kami sediakan",
"line": 0, "index_in_line": 0},
{"type": "reply",
"text": "Maklumat pembayaran",
"line": 0,
"index_in_line": 1},
{"type": "reply",
"text": "Maklumat hubungan kami",
"line": 1, "index_in_line": 0},
{"type": "reply",
"text": "Tinggalkan permohonan",
"line": 1, "index_in_line": 1}
]
}
Menghantar mesej kepada pelanggan
POST https://chatter.mavibot.ai/api/<api_key>/message
Kaedah ini boleh digunakan untuk menghantar mesej dengan pemberitahuan. Parameter message adalah wajib jika anda tidak menghantar fail. Jika ya, maka teks tidak diperlukan
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| message_id | string | nombor blok penghantaran |
| message | string | teks mesej |
| client_id | string | id pelanggan dalam penyunting |
| attachment_type | string | jenis paparan fail |
| attachment_url | string | URL fail |
| buttons | object | butang |
**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)
Menghantar mesej di WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message
Membolehkan menghantar mesej dari nama bot yang disambungkan ke nombor yang disebut whatsapp_bot_id perlu diambil dari bahagian "Utusan dan sembang". Setiap halaman WhatsApp yang disambungkan mendapat pengenalan unik
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| message_id | string | nombor blok penghantaran |
| whatsapp_bot_id | number | bot WhatsApp yang menghantar mesej |
| attachment_url | string | url fail |
| attachment_type | string | jenis paparan fail |
| message | string | teks mesej |
| phone | string | nombor telefon penerima |
**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)
Menghantar mesej secara pukal
POST https://chatter.mavibot.ai/api/<api_key>/broadcast
Kaedah ini membolehkan pengedaran mesej. Jika param clients tidak disebut, siaran akan dihantar kepada semua pengguna. Adalah perlu sama ada menghantar fail atau teks
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| message_id | string | nombor blok penghantaran |
| list | string | senarai nombor penerima |
| shift | string | jumlah saat antara mesej. 0.2 secara lalai |
| message | string | teks mesej |
| clients | array | id penerima |
| attachment_type | string | jenis paparan fail |
| attachment_url | string | URL fail |
| buttons | string | butang |
**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)
Mendapatkan sejarah mesej
GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=
Mendapatkan sejarah mesej. Anda boleh mendapatkan param client_id DI SINI
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| client_id | string | id pelanggan |
**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"
},
]
}
Membersihkan sejarah mesej
GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| client_id | string | id pelanggan |
**200: OK **
import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/clear_history?client_id=85856'
requests.get(url)
Cara mengedarkan pelanggan
Menetapkan pelanggan kepada pekerja
GET https://chatter.mavibot.ai/api/<api_key>/assign_to_user
Kaedah ini membolehkan menetapkan pelanggan kepada pekerja. Parameter e-mel adalah pilihan. Jika e-mel tidak diberikan, ia akan diedarkan melalui algoritma sistem
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| client_id | String | id pelanggan |
| String | e-mel pekerja (pilihan) |
**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)
Memuatkan pelanggan ke dalam sistem
GET https://chatter.mavibot.ai/api/<api_key>/load_clients
Kaedah ini membolehkan memuatkan pelanggan ke dalam sistem. Semasa memuat naik pelanggan WhatsApp, anda boleh memindahkan nombor secara bebas dengan @s.whatsapp.net di hujung atau tanpanya.
Anda boleh mendapatkan id kumpulan (group_id) di sini melalui /api/<api_key>/connected_channels
(jika client_type=13 (telefoni) maka group_id=””)
Anda boleh melihat jenis utusan dari mana pelanggan datang (client_type)
Cth.: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| platform_id | String | nombor telefon |
| group_id | String | id kumpulan |
| client_type | String | jenis utusan dari mana pelanggan datang |
**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)
# in case of success the function returns each element its id and addition status
# answer example
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}
Menambah pelanggan ke senarai
POST https://chatter.mavibot.ai/api/<api_key>/add_to_list
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| list_id | integer | nombor senarai |
| clients | array | tatasusunan nombor pelanggan |
**200: OK **
{
// Response
}
Mengeluarkan pelanggan dari senarai
POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| list_id | integer | nombor senarai |
| clients | array | tatasusunan nombor pelanggan |
**200: OK **
{
// Response
}
Mendapatkan senarai pelanggan
POST https://chatter.mavibot.ai/api/<api_key>/get_clients
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| offset | string | offset dari elemen pertama |
| limit | integer | jumlah elemen dalam jawapan. 500 secara lalai, maks. 500 |
| list | string | nombor senarai |
200: OK Mengembalikan status dan tatasusunan elemen
{
"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
}
]
}
Mendapatkan senarai pelanggan dalam mana-mana utusan
POST https://chatter.mavibot.ai/api/<api_key>/subscribers
Mendapatkan maklumat tentang pelanggan dalam utusan yang dipilih
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| page | integer | |
| tag | string | tag yang disebut pada halaman langganan |
| group | integer | id kumpulan yang pelanggan diikat |
| date_from | integer | cap masa tarikh selepas mereka melanggan |
| date_to | integer | cap masa tarikh mereka melanggan sehingga |
| client_type | integer | id utusan yang anda perlukan untuk sub senarai. jika anda tidak mengubah apa-apa, semua pelanggan muncul |
**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"
}
}
]
Kebenaran untuk memadam pelanggan
POST ``https://chatter.mavibot.ai/api/<api_key>/get_clients
Kebenaran akses semasa menjana kunci: "Kebenaran untuk memadam pelanggan"
Parameter
Laluan
api key* — token akses
Badan
client_ids — senarai ID pelanggan yang akan dipadam. Maksimum 500. Contoh: [199571, 199707, 1935722]
Cara bekerja dengan pemboleh ubah
Mengatributkan pemboleh ubah
POST https://chatter.mavibot.ai/api/<api_key>/save_variables
Membolehkan menyimpan pemboleh ubah dalam aplikasi dan dalam pelanggan.
Permintaan mengatributkan pemboleh ubah secara lalai menambah kepada pemboleh ubah transaksi.
Jika anda perlu menukar pemboleh ubah dalam profil, anda perlu menambah awalan client.
Cth. untuk mudah alih: client.phone
Param clients membolehkan mengatributkan pemboleh ubah secara pukal
Cth.: {"client_id":49177759, "variables":
{"client.phone":"1234567890"}}
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| clients | array | tatasusunan id pelanggan untuk menetapkan pemboleh ubah |
| client_id | string | id pelanggan |
| variables | object | hash pemboleh ubah (nilai kunci) |
**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)
Mendapatkan pemboleh ubah
GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| client_id | string | id pelanggan |
**200: OK **
import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/get_variables?client_id=85856'
requests.get(url)
Cara mendapatkan client_id
Mendapatkan client_id dengan nilai platform_id
POST https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_platform_id
Kaedah ini mengembalikan id pelanggan untuk melaksanakan permintaan ke API
Contoh parameter: {"platform_ids": ["571830542", "256865200"]}
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| platform_ids | string | tatasusunan id dalam utusan |
**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"}
}]
Cara mendapatkan id pelanggan di Sembang Dalam Talian
GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=
Kaedah ini membolehkan untuk mengintegrasikan laman web dan chatbot, iaitu jika seseorang pergi ke halaman dengan tawaran khas, anda boleh menghantar serta-merta mesej tentang tawaran dalam sembang
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| tag | string | tag pelanggan |
| name | string | nama pelanggan |
| recipient | string | id dialog di laman web |
**200: OK **
{ "client_id": 36553 }
Di manakah anda mendapatkan penerima? Di laman web yang membawa sembang dalam talian "Mavibot.ai" anda perlu mendapatkan ciri MaviBotPro.recipient_id dengan bantuan JS.

Cara mendapatkan id pelanggan dengan nombor WhatsApp
GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=
Kaedah ini memberikan id pelanggan untuk melaksanakan permintaan ke API jika anda mengetahui nombor telefon pelanggan di WhatsApp.
Jika tiada pelanggan sedemikian dengan nombor ini, anda akan mendapat 404.
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| phone | string | nombor telefon |
**200: OK **
{
// Response
}
Mendapatkan id pelanggan dengan nombor telefon
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
Kaedah ini memberikan id pelanggan untuk melaksanakan permintaan ke API.
Pencarian berlaku melalui pelanggan WhatsApp, serta melalui pemboleh ubah.
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| phone | string | nombor telefon |
**200: OK **
{
// Response
}
Mendapatkan id pelanggan melalui e-mel
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=
Kaedah ini memberikan id pelanggan untuk melaksanakan permintaan ke API. Pencarian berlaku melalui pemboleh ubah.
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| string | e-mel untuk carian |
**200: OK **
{
// Response
}
Mendapatkan id pelanggan dengan nilai pemboleh ubah
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=
Kaedah ini memberikan id pelanggan untuk melaksanakan permintaan ke API
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Parameter Pertanyaan
| Nama | Jenis | Penerangan |
|---|---|---|
| var | string | nama pemboleh ubah yang carian akan diteruskan |
| val | string | nilai pemboleh ubah |
**200: OK **
{
// Response
}
Apakah kemungkinan lain yang ada
Memindahkan transaksi ke dalam keadaan MavibotCRM
POST https://chatter.mavibot.ai/api/<api_key>/set_order_state
Nombor transaksi boleh diperoleh dalam tetingkap penyuntingan aliran kerja MavibotCRM.
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| client_id | string | id pelanggan |
| state_id | string | nombor keadaan untuk memindahkan transaksi pelanggan ke dalam |
**200: OK **
{
// Response
}
Menyemak sama ada orang itu mengikuti akaun Instagram
GET https://chatter.mavibot.ai/api/<api_key>/check_insta_subscription
Boleh dipanggil dengan kedua-dua kaedah POST dan kaedah GET
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | kunci akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| user_name | string | nama pengguna pelanggan yang anda mahu semak |
| login | string | log masuk bot yang sedang disemak |
200: OK Medan is_follower adalah yang memegang maklumat sama ada orang itu mengikutinya atau tidak
{
"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
}
Menyemak sama ada nombor telefon membawa WhatsApp
GET https://chatter.mavibot.ai/api/<api_key>/check_whatsapp
Untuk menggunakan kaedah ini, anda MESTI mempunyai WhatsApp dan Mavibot yang disambungkan
Boleh dipanggil dengan kedua-dua kaedah POST dan kaedah GET
Nombor telefon boleh dipindahkan dalam sebarang format
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
Badan Permintaan
| Nama | Jenis | Penerangan |
|---|---|---|
| phone | string | nombor telefon |
**200: OK **
{
// Response
}
Mendapatkan senarai utusan yang disambungkan ke projek (termasuk group_id)
GET https://chatter.mavibot.ai/api/<api_key>/connected_channels
Fungsi ini mengembalikan parameter group_id kepada setiap utusan dan itulah yang perlu dipindahkan semasa memuatkan pelanggan
Medan status juga kembali untuk WhatsApp, dan ia memegang nilai:
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
**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': []
}
Mendapatkan senarai blok dari skema bot
GET https://chatter.mavibot.ai/api/<api_key>/get_messages
Parameter Laluan
| Nama | Jenis | Penerangan |
|---|---|---|
| api_key | string | token akses |
**200: OK **
{
// Response
}
Jika anda memerlukan kaedah tambahan, sila hubungi sokongan pelanggan