ตัวสร้าง API

URL คำขอ: https://chatter.mavibot.ai/api/#{api\_key}/callback

เมธอดนี้สามารถใช้เพื่อทริกเกอร์ฟันเนลสำหรับลูกค้าหรือยืนยันการดำเนินการบนทรัพยากรภายนอก ลูกค้าจะไม่เห็นข้อความนี้

โปรดทราบ: พารามิเตอร์ใดๆ ที่คุณส่งเพิ่มเติมจะถูกบันทึกในตัวแปร

เมธอด callback สามารถทริกเกอร์ได้โดยใช้อีเมลของลูกค้า (client_email) หรือหมายเลขโทรศัพท์ (client_phone)

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไข/ลบข้อมูลลูกค้า"

เส้นทาง

api key* - โทเค็นการเข้าถึง

เนื้อหา

client_phone - หมายเลขโทรศัพท์ที่ใช้ค้นหาลูกค้า

client_email - อีเมลที่ใช้ค้นหาลูกค้า

client_id - ID ลูกค้าใน builder

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

เมธอดนี้สามารถเรียกใช้บอท WhatsApp หลังจากที่ลูกค้าลงทะเบียนบนเว็บไซต์หรือส่งคำขอพร้อมหมายเลขโทรศัพท์

โปรดทราบ: พารามิเตอร์ใดๆ ที่คุณส่งเพิ่มเติมจะถูกบันทึกในตัวแปร

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

name - ชื่อลูกค้า
message - ข้อความ
phone - หมายเลขโทรศัพท์ลูกค้า
bot_id - 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 request: https://chatter.mavibot.pro/api/#{api\\_key}/tg\\_callback

เมธอดนี้สามารถใช้เพื่อเรียกใช้ฟันเนลสำหรับลูกค้าหรือยืนยันการดำเนินการบนเว็บไซต์ภายนอก ลูกค้าจะไม่เห็นข้อความนี้

โปรดทราบ: พารามิเตอร์ใดๆ ที่คุณส่งเพิ่มเติมจะถูกบันทึกในตัวแปร

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

message - ข้อความ
user_id - 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 request: 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"}

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

platform_ids - รายการ ID ลูกค้าในเมสเซนเจอร์
callback_text - ข้อความตอบกลับ
group_id - ID บอท

time_shift - ตัวเลข หากระบุ ข้อความจะถูกส่งหลังจากจำนวนวินาทีที่กำหนดจากเวลาปัจจุบัน

send_time - วันที่และเวลาในรูปแบบ "%Y-%m-%d %H:%M:%S" (เช่น "2024-10-16 13:15:59") ค่านี้กำหนดวันที่และเวลาสำหรับการส่งข้อความ หากระบุทั้ง time_shift และ send_time ค่า time_shift จะมีความสำคัญกว่า

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

เมธอดนี้สามารถเรียกใช้บอทอีเมลหลังจากที่ลูกค้าลงทะเบียนบนเว็บไซต์หรือส่งคำขอพร้อมอีเมล เมธอดจะค้นหาอีเมลของลูกค้าหรือสร้างขึ้นหากไม่พบ

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

โปรดทราบ: พารามิเตอร์ใดๆ ที่คุณส่งเพิ่มเติมจะถูกบันทึกในตัวแปร

Path

api key* - โทเค็นการเข้าถึง

Body

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

เมธอดนี้สามารถใช้เพื่อส่งข้อความแจ้งเตือน พารามิเตอร์ข้อความจำเป็น เว้นแต่คุณกำลังส่งไฟล์ หากคุณกำลังส่งไฟล์ ข้อความเป็นตัวเลือก

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

message_id - หมายเลขบล็อกสำหรับการส่ง
message - ข้อความ
client_id - 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

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

# Sending an attachment
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)

# In 'attachment_type', specify either 'video', 'image', or 'file'
# depending on the type of attachment: video, image, or document.

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

อนุญาตให้คุณส่งข้อความในนามของบอทที่เชื่อมต่อไปยังหมายเลขที่ระบุ ต้องนำ whatsapp_bot_id จากส่วน "Messengers and chats" บัญชี WhatsApp ที่เชื่อมต่อแต่ละบัญชีจะได้รับตัวระบุที่ไม่ซ้ำกันโดยตัวสร้าง

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

