Gửi tin nhắn hình ảnh
Chúng tôi cung cấp một API gửi tin nhắn hình ảnh, 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": [
{
"name": "img.png",
"width": 1000,
"height": 1000,
"source_url": "https://image.shutterstock.com/image-photo/mountains-under-mist-morning-amazing-260nw-1725825019.jpg",
"source_thumb_url": "https://image.shutterstock.com/image-photo/mountains-under-mist-morning-amazing-260nw-1725825019.jpg",
"size": 121200,
"type": "image"
}
],
"custom_notify": {
"title": "Custom title",
"subtitle": "Custom subtitle",
"avatar_url": "https://avatar_url.png",
"image_url": "https://image_url.png"
}
}
}
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 | array | Danh sách hình ảnh | ✓ |
body.custom_notify.title | string | Tiêu đề của thông báo tùy chỉnh | ✗ |
body.custom_notify.subtitle | string | Phụ đề của thông báo tùy chỉnh | ✗ |
body.custom_notify.avatar_url | string | URL của hình ảnh đại diện được hiển thị trong thông báo | ✗ |
body.custom_notify.image_url | string | URL của hình ảnh chính được hiển thị trong thông báo | ✗ |
note
sender
sẽ bắt buộc phải cóbot_id
hoặcuser_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ặcuser_ids
.user_ids
tối đa 100 phần tử.
Giải thích các thuộc tính của metadata:
Tên | Kiểu dữ liệu | Mô tả | Bắt buộc |
---|---|---|---|
type | string | Phải là "image" | ✓ |
name | string | Tên ảnh | ✓ |
width | int | Chiều rộng ảnh | ✓ |
height | int | Chiều cao ảnh | ✓ |
size | int | Kích cỡ của ảnh | ✓ |
source_url | string | Url ảnh được hiển thị khi người dùng muốn xem chi tiết | ✓ |
source_thumb_url | string | Url ảnh có dung lượng thấp được hiển thị ở danh sách tin nhắn | ✓ |
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 |