ฟังก์ชัน API มีให้ใช้งานเฉพาะในแผน "Business" และ "MaviBot AI" เท่านั้น

API MaviBot

คำอธิบายสัญลักษณ์:\ ! -พารามิเตอร์ที่จำเป็น

วิธีส่ง callback

callback()

คุณสามารถส่ง callback ไปยังลูกค้า ANOTHER เท่านั้น

คุณไม่สามารถส่ง callback ไปยังตัวเอง!

callback(client_id, callback_message)

พารามิเตอร์:

! client_id - ตัวระบุลูกค้า

! callback_message - ข้อความ callback

callback คือข้อความระบบพิเศษที่บอทจะจดจำว่าเป็นคำสั่งให้ดำเนินการเฉพาะ ข้อความนี้จะไม่ปรากฏแก่ผู้ใช้และจะถูกบันทึกเฉพาะในโปรไฟล์ของลูกค้าเพื่อการประมวลผลภายใน

มาส่ง callback ไปยังลูกค้าที่มี client_id=73704021 กัน

จากนั้น เราจะตั้งค่าการตอบกลับสำหรับ callback นี้ในบล็อกที่มีเงื่อนไข

callback('73704021', 'callback TEST123')

callback(client_id, 'callback TEST123')

วิธีส่ง callback ใน Telegram

tg_callback()

tg_callback(platform_id , callback_message,group_id, business_connection_id)

พารามิเตอร์:

! platform_id - ตัวระบุลูกค้า Telegram

! callback_message - ข้อความ callback

group_id - ตัวระบุบอท Telegram

tg_business - สำหรับการทำงานกับลูกค้าธุรกิจ ให้ส่งค่า "1"

นี่คือตัวอย่างที่มีพารามิเตอร์ที่จำเป็น:

นี่คือตัวอย่างที่มีพารามิเตอร์เสริม:

tg_callback('73704021', 'callback TEST123')

tg_callback(platform_id, 'callback TEST123', None, 1)

วิธีเพิ่มการเปลี่ยนเส้นทางบอทด้วยแท็กเพื่อตอบสนองต่อปุ่ม callback?

tg_callback_url_open(callback_query_id, url)

พารามิเตอร์: \ ! callback_query_id - id นี้ช่วยให้คุณระบุบุคคลที่กดปุ่มและแสดงการแจ้งเตือน Alert,\ ! url - URL- ระบุบอทและพารามิเตอร์ (มีลักษณะดังนี้: t.me/your_bot?start=XXXX, แทนที่ your_bot ด้วยชื่อบอท)

วิธีส่งข้อความถึงลูกค้า

message() | platform_message() | whatsapp_message()

หากต้องการจัดเก็บข้อความที่มีการขึ้นบรรทัดใหม่ในตัวแปร ให้ตั้งค่าดังนี้:

text = "ข้อความบรรทัดแรก" + "\n" + "ข้อความบรรทัดที่สอง" + "\n" +"ข้อความบรรทัดที่สาม"

message(client_id, text, message_id, timeout)

พารามิเตอร์:\ ! client_id - ตัวระบุลูกค้า\ ! text - ข้อความ
message_id - ID บล็อก หากคุณปล่อยช่องข้อความว่างไว้ (") และกรอกพารามิเตอร์นี้ ข้อความจากบล็อกที่ระบุจะถูกส่งไปยังลูกค้า

หมายเหตุ: หากคุณส่งพารามิเตอร์ message_id ไปยังฟังก์ชัน message บล็อกจะยังคงทำงานอย่างสมบูรณ์ และลูกค้าที่ระบุในพารามิเตอร์ client_id จะถูกย้ายไปยังบล็อกที่คุณส่งใน message_id


timeout - ความล่าช้าของข้อความหรือเวลาที่กำหนดไว้ล่วงหน้า คุณสามารถใช้พารามิเตอร์ timeout เพื่อหน่วงเวลาการส่งข้อความ:
a) ความล่าช้าเป็นวินาที (สูงสุด 3600 วินาที) หากค่าเกิน 3600 ข้อความจะถูกส่งภายในหนึ่งชั่วโมง หากค่าเป็นลบ ข้อความจะถูกส่งทันที ตัวอย่าง: timeout = 50

