คำขอจะดำเนินการด้วยวิธี POST ไปยัง URL เช่น https://chatter.mavibot.ai/api/{api\_key}/{action}

โดยที่: api_key คือคีย์สำหรับเข้าถึง API ซึ่งได้รับจากการตั้งค่าโปรเจกต์:

คุณสามารถรับคีย์การเข้าถึงได้โดยใช้ตัวแปร #{api_key} ซึ่งจะเก็บคีย์ที่สร้างขึ้นที่เกี่ยวข้องไว้ อย่าลืมสร้างคีย์ก่อนใช้งาน

เมื่อคัดลอก URL ของคำขอจากหน้านี้ จะมีช่องว่างแทรกอยู่ ซึ่งจำเป็นต้องลบออกเมื่อเรียกใช้

ตัวอย่างการคัดลอกลิงก์ที่ผิดวิธี: https://chatter.mavibot.ai/api/callback 

ช่องว่างหลัง .pro อาจสังเกตได้ยาก แต่ถ้าปล่อยทิ้งไว้ คำขอจะไม่ทำงาน

เมื่อส่งคำขอด้วยวิธี GET ห้ามใช้คำต้องห้าม โปรดดูการสร้างคำขอ GET ที่ถูกต้อง

วิธีรับข้อความบน Webhook URL ที่ระบุในการตั้งค่าโปรเจกต์

การตั้งค่าโปรเจกต์

ข้อความขาเข้าหรือขาออกทุกข้อความจะมาพร้อมกับคำขอ json POST ต่อไปนี้:

{
    'id': ตัวระบุของข้อความในระบบ,
    'client': {
        'id': ตัวระบุของไคลเอนต์ในระบบ,
        'recepient': ตัวระบุของไคลเอนต์ในเมสเซนเจอร์,
        'client_type': ประเภทของเมสเซนเจอร์,
        'name': ชื่อของไคลเอนต์,
        'avatar': อวาตาร์ของไคลเอนต์,
        'created_at': วันที่สร้างไคลเอนต์,
        'tag': คีย์การสมัครรับข้อมูล,
        'group': บอทที่ไคลเอนต์เชื่อมโยงอยู่,
    },
    'message': ข้อความ,
    'attachments': อาร์เรย์ของลิงก์ไปยังไฟล์,
    'message_id': id ของบล็อกที่ส่งข้อความมา,
    'project_id': id ของโปรเจกต์,
    'is_input': 1 ถ้าข้อความมาจากไคลเอนต์, 0 ถ้ามาจากบอท,
    'delivered': 1 ถ้าส่งข้อความสำเร็จ, 0 ถ้ามีข้อผิดพลาด,,
    'error_message': ข้อความที่อธิบายข้อผิดพลาด
}

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

วิธีใช้ universal webhook

ขณะนี้วิธีการเหล่านี้สามารถเรียกใช้ได้ทั้งกับคำขอ POST และ GET

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

ตอนนี้คุณสามารถระบุได้ว่าในพารามิเตอร์ใดของคำขอ Mavibot จะค้นหาตัวระบุของผู้ใช้: สำหรับสิ่งนี้ จะใช้พารามิเตอร์ที่มีคำนำหน้า value_ เช่น value_user_id และ value_group_id

นอกจากนี้ เมธอดสำหรับส่ง callback callback สามารถเปิดใช้งานได้โดยการส่งอีเมล (client_email) และหมายเลขโทรศัพท์ของไคลเอนต์ (client_phone)

เมธอด callback และ whatsapp_callback ไม่ได้ผูกติดกับชื่อพารามิเตอร์ คุณสามารถระบุได้ว่าพารามิเตอร์ใดจะเก็บหมายเลขโทรศัพท์ อีเมล และ id ของไคลเอนต์

มีประโยชน์เมื่อคุณกำลังตั้งค่ารับ webhook ผ่านเว็บไซต์อื่น

ในการระบุว่าตัวแปรใดเก็บ client_id คุณต้องส่ง value_client_id และระบุชื่อของพารามิเตอร์ที่มีค่านี้