message_id - หมายเลขบล็อกสำหรับการส่ง
whatsapp_bot_id - 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 request: https://chatter.mavibot.ai/api/#{api\\_key}/broadcast

เมธอดนี้ช่วยให้คุณเริ่มการกระจายข้อความ

คุณสามารถใช้ หนึ่งในตัวเลือกที่ไม่สามารถใช้ร่วมกันได้ต่อไปนี้:

1. พารามิเตอร์ list — การกระจายข้อความจะถูกส่งไปยังรายการลูกค้าที่ระบุ
2. พารามิเตอร์ clients — การกระจายข้อความจะถูกส่งไปยังอาร์เรย์ของ ID ลูกค้า
3. พารามิเตอร์ platform_ids และ group_id — การกระจายข้อความจะถูกส่งไปยังอาร์เรย์ของ platform_ids (ID เมสเซนเจอร์) สำหรับบอทที่ระบุ (group_id)
4. หากไม่มีพารามิเตอร์ใดข้างต้น การกระจายข้อความจะไม่ถูกส่ง

พารามิเตอร์ที่จำเป็น: message (และ/หรือ attachment_type และ attachment_url) หรือ message_id

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

list - หมายเลขรายการที่จะส่งการกระจายข้อความ

clients - ID ลูกค้าในตัวสร้าง

message - ข้อความ

platform_ids - ID ผู้รับในเมสเซนเจอร์ ต้องใช้ร่วมกับพารามิเตอร์ 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 request: https://chatter.mavibot.ai/api/#{api\_key}/get\_history?client\_id=

สามารถรับพารามิเตอร์ client_id ได้ที่นี่ ลิงก์

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

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 request: https://chatter.mavibot.ai/api/#{api\_key}/clear\_history?client\_id=

ลบประวัติการแชท

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไข/ลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

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

เมธอดนี้ช่วยให้คุณสามารถกำหนดลูกค้าให้กับพนักงานได้ พารามิเตอร์ email เป็นตัวเลือก หากไม่ได้ระบุอีเมล ระบบจะกำหนดลูกค้าตามอัลกอริทึมของระบบ

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไข/ลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

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)
# if successful, the function will return an ID and an addition status for each item
# response example
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

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

เพิ่มลูกค้าในรายการ

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

list_id - หมายเลขรายการ
clients - อาร์เรย์ของรหัสลูกค้า

ตัวอย่าง:
พารามิเตอร์ JSON
{"list_id":1170282, "clients":[411262772, 646410963]}

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

ลบลูกค้าออกจากรายการ

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

list_id - หมายเลขรายการ
clients - อาร์เรย์ของหมายเลขลูกค้าในตัวสร้าง Mavibot (ค่าของ client_id)

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

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

ดึงข้อมูลลูกค้าจากแอปส่งข้อความที่เลือก

หมายเหตุ! เมธอดนี้ไม่ส่งคืนตัวแปร

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

page
tag – แท็กที่ระบุในหน้าการสมัครรับข้อมูล
group – รหัสกลุ่ม VK ที่ผู้ติดตามเชื่อมโยง
date_from – สมัครรับข้อมูลหลังจากวันที่นี้ (timestamp)
date_to – สมัครรับข้อมูลก่อนวันที่นี้ (timestamp)
client_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 request: https://chatter.mavibot.ai/api/#{api\_key}/save\_variables

!** **ไม่มีข้อจำกัดสำหรับคำขอนี้

อนุญาตให้บันทึกตัวแปรทั้งในลีดและลูกค้า
ตามค่าเริ่มต้น คำขอการกำหนดตัวแปรจะเพิ่มตัวแปรเหล่านั้นลงในตัวแปรดีล
ในการอัปเดตตัวแปรในโปรไฟล์ลูกค้า ให้ใช้คำนำหน้า client. ตัวอย่างเช่น สำหรับโทรศัพท์: client.phone

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