b) วันที่และเวลาเฉพาะในรูปแบบ dd.mm.yyyy hh:mm ตัวอย่าง: timeout = '03.04.2022 15:00' หากระบุวันที่ในอดีต ข้อความจะถูกส่งทันที

platform_message(platform_id, text, client_type, message_id, timeout,group_id)

พารามิเตอร์:\ ! platform_id - ตัวระบุลูกค้าในแอปส่งข้อความ\ ! text - ข้อความ
client_type - ประเภทแอปส่งข้อความ พารามิเตอร์เสริม หากไม่ได้ระบุ ลูกค้าจะถูกค้นหาในแอปส่งข้อความเดียวกับที่บอทส่งข้อความ หากระบุ ลูกค้าจะถูกพบในฐานข้อมูลของแอปส่งข้อความที่ระบุ คุณสามารถดูประเภทแอปส่งข้อความได้ ที่นี่
message_id - ID บล็อก หากระบุ ลูกค้าจะได้รับข้อความจากบล็อกที่ระบุ ไม่ใช่ค่าจากพารามิเตอร์ text
timeout - เวลาส่งหรือความล่าช้า คล้ายกับพารามิเตอร์ของฟังก์ชัน message() ที่มีชื่อเดียวกัน
group_id - ตัวระบุบอท

whatsapp_message(phone, text, message_id)

พารามิเตอร์:\ ! phone- หมายเลขโทรศัพท์ของลูกค้าที่ลงทะเบียน Whatsapp\ ! text - ข้อความ
message_id -คือ ID บล็อก หากปล่อยช่องข้อความว่างไว้ ('') และตั้งค่าพารามิเตอร์นี้ ลูกค้าจะได้รับเนื้อหาข้อความจากบล็อกที่ระบุ

ต้องเชื่อมต่อบอท Whatsapp กับโปรเจกต์

ตัวอย่างง่ายๆ ของการส่งข้อความโดยใช้ client_id:

ตัวเลือกต่างๆ สำหรับการส่งข้อความโดยใช้ client_id:

ตัวอย่างการส่งข้อความผ่าน platform_message():

/*ส่งข้อความโดยใช้ client_id*/
message(73704021, 'ข้อความสำหรับลูกค้า')
/*ส่งข้อความโดยใช้ client_id โดยหน่วงเวลา 30 วินาที*/
message(73704021, 'สวัสดี! ขอบคุณที่เขียน..','',30)
/*ส่งข้อความจากบล็อก 3190 โดยใช้ client_id ในวันที่ 03.04.2022 เวลา 15.00 น.*/
message(73704021, '',3190, '03.04.2022 15.00 น.')

/*ส่งข้อความใน Whatsapp*/
whatsapp_message('79999999999', 'ข้อความสำหรับลูกค้า')

การรับ client_id จากค่า platform_id

get_client_id_by_platform_id()

get_client_id_by_platform_id(client_type, platform_id , group)

หลังจากดำเนินการ ฟังก์ชันจะส่งคืน client_id หากพบลูกค้าที่ตรงตามเงื่อนไขที่ระบุ มิฉะนั้นจะส่งคืน None

! client_type - แอปส่งข้อความ สำหรับค่า client_type โปรดอ่าน บทความนี้

! platform_id - ID ของลูกค้าในแอปส่งข้อความที่ระบุ

group - เป็นพารามิเตอร์ที่จำเป็นหากเชื่อมต่อบอทแอปส่งข้อความมากกว่าหนึ่งตัว

หากเชื่อมต่อแอปส่งข้อความหลายตัวประเภทเดียวกันในโปรเจกต์ การค้นหาจะขึ้นอยู่กับแอปส่งข้อความที่เชื่อมต่อทั้งหมดประเภทนี้

ในกรณีนี้ เราขอแนะนำให้ส่งพารามิเตอร์ group

ฟังก์ชันสำหรับคำขอ get: requests_get(url, answer_type, headers, params, auth, proxy)

! url - คือลิงก์ที่ใช้ส่งคำขอ