ในการระบุว่าตัวแปรใดเก็บโทรศัพท์ คุณต้องส่ง value_phone และระบุชื่อของพารามิเตอร์ที่มีค่านี้

ในการระบุว่าตัวแปรใดเก็บอีเมล คุณต้องส่ง value_email และระบุชื่อของพารามิเตอร์ที่มีค่านี้

ในการระบุว่าตัวแปรใดเก็บ user_id คุณต้องส่ง value_user_id และระบุชื่อของพารามิเตอร์ที่มีค่านี้

ในการระบุว่าตัวแปรใดเก็บ group_id คุณต้องส่ง value_group_id และระบุชื่อของพารามิเตอร์ที่มีค่านี้

ตัวอย่าง:

พิมพ์ในที่อยู่ value_client_id = my_client

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hello world"}

คำขอนี้จะเทียบเท่ากับคำขอด้านล่าง:

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}

อย่างที่คุณเห็น ชื่อของพารามิเตอร์ที่เก็บชื่อจะแตกต่างด้วยคำนำหน้า value_

วิธีเปิดใช้งานบอท

การเปิดใช้งานบอท

POST https://chatter.mavibot.ai/api/<api_key>/callback

เมธอดนี้สามารถใช้เพื่อเปิดใช้งานเวิร์กโฟลว์สำหรับไคลเอนต์หรือเพื่อยืนยันการดำเนินการบนบริการของบุคคลที่สาม ข้อความนี้จะไม่ปรากฏแก่ไคลเอนต์
พารามิเตอร์ที่ส่งเพิ่มเติมจะถูกบันทึกไว้ในตัวแปร
ขณะนี้เมธอดสำหรับส่ง callback สามารถเปิดใช้งานได้โดยการแชร์อีเมล (client_email) หรือหมายเลขโทรศัพท์ของไคลเอนต์ (client_phone)

พารามิเตอร์เส้นทาง

ชื่อ ประเภท คำอธิบาย
api_key string โทเค็นการเข้าถึง

เนื้อหาคำขอ

ชื่อ ประเภท คำอธิบาย
client_phone string หมายเลขโทรศัพท์ที่ใช้ค้นหาไคลเอนต์
client_email string อีเมลที่ใช้ค้นหาไคลเอนต์
client_id string id ของไคลเอนต์ในตัวแก้ไข
message string ข้อความ

**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)

การเปิดใช้งานบอทผ่านหมายเลขบน WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback

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

พารามิเตอร์เส้นทาง

ชื่อ ประเภท คำอธิบาย
api_key string โทเค็นการเข้าถึง

เนื้อหาคำขอ

ชื่อ ประเภท คำอธิบาย
name string ชื่อของไคลเอนต์
message string ข้อความ
phone string หมายเลขโทรศัพท์ของไคลเอนต์
bot_id string id ของบอท

**200: OK **

{
    // การตอบสนอง
}

การเปิดใช้งานบอทผ่าน Telegram id

POST https://chatter.mavibot.ai/api/<api_key>/tg_callback

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

พารามิเตอร์ที่ส่งเพิ่มเติมจะถูกบันทึกไว้ในตัวแปร

พารามิเตอร์เส้นทาง

ชื่อ ประเภท คำอธิบาย
api_key string โทเค็นการเข้าถึง

เนื้อหาคำขอ

ชื่อ ประเภท คำอธิบาย
message string ข้อความ
user_id string id ของผู้ใช้ใน Telegram
group_id string ชื่อของบอท (ต้องลงท้ายด้วย bot)

**200: OK **

{
    // การตอบสนอง
}

วิธีทำงานกับข้อความ

พารามิเตอร์สำหรับส่งข้อความ

attachment_type สามารถรับค่าเหล่านี้: image, video, link, file, audio
เมื่อส่งไฟล์แนบ พารามิเตอร์ message ไม่จำเป็น

buttons ระบุปุ่มที่จะแนบไปกับข้อความ รูปแบบของปุ่มเทียบได้กับการตั้งค่าขั้นสูงของปุ่ม สามารถส่งปุ่มได้สองรูปแบบ: แบบมีคำแนะนำในเมสเซนเจอร์ที่ไม่มีปุ่ม และแบบไม่มี