อัปเดต: พารามิเตอร์ clients อนุญาตให้กำหนดตัวแปรเป็นกลุ่ม
ตัวอย่าง: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

Path

api key* - โทเค็นการเข้าถึง

Body

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 request: https://chatter.mavibot.ai/api/#{api\_key}/get\_variables?client\_id=

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

ตัวอย่าง: https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get\_variables?client\_id=49177759

Path

api key* - โทเค็นการเข้าถึง

Body

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 request: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_platform\_id

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - โทเค็นการเข้าถึง

Body

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 request: https://chatter.mavibot.ai/api/#{api\_key}/online\_chat\_client\_id?recipient=

เมธอดนี้ช่วยให้คุณสามารถรวมเว็บไซต์เข้ากับบอทแชทได้ ตัวอย่างเช่น หากผู้ใช้เข้าชมหน้าโปรโมชัน คุณสามารถส่งข้อความในแชทพร้อมข้อเสนอเฉพาะบุคคลได้ทันที

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - access token

Body

tag - tag (client tag)\nname - client name\nrecipient - dialog ID on a website

จะหา recipient ได้จากที่ไหน?

คุณสามารถหาได้จากเว็บไซต์ที่มีแชทออนไลน์ของ Mavibot.ai โดยใช้ JS เพื่อรับคุณสมบัติ MavibotAi.recipient_id

{ "client_id": 36553 }

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

เมธอดนี้จะคืนค่า client ID สำหรับการทำ API request หากคุณทราบหมายเลขโทรศัพท์ WhatsApp ของลูกค้า
หากไม่มีลูกค้าที่มีหมายเลขนั้น เมธอดจะคืนค่า error 404

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - access token

Body

phone - หมายเลขโทรศัพท์\ngroup_id - ID บอท

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

เมธอดนี้จะคืนค่า client ID สำหรับการทำ API request

การค้นหาจะดำเนินการทั้งในกลุ่มลูกค้า WhatsApp และผ่านตัวแปร

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - access token

Body

phone - หมายเลขโทรศัพท์

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

เมธอดนี้จะคืนค่า client ID สำหรับการทำ API request
การค้นหาจะใช้ตัวแปร

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - access token

Body

email - อีเมลสำหรับค้นหา

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

เมธอดนี้จะคืนค่า client ID สำหรับการทำ API request

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูลลูกค้า"

Path

api key* - access token

Body

var - ชื่อตัวแปรที่ใช้ค้นหา\nval - ค่าตัวแปร\ngroup_id - ID กลุ่ม\nsearch_in - ส่งค่า 'order' เพื่อค้นหาในตัวแปรดีล; ค้นหาตัวแปรสูงสุดสามตัวสำหรับลูกค้าโครงการและคืนค่ารายการลูกค้าที่มีตัวแปรที่ระบุทั้งหมด

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

เมธอดนี้จะคืนค่า ID ของลูกค้าที่สร้างล่าสุดสำหรับการทำ API request โดยค้นหาทั้งตัวแปรลูกค้าและตัวแปรดีล

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูลลูกค้า"

Path

api key* - access token

Body

var - ชื่อตัวแปรที่ใช้ค้นหา\nval - ค่าตัวแปร

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

เมธอดนี้จะคืนค่ารายการ client ID ที่มีตัวแปรที่ระบุพร้อมค่าที่ระบุ

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูลลูกค้า"

Path

api key* - access token

Body

var - ชื่อตัวแปรที่ใช้ค้นหา\nval - ค่าตัวแปร

{
    // Response
}

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูลลูกค้า"

Path

api key* - access token

Body

variable1 - Value1

variable2 - Value2

variable3 - Value3

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

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

เมธอดนี้จะค้นหาตามตัวแปรและคืนค่ารายการ client ID ที่ตรงตามเงื่อนไขการค้นหา

โดยค่าเริ่มต้น การค้นหาจะดำเนินการกับตัวแปรลูกค้า (แนะนำ): {"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"}}}