answer_type – เป็นพารามิเตอร์เสริมที่กำหนดว่าควรส่งคืนอะไรจากการตอบสนองของเซิร์ฟเวอร์: ('status' – ส่งคืนรหัสสถานะการตอบสนอง; 'json' – ส่งคืนเนื้อหา json ของการตอบสนอง; 'text' – ส่งคืนข้อความดิบของการตอบสนอง ค่าอื่นใด (รวมถึงค่าเริ่มต้น) จะส่งคืนการตอบสนองในรูปแบบ: '{"status": status_code, "data": data}')

headers - เป็นพารามิเตอร์เสริมสำหรับส่งส่วนหัวของคำขอ

params - คือพารามิเตอร์คำขอ get (สามารถรวมไว้ใน URL ได้โดยตรง)

auth - เป็นพารามิเตอร์เสริมที่มีประโยชน์สำหรับการตรวจสอบสิทธิ์ API หากคุณไม่ต้องการใช้พารามิเตอร์เสริมใดๆ แต่จำเป็นต้องใช้พารามิเตอร์ถัดไป ให้ส่ง 0 ที่นี่

proxy - เป็นพารามิเตอร์เสริม รับค่าเดียว: "de" ซึ่งจะกำหนดเส้นทางคำขอผ่านที่อยู่ IP ในยุโรป

ฟังก์ชันสำหรับคำขอ post

requests_post(url, answer_type, headers, data, json_data, auth, proxy)

! url - คือลิงก์ที่ใช้ส่งคำขอ

answer_type - เป็นพารามิเตอร์เสริมที่กำหนดว่าควรส่งคืนอะไรจากการตอบสนองของเซิร์ฟเวอร์: ('status' – ส่งคืนรหัสสถานะการตอบสนอง; 'json' – ส่งคืนเนื้อหา json ของการตอบสนอง; 'text' – ส่งคืนข้อความดิบของการตอบสนอง ค่าอื่นใด (รวมถึงค่าเริ่มต้น) จะส่งคืนการตอบสนองในรูปแบบ: '{"status": status_code, "data": data}')

headers - เป็นพารามิเตอร์เสริมสำหรับส่งส่วนหัวของคำขอ

data - เป็นพารามิเตอร์เสริม แสดงถึงเนื้อหาของคำขอเมื่อ API ไม่ทำงานกับ json

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

โปรดทราบ: การกำหนดค่าส่วนหัวบางอย่างอาจบล็อกไม่ให้ส่งคำขอด้วยเนื้อหาประเภทใดประเภทหนึ่ง

auth - เป็นพารามิเตอร์เสริมที่มีประโยชน์สำหรับการตรวจสอบสิทธิ์ API หากคุณไม่ต้องการใช้พารามิเตอร์เสริมใดๆ แต่จำเป็นต้องใช้พารามิเตอร์ถัดไป ให้ส่ง 0 ที่นี่

proxy - เป็นพารามิเตอร์เสริม รับค่าเดียว: "de" ซึ่งจะกำหนดเส้นทางคำขอผ่านที่อยู่ IP ในยุโรป

ฟังก์ชันสำหรับคำขอ put

requests_put(url, answer_type, headers, data, auth, proxy)

! url - คือลิงก์ที่ใช้ส่งคำขอ

answer_type - เป็นพารามิเตอร์เสริมที่กำหนดว่าควรส่งคืนอะไรจากการตอบสนองของเซิร์ฟเวอร์: ('status' – ส่งคืนรหัสสถานะการตอบสนอง; 'json' – ส่งคืนเนื้อหา json ของการตอบสนอง; 'text' – ส่งคืนข้อความดิบของการตอบสนอง ค่าอื่นใด (รวมถึงค่าเริ่มต้น) จะส่งคืนการตอบสนองในรูปแบบ: '{"status": status_code, "data": data}')

headers - เป็นพารามิเตอร์เสริมสำหรับส่งส่วนหัวของคำขอ

data - เป็นพารามิเตอร์เสริม แสดงถึงเนื้อหาของคำขอเมื่อ API ไม่ทำงานกับ json