นี่คือตัวอย่างของพารามิเตอร์ปุ่ม:

"buttons": {"hint": "ข้อความนี้จะแสดงใน Whatsapp",
 "buttons": [
    {"type": "reply", 
     "text": "เราสามารถให้บริการอะไรได้บ้าง", 
     "line": 0, "index_in_line": 0}, 
       
    {"type": "reply", 
     "text": "ข้อมูลการชำระเงิน", 
     "line": 0, 
     "index_in_line": 1}, 
        
    {"type": "reply", 
     "text": "ข้อมูลติดต่อของเรา", 
     "line": 1, "index_in_line": 0}, 
        
    {"type": "reply", 
     "text": "ส่งใบสมัคร", 
     "line": 1, "index_in_line": 1}
   ] 
}

การส่งข้อความถึงไคลเอนต์

POST https://chatter.mavibot.ai/api/<api_key>/message

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

พารามิเตอร์เส้นทาง

ชื่อ ประเภท คำอธิบาย
api_key string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ประเภท คำอธิบาย
message_id string หมายเลขของบล็อกที่ส่ง
message string ข้อความ
client_id string id ของไคลเอนต์ในตัวแก้ไข
attachment_type string ประเภทการแสดงไฟล์
attachment_url string URL ของไฟล์
buttons object ปุ่ม

**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)

การส่งข้อความใน WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message

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

พารามิเตอร์เส้นทาง

ชื่อ ประเภท คำอธิบาย
api_key string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ประเภท คำอธิบาย
message_id string หมายเลขของบล็อกที่ส่ง
whatsapp_bot_id number บอท WhatsApp ที่ส่งข้อความ
attachment_url string url ของไฟล์
attachment_type string ประเภทการแสดงไฟล์
message string ข้อความ
phone string หมายเลขโทรศัพท์ของผู้รับ

**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)

การส่งข้อความจำนวนมาก

POST https://chatter.mavibot.ai/api/<api_key>/broadcast

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

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ชนิด คำอธิบาย
message_id string หมายเลขของบล็อกที่ส่ง
list string รายการหมายเลขผู้รับ
shift string จำนวนวินาทีระหว่างข้อความ ค่าเริ่มต้นคือ 0.2
message string ข้อความ
clients array รหัสของผู้รับ
attachment_type string ประเภทการแสดงไฟล์
attachment_url string URL ของไฟล์
buttons string ปุ่ม

**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)

การรับประวัติข้อความ

GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=

การรับประวัติข้อความ คุณสามารถรับพารามิเตอร์ client_id ได้ ที่นี่

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
client_id string รหัสของลูกค้า

**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"
    },
  ]
}

การล้างประวัติข้อความ

GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
client_id string รหัสของลูกค้า

**200: OK **

import requests
import json


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

วิธีการกระจายลูกค้า

การกำหนดลูกค้าให้กับพนักงาน

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

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

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
client_id String รหัสของลูกค้า
e-mail String อีเมลของพนักงาน (ไม่บังคับ)

**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)

การโหลดลูกค้าเข้าสู่ระบบ

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

วิธีการนี้ช่วยให้สามารถโหลดลูกค้าเข้าสู่ระบบได้ เมื่ออัปโหลดลูกค้า WhatsApp คุณสามารถส่งหมายเลขได้อย่างอิสระโดยมี @s.whatsapp.net ต่อท้ายหรือไม่มีก็ได้

คุณสามารถรับรหัสกลุ่ม (group_id) ได้ที่นี่ ผ่าน /api/<api_key>/connected_channels

(ถ้า client_type=13 (โทรศัพท์) แล้ว group_id=””)

คุณสามารถดูประเภทของ messenger ที่ลูกค้ามา (client_type)

ตัวอย่าง: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ชนิด คำอธิบาย
platform_id String หมายเลขโทรศัพท์
group_id String รหัสกลุ่ม
client_type String ประเภทของ messenger ที่ลูกค้ามา

