Gửi tin nhắn truyền thông broadcast

Chúng tôi cung cấp một API gửi tin nhắn truyền thông broadcast, 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": "promotion",
                "promotion": {
                    "label": "🎉 Tin quảng cáo",
                    "title": "ĐỘC QUYỀN TẠI COMMUNI",
                    "description": "🎉 Chương trình khuyến mãi đặc biệt: Giảm giá 20% cho tất cả sản phẩm!",
                    "image_url": "https://thumb-i-1.piscale.com/\u003cwidth\u003ex\u003cheight\u003e/smart/100001/100001/54131165-2671-4b5d-8545-3248749d3107/bot.png",
                    "buttons": [
                        {
                            "label": "Hotline",
                            "action": {
                                "type": 1,
                                "payload": "tel:0123456789"
                            }
                        },
                        {
                            "label": "Chi tiết chương trình",
                            "action": {
                                "type": 1,
                                "payload": "https://docs.communi.io/docs/overview"
                            }
                        },
                        {
                            "label": "{your_setup_text_of_bot_flow}",
                            "action": {
                                "type": 2,
                                "payload": "menu_{your_setup_text_of_bot_flow}"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

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à "promotion"	✓
body.metadata[0].promotion.label	string	Nhãn của tin nhắn truyền thông, tối đa 100 kí tự.	✗
body.metadata[0].promotion.title	string	Tiêu đề của tin nhắn truyền thông, tối đa 300 kí tự.	✓
body.metadata[0].promotion.image_url	string	Đường dẫn ảnh	✓
body.metadata[0].promotion.description	string	Nội dung mô tả, tối đa 1000 kí 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 buttons:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
buttons[i].label	string	Nội dung hiển thị, tối đa 100 kí tự.	✓
buttons[i].action.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].action.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