auth - เป็นพารามิเตอร์เสริมที่มีประโยชน์สำหรับการตรวจสอบสิทธิ์ API หากคุณไม่ต้องการใช้พารามิเตอร์เสริมใดๆ แต่จำเป็นต้องใช้พารามิเตอร์ถัดไป ให้ส่ง 0 ที่นี่

proxy - เป็นพารามิเตอร์เสริม รับค่าเดียว: "de" ซึ่งจะกำหนดเส้นทางคำขอผ่านที่อยู่ IP ในยุโรป

data_is_json เป็นพารามิเตอร์เสริม
หากตั้งค่า ข้อมูลที่ส่งใน data จะถูกส่งในรูปแบบ JSON
หากต้องการเปิดใช้งาน ให้ส่ง '1'

ฟังก์ชันสำหรับคำขอ patch

requests_patch(url, answer_type, headers, data, auth, proxy)

! url - คือลิงก์ที่ใช้ส่งคำขอ

answer_type - เป็นพารามิเตอร์เสริมที่กำหนดว่าควรส่งคืนอะไรจากการตอบสนองของเซิร์ฟเวอร์: ('status' – ส่งคืนรหัสสถานะการตอบสนอง; 'json' – ส่งคืนเนื้อหา json ของการตอบสนอง; 'text' – ส่งคืนข้อความดิบของการตอบสนอง ค่าอื่นใด (รวมถึงค่าเริ่มต้น) จะส่งคืนการตอบสนองในรูปแบบ: '{"status": status_code, "data": data}')

headers - เป็นพารามิเตอร์เสริมสำหรับส่งส่วนหัวของคำขอ

data - เป็นพารามิเตอร์เสริม แสดงถึงเนื้อหาของคำขอเมื่อ API ไม่ทำงานกับ json

auth - เป็นพารามิเตอร์เสริมที่มีประโยชน์สำหรับการตรวจสอบสิทธิ์ API หากคุณไม่ต้องการใช้พารามิเตอร์เสริมใดๆ แต่จำเป็นต้องใช้พารามิเตอร์ถัดไป ให้ส่ง 0 ที่นี่

proxy - เป็นพารามิเตอร์เสริม รับค่าเดียว: "de" ซึ่งจะกำหนดเส้นทางคำขอผ่านที่อยู่ IP ในยุโรป

ฟังก์ชันสำหรับคำขอ delete

requests_delete(url, answer_type, headers, data, json_data, auth, proxy)

! url - คือลิงก์ที่ใช้ส่งคำขอ

answer_type - เป็นพารามิเตอร์เสริมที่กำหนดว่าควรส่งคืนอะไรจากการตอบสนองของเซิร์ฟเวอร์: ('status' – ส่งคืนรหัสสถานะการตอบสนอง; 'json' – ส่งคืนเนื้อหา json ของการตอบสนอง; 'text' – ส่งคืนข้อความดิบของการตอบสนอง ค่าอื่นใด (รวมถึงค่าเริ่มต้น) จะส่งคืนการตอบสนองในรูปแบบ: '{"status": status_code, "data": data}')

headers - เป็นพารามิเตอร์เสริมสำหรับส่งส่วนหัวของคำขอ

data - เป็นพารามิเตอร์เสริม แสดงถึงเนื้อหาของคำขอเมื่อ API ไม่ทำงานกับ json

json_data - เป็นพารามิเตอร์เสริมและอาจใช้เป็นเนื้อหาของคำขอได้เช่นกัน อย่างไรก็ตาม ควรใช้เพียงตัวเลือกเดียวในแต่ละครั้ง

auth - เป็นพารามิเตอร์เสริมที่มีประโยชน์สำหรับการตรวจสอบสิทธิ์ API หากคุณไม่ต้องการใช้พารามิเตอร์เสริมใดๆ แต่จำเป็นต้องใช้พารามิเตอร์ถัดไป ให้ส่ง 0 ที่นี่

proxy - เป็นพารามิเตอร์เสริม รับค่าเดียว: "de" ซึ่งจะกำหนดเส้นทางคำขอผ่านที่อยู่ IP ในยุโรป

ฟังก์ชันสำหรับรับชื่อบล็อกตาม ID

get_block_name_by_id(block_id)

! block_id — ตัวระบุบล็อก (id)