Gửi tin nhắn dạng thẻ

Chúng tôi cung cấp một API gửi tin nhắn dạng thẻ, dưới định danh của người dùng hoặc bot.

HTTP request

POST https://{app_id}.api.piscale.com/open-api/v1.0/chat/messages

Request body

Ví dụ

{
  "sender": {
        // "bot_id": "6872016393689131",
        "user_id": "30043"
    },
    "target": {
        // "user_ids": ["30043"]
        "thread_id": "62046069159700"
    },
  "body": {
    "text": "",
    "metadata": [
      {
        "type": "card",
        "cards": [
          {
            "title": "📱Communi Chat SDK",
            "sub_title": "Tích hợp Chat vào ứng dụng của bạn một cách dễ dàng. Tạo ra trải nghiệm người dùng hấp dẫn với bộ tính năng đầy đủ và hệ thống Chatbot AI được thiết kế riêng cho ứng dụng của bạn",
            "image_url": "https://image-1.piscale.com/100001/100001/d5d287ec-a35a-4b4e-8887-8011706c356b/Screenshot_2023-11-20_at_13_53_39.png",
            "buttons": [
              {
                "label": "🌐 Truy cập Website",
                "action": {
                  "type": 1,
                  "payload": "https://www.communi.io/in-app-chat"
                }
              },
              {
                "label": "✅ Tính năng",
                "action": {
                  "type": 2,
                  "payload": "send_chat_feature"
                }
              },
              {
                "label": "📞 Liên hệ",
                "action": {
                  "type": 2,
                  "payload": "contact"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
sender.bot_id	string	Gửi dưới định dạng bot	✗
sender.user_id	string	Gửi dưới định danh user	✗
target.user_ids	array	Danh sách các user_id nhận	✗
target.thread_id	string	Mã cuộc hội thoại	✗
body.text	string	Nội dung văn bản	✓
body.metadata[0].type	string	Phải là card	✓
body.metadata[0].cards	array	Danh sách các thẻ, tối đa 10 phần tử.	✓

note

• sender sẽ bắt buộc phải có bot_id hoặc user_id. Người gửi tin phải xác định rõ là một chương trình tự động (bot) hoặc là một người dùng.
• target sẽ bắt buộc phải có thread_id hoặc user_ids. user_ids tối đa 100 phần tử.
• Metadata chỉ có 1 phần tử

Giải thích các thuộc tính của cards:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
cards[i].title	string	Tiêu đề của thẻ	✓
cards[i].sub_title	string	Phụ đề của thẻ	✗
cards[i].image_url	string	Ảnh của thẻ	✗
cards[i].buttons	array	Danh sách các nút của thẻ, tối đa 5 nút.	✓

Giải thích các thuộc tính của buttons:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
button[i].label	string	Hiển thị nội dung của nút	✓
buttons[i].type	int	1:uri xử lý ở phía client như gọi điện hoặc gửi email hoặc đi đến url được config ở payload, 2: gửi text và đẩy lại thông tin của payload qua webhook_url của bot đã được thiết lập, 3: chỉ gửi text vào cuộc hội thoại.	✓
buttons[i].payload	string	Dữ liệu tương ứng với action.type: 1 hoặc 2	✗

Response

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ

{
    "message_code": "M200",
    "message": "Success"
}

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã thông điệp. Xem chi tiết
message	string	Nội dung mã thông điệp