**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)
# ในกรณีที่สำเร็จ ฟังก์ชันจะส่งคืนแต่ละองค์ประกอบด้วย id และสถานะการเพิ่ม
# ตัวอย่างคำตอบ
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

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

POST https://chatter.mavibot.ai/api/<api_key>/add_to_list

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ชนิด คำอธิบาย
list_id integer หมายเลขของรายการ
clients array อาร์เรย์ของหมายเลขลูกค้า

**200: OK **

{
    // คำตอบ
}

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

POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ชนิด คำอธิบาย
list_id integer หมายเลขของรายการ
clients array อาร์เรย์ของหมายเลขลูกค้า

**200: OK **

{
    // คำตอบ
}

การรับรายการลูกค้า

POST https://chatter.mavibot.ai/api/<api_key>/get_clients

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
offset string ออฟเซ็ตจากองค์ประกอบแรก
limit integer จำนวนองค์ประกอบในคำตอบ ค่าเริ่มต้นคือ 500 สูงสุด 500
list string หมายเลขของรายการ

200: OK ส่งคืนสถานะขององค์ประกอบและอาร์เรย์

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

การรับรายชื่อสมาชิกใน messenger ใดๆ

POST https://chatter.mavibot.ai/api/<api_key>/subscribers

การรับข้อมูลเกี่ยวกับลูกค้าใน messenger ที่เลือก

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
page integer
tag string แท็กที่ถูกกล่าวถึงในหน้าสมัครสมาชิก
group integer รหัสของกลุ่มที่สมาชิกเชื่อมโยงอยู่
date_from integer timestamp ของวันที่หลังจากที่พวกเขาสมัครสมาชิก
date_to integer timestamp ของวันที่ที่พวกเขาสมัครสมาชิกจนถึง
client_type integer รหัสของ messenger ที่คุณต้องการรับรายชื่อย่อย หากไม่เปลี่ยนแปลง ลูกค้าทั้งหมดจะปรากฏขึ้น

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

สิทธิ์ในการลบลูกค้า

POST ``https://chatter.mavibot.ai/api/<api_key>/get_clients

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

พารามิเตอร์

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

เนื้อหา
client_ids — รายการรหัสลูกค้าที่จะลบ สูงสุด 500 ตัวอย่าง: [199571, 199707, 1935722]

วิธีการทำงานกับตัวแปร

การกำหนดตัวแปร

POST https://chatter.mavibot.ai/api/<api_key>/save_variables

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

พารามิเตอร์ clients อนุญาตให้กำหนดตัวแปรเป็นกลุ่ม

ตัวอย่าง: {"client_id":49177759, "variables":
{"client.phone":"1234567890"}}

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ชนิด คำอธิบาย
clients array อาร์เรย์รหัสลูกค้าสำหรับกำหนดตัวแปร
client_id string รหัสของลูกค้า
variables object แฮชตัวแปร (คู่คีย์-ค่า)

**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)

การรับตัวแปร

GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string โทเค็นการเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
client_id string รหัสลูกค้า

**200: OK **

import requests
import json


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

วิธีการรับ client_id

การรับ client_id โดยใช้ค่า platform_id

POST https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_platform_id

เมธอดนี้จะคืนค่า client id สำหรับการดำเนินการคำขอไปยัง API

ตัวอย่างพารามิเตอร์: {"platform_ids": ["571830542", "256865200"]}

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ชนิด คำอธิบาย
platform_ids string อาร์เรย์ของ ID ในเมสเซนเจอร์

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

วิธีรับ client id บนแชทออนไลน์

GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=

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

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string โทเค็นการเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
tag string แท็กของลูกค้า
name string ชื่อของลูกค้า
recipient string ID ของบทสนทนาบนเว็บไซต์

**200: OK **

{ "client_id": 36553 }

คุณจะได้รับ recipient ได้จากที่ไหน? บนเว็บไซต์ที่มีแชทออนไลน์ "Mavibot.ai" คุณต้องรับฟีเจอร์ MaviBotPro.recipient_id โดยใช้ JS

วิธีรับ client id ด้วยหมายเลข WhatsApp

GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=

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

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string โทเค็นการเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
phone string หมายเลขโทรศัพท์

**200: OK **

{
    // การตอบกลับ
}

การรับ client id ด้วยหมายเลขโทรศัพท์

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=

เมธอดนี้จะคืนค่า client id สำหรับการดำเนินการคำขอไปยัง API
การค้นหาจะดำเนินการผ่านลูกค้า WhatsApp รวมถึงผ่านตัวแปร

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string โทเค็นการเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
phone string หมายเลขโทรศัพท์

**200: OK **

{
    // การตอบกลับ
}

การรับ client id ผ่านอีเมล

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=

เมธอดนี้จะคืนค่า client id สำหรับการดำเนินการคำขอไปยัง API การค้นหาจะดำเนินการผ่านตัวแปร

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string โทเค็นการเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
email string อีเมลสำหรับค้นหา

**200: OK **

{
    // การตอบกลับ
}

การรับ client id โดยค่าตัวแปร

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=

เมธอดนี้จะคืนค่า client id สำหรับการดำเนินการคำขอไปยัง API

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string โทเค็นการเข้าถึง

พารามิเตอร์คำค้นหา

ชื่อ ชนิด คำอธิบาย
var string ชื่อของตัวแปรที่จะใช้ในการค้นหา
val string ค่าของตัวแปร

**200: OK **

{
    // การตอบกลับ
}

ความเป็นไปได้อื่น ๆ ที่มี

การย้ายธุรกรรมไปยังสถานะ MavibotCRM

POST https://chatter.mavibot.ai/api/<api_key>/set_order_state

สามารถรับหมายเลขธุรกรรมได้ในหน้าต่างการแก้ไขเวิร์กโฟลว์ของ MavibotCRM

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ชนิด คำอธิบาย
client_id string ID ของลูกค้า
state_id string หมายเลขสถานะที่จะย้ายธุรกรรมของลูกค้าไป

**200: OK **

{
    // การตอบกลับ
}

การตรวจสอบว่าบุคคลนั้นติดตามบัญชี Instagram หรือไม่

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

สามารถเรียกใช้ได้ทั้งด้วยเมธอด POST และเมธอด GET

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string คีย์การเข้าถึง

เนื้อหาคำขอ

ชื่อ ชนิด คำอธิบาย
user_name string ชื่อผู้ใช้ของลูกค้าที่คุณต้องการตรวจสอบ
login string ชื่อเข้าสู่ระบบของบอทที่กำลังถูกตรวจสอบ

200: OK ฟิลด์ is_follower คือฟิลด์ที่เก็บข้อมูลว่าบุคคลนั้นติดตามหรือไม่

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

การตรวจสอบว่าหมายเลขโทรศัพท์มี WhatsApp หรือไม่

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

ในการใช้เมธอดนี้ คุณต้องเชื่อมต่อ WhatsApp และ Mavibot แล้ว

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

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string โทเค็นการเข้าถึง

เนื้อหาคำขอ

ชื่อ ชนิด คำอธิบาย
phone string หมายเลขโทรศัพท์

**200: OK **

{
    // การตอบกลับ
}

การรับรายการเมสเซนเจอร์ที่เชื่อมต่อกับโปรเจกต์ (รวมถึง group_id)

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

ฟังก์ชันนี้จะคืนค่าพารามิเตอร์ group_id ให้กับแต่ละเมสเซนเจอร์ และเป็นพารามิเตอร์ที่ต้องส่งเมื่อโหลดลูกค้า

ฟิลด์ status จะถูกส่งคืนสำหรับ WhatsApp ด้วย และมีค่าดังนี้:
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string โทเค็นการเข้าถึง

**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': [] 
}

การรับรายการบล็อกจากสคีมาของบอท

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

พารามิเตอร์เส้นทาง

ชื่อ ชนิด คำอธิบาย
api_key string โทเค็นการเข้าถึง

**200: OK **

{
    // การตอบกลับ
}

หากคุณต้องการเมธอดเพิ่มเติม โปรดติดต่อฝ่ายสนับสนุนลูกค้า