หมายเหตุ: การเปรียบเทียบตัวเลขจะทำงานก็ต่อเมื่อลูกค้าทุกคนมีค่าตัวเลขในตัวแปรที่ค้นหา หากมีลูกค้าแม้แต่รายเดียวที่มีสตริง คำขอจะล้มเหลว

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูลลูกค้า"

Parameters

Path

api key* - access token

Body

q – พารามิเตอร์ที่จำเป็น ประกอบด้วยเงื่อนไขการค้นหาสำหรับตัวแปร

search_in – ระบุว่าต้องค้นหาตัวแปรของเอนทิตีใด หากไม่ระบุ จะค้นหาตัวแปรลูกค้า สามารถรับค่า order

include_all – ต้องตรงตามเงื่อนไขทั้งหมดใน q หรือไม่

False – หากตรงตามเงื่อนไขอย่างน้อยหนึ่งข้อ เอนทิตีนั้นจะถูกเลือก

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

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูล CRM"

Path

api key* - access token

Body

client_id - ID ลูกค้า

Successful response: {"status":"success","order_id":40632}, where
order_id - ID ดีลปัจจุบัน
Error response: {"status":"client_not_found"}

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูล CRM"

Path

api key* - access token

Body

client_id - ID ลูกค้า

order_status - ขั้นตอนดีล:
0 - ดีลที่ใช้งานอยู่
1 - ดีลที่สำเร็จ
2 - ดีลที่ไม่สำเร็จ

Successful response: {"status":"success","order_id":[40338,40340,40341]} 
Error response: {"status":"client_not_found"}

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไข/ลบข้อมูล CRM"

Path

api key* - access token

Body

client_id - ID ลูกค้า

order_id - ID ดีล

Successful response: 
{"status":"success","state_id":37}, โดยที่ 
state_id - ID ขั้นตอนใน MavibotCRM 
Error response: 
{"status":"client_not_found"}

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูล CRM"

Path

api key* - access token

Body

client_id - ID ลูกค้า

order_id - ID ดีล

variables - อาร์เรย์ของตัวแปร\n(รูปแบบ:["var_name1", "var_name2"])

Successful response: 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

Error example: 
{"status":"client_not_found"}

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไข/ลบข้อมูล CRM"

Path

api key* - access token

Body

client_id - ID ลูกค้า

order_id - ID ดีล

variables - พจนานุกรมของตัวแปร (คีย์คือชื่อตัวแปร และค่าคือสิ่งที่ควรบันทึกในตัวแปรนั้น)\n(รูปแบบ:{"var_name": "var_value"})

Successful response: {"status":"success"} 
Error response: {"status":"order 12345 not found"}

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไข/ลบข้อมูล CRM"

Path

api key* - access token

Body

client_id - ID ลูกค้า

name - ชื่อดีล

description - คำอธิบายดีล

budget - จำนวนเงินดีล

คุณต้องระบุพารามิเตอร์ใดพารามิเตอร์หนึ่งต่อไปนี้ในคำขอ: client_id, email หรือ phone
หากระบุหลายพารามิเตอร์ จะใช้เพียงพารามิเตอร์เดียว ลำดับความสำคัญคือ: client_id > phone > email
หากระบุ phone หรือ email และไม่มีลูกค้าที่มีหมายเลขโทรศัพท์หรืออีเมลนั้น จะสร้างลูกค้าใหม่

Successful response: {"status":"success","order_id":40654}, 
โดยที่ order_id คือ ID ของดีลที่ใช้งานอยู่ใหม่
Error response: {"status":"client_not_found"}

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไข/ลบข้อมูล CRM"

Path

api key* - access token

Body

client_id - รหัสลูกค้า

state_id - หมายเลขขั้นตอนที่ต้องการย้ายดีลของลูกค้าไป

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการอ่านข้อมูล CRM"

Path

api key* - access token

Body

client_id - รหัสลูกค้า

state_id - รหัสดีล (หากไม่ระบุ เมธอดจะส่งคืนรหัสขั้นตอนของดีลปัจจุบัน)

ตัวอย่างการตอบกลับที่สำเร็จ:
{'status': 'success', 'state_id': 123456}

ตัวอย่างการตอบกลับที่ไม่สำเร็จ:
{'status': 'order not found'}

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

ในการใช้เมธอดนี้ ต้องเชื่อมต่อ WhatsApp กับ Mavibot ก่อน

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

สามารถเรียกใช้ได้ทั้งแบบ GET หรือ POST
เบอร์โทรศัพท์สามารถระบุในรูปแบบใดก็ได้

Path

api key* - access token

Body

phone - เบอร์โทรศัพท์ที่ต้องการตรวจสอบ

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

ฟังก์ชันนี้ส่งคืนพารามิเตอร์ group_id สำหรับแต่ละแอปส่งข้อความ ซึ่งต้องใช้เมื่อนำเข้าลูกค้า

สำหรับ WhatsApp จะส่งคืนฟิลด์ status ซึ่งสามารถมีค่าดังต่อไปนี้:

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

Path

api key* - access token

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

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

สิทธิ์การเข้าถึงเมื่อสร้างคีย์: "สิทธิ์ในการแก้ไขหรือลบข้อมูลลูกค้า"

Path

api key* - access token

ในการดึง client_id และ/หรือเบอร์โทรศัพท์ของลูกค้าจากพจนานุกรมที่ซ้อนกัน (ไม่ใช่ระดับแรก) ให้ใช้พารามิเตอร์ delimiter

เพิ่มสิ่งต่อไปนี้ใน URL คำขอของคุณ:

?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}

โดยที่:

?delimiter=1 – ค่า delimiter ที่แยกคีย์ {key1}1{key2}1{key3}

delimiter_value_client_id={key1}1{key2} – เพื่อดึงรหัสลูกค้า

delimiter_value_phone={key1}1{key2} – เพื่อดึงเบอร์โทรศัพท์ของลูกค้า

{key1}, {key2}, … – คีย์ที่มีค่า (สามารถมีอักขระใดก็ได้ยกเว้น delimiter) คุณสามารถมีคีย์ได้ไม่จำกัดจำนวน:
?delimiter=1&delimiter_value_client_id={key1}1{key2}1{key3}1{key4}1{key5}1{key6}
คีย์จะถูกส่งโดยไม่มีเครื่องหมายปีกกา

ใช้ delimiter ระหว่างคีย์ ตัวอย่างเช่น ถ้า delimiter=2 ดังนั้น {key1}2{key2}2{key3}; ถ้า delimiter=5 ดังนั้น {key1}5{key2}5{key3} ตรวจสอบให้แน่ใจว่าคีย์ไม่มีอักขระ delimiter

ตัวอย่าง:

https://chatter.mavibot.a/aipi/\<api_key>/callback****?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}****

คุณยังสามารถดึงเฉพาะรหัสหรือเฉพาะเบอร์โทรศัพท์:

https://chatter.salebot.pro/api/\<api_key>/callback****?delimiter=1&delimiter_value_client_id={key1}1{key2} -**** เฉพาะรหัสลูกค้า;

https://chatter.salebot.pro/api/\<api_key>/callback****?delimiter=1delimiter_value_phone={key1}1{key2}**** - เฉพาะเบอร์โทรศัพท์;

เมธอด API:

1. เริ่มบอท: https://chatter.mavibotbot.ai/api/\<api_key>/callback
2. เริ่มบอทด้วยเบอร์ WhatsApp: https://chatter.mavibotbot.ai/api/\<api_key>/whatsapp_callback
3. เริ่มบอทด้วยรหัส Telegram: https://chatter.mavibotbot.ai/api/\<api_key>/tg_callback
4. ส่งข้อความ callback ไปยังลูกค้าทางอีเมล: https://chatter.mavibotbot.ai/api/\<api_key>/email_callback
5. ส่งข้อความถึงลูกค้า: https://chatter.mavibotbot.ai/api/\<api_key>/message
6. ส่งข้อความ WhatsApp: https://chatter.mavibotbot.ai/api/\<api_key>/whatsapp_message
7. ส่งข้อความจำนวนมาก: https://chatter.mavibotbot.ai/api/\<api_key>/broadcast
8. กำหนดตัวแปร: https://chatter.mavibotbot.ai/api/\<api_key>/save_variables