Send Image
API
API này dùng để gửi hình ảnh qua Viber. API này cho phép bạn gửi một tin nhắn chứa hình ảnh cùng với các thông tin khác như caption, URL hành động, và các thông tin về người gửi và người nhận.
POST $BASE_URL/api/vendor/v1/viber/send-image
Lưu ý
- API-KEY: là duy nhất
- Các bước lấy API-KEY:
- Doanh nghiệp đăng nhập
- Di chuyển đến trang Key (hoặc License)
- Lấy 1 API-KEY thỏa mãn điều kiện hoạt động
- Người dùng phải đã tương tác với Official Account (OA) Zalo thì mới có user_id để dùng vào request (lấy user_id thì cần nhắn yêu cầu tới Zalo OA)
Thông tin Request
- Method:
POST - URL:
/api/vendor/v1/viber/send-image - Headers:
accept: */*Content-Type: application/jsonAPI-KEY: {API_KEY}
- Parameters:
API-KEY: Key License
- Body:
requestId: Chuỗi số hợp lệ dùng để định danh request. Được trả về trong trườngseqcủa response.fromName: Tên hiển thị người gửi (brand name hoặc tên công ty).to: Số điện thoại người nhận, bắt đầu bằng mã quốc gia. Ví dụ: 84968243562.serviceId: Sender_ID của brandname.priceConfigId: ID gói cước gửi tin đã được cấu hình tương ứng với loại tin cần gửi.urlImg: URL của hình ảnh cần gửi, hình ảnh phải có sẵn trên một server công khai hoặc có thể truy cập qua internet.message: Nội dung tin nhắn đính kèm ảnh. Tối đa 1000 ký tự. Truyền chuỗi rỗng nếu không gửi kèm văn bản.caption: Nội dung hiển thị trên nút đính kèm. Có thể truyền chuỗi rỗng. Ví dụ: “Click me”.urlAction: URL cho hành động khi nhấp vào nút đính kèm. Có thể truyền chuỗi rỗng. Ví dụ: “https://interits.com”. Nếu truyền giống với urlImg, ảnh sẽ được mở trong trình duyệt của người dùng khi nhấp vào nút.tracking: true | false - Hệ thống sinh thêm dữ liệu tracking hoặc không áp dụng (Default: false).
- Cấu trúc request
| Key | Type Value | Required | Description |
|---|---|---|---|
API-KEY header | string | true | Key License |
requestId body | string | true | Mã định danh yêu cầu – do client tự tạo, giúp truy vết/log khi cần.. |
fromName body | string | true | Tên hiển thị người gửi (brand name hoặc tên công ty). |
to body | string | true | Số điện thoại người nhận (định dạng quốc tế, ví dụ: "84901234567"). |
serviceId body | string | true | Sender_ID của brandname |
priceConfigId body | string | true | ID gói cước gửi tin đã được cấu hình tương ứng với loại tin cần gửi |
urlImg body | string | true | URL của hình ảnh cần gửi, hình ảnh phải có sẵn trên một server công khai hoặc có thể truy cập qua internet. |
message body | string | true (Nếu gửi kèm nút) | Nội dung tin nhắn đính kèm ảnh. Tối đa 1000 ký tự. Truyền chuỗi rỗng nếu không gửi kèm văn bản. |
caption body | string | true (Nếu gửi kèm nút) | Nội dung hiển thị trên nút đính kèm. Có thể truyền chuỗi rỗng. Ví dụ: “Click me” |
urlAction body | string | true (Nếu gửi kèm nút) | URL cho hành động khi nhấp vào nút đính kèm. Có thể truyền chuỗi rỗng. Ví dụ: “https://interits.com”. Nếu truyền giống với urlImg, ảnh sẽ được mở trong trình duyệt của người dùng khi nhấp vào nút. |
tracking body | boolean | optional | true/false - Hệ thống sinh thêm dữ liệu tracking hoặc không áp dụng (Default: false). |
- Ví dụ Request
curl --location 'https://cpaas.interits.com:8080/api/vendor/v1/viber/send-image' \
--header 'API-KEY: EImADVLv3tjE0ExErTkhTbKxBWeWwhY' \
--header 'Content-Type: application/json' \
--data '{
"priceConfigId": "68a684b4b1eedd71813f79a7",
"requestId": "1755849609105",
"channel": "viber",
"fromName": "InterITS",
"serviceId": 34939,
"to": "84961672190",
"caption": "Click me!",
"urlAction": "https://cpaas.interits.com:3030",
"urlImg": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTth0gx3Dco0TDOLCFmZWCe-Aoq1sluOca7PA&s",
"message": "Chào bạn! Tôi là Viber"
}'
Thông tin Response
Mô tả: Mô tả dữ liệu trả về dùng làm gì
- Cấu trúc data của response
| Key | Type | Description |
|---|---|---|
| code | number | Status Code của Request |
| status | number |
|
| message_token | number | Mã định danh tin nhắn |
| message | string | Status Message của Request |
| referentId | number | Mã định danh tin nhắn |
- Ví dụ Response
{
"code": 200,
"data": {
"status": 0,
"seq": 1755850381044,
"message_token": "6139591178693331555"
},
"message": "Success",
"referentId": "6139591178693331555"
}
Bảng Status Response
| Status Code | Status Message | Description |
|---|---|---|
| 200 | OK | Yêu cầu đã thành công và server trả về kết quả. |
| 201 | Created | Yêu cầu đã thành công và server đã tạo ra tài nguyên mới. |
| 204 | No Content | Yêu cầu đã thành công nhưng không có nội dung trả về. |
| 400 | Bad Request | Server không thể hiểu yêu cầu do cú pháp không hợp lệ. |
| 401 | Unauthorized | Cần xác thực để truy cập tài nguyên. |
| 403 | Forbidden | Server từ chối thực hiện yêu cầu, mặc dù người dùng đã xác thực. |
| 404 | Not Found | Tài nguyên yêu cầu không tồn tại trên server. |
| 405 | Method Not Allowed | Phương thức HTTP không được phép cho tài nguyên yêu cầu. |
| 500 | Internal Server Error | Lỗi không xác định trong server. |
| 502 | Bad Gateway | Server là một gateway hoặc proxy và nhận được phản hồi không hợp lệ từ server khác. |
| 503 | Service Unavailable | Server không thể xử lý yêu cầu do quá tải hoặc bảo trì. |
| 504 | Gateway Timeout | Server không nhận được phản hồi kịp thời từ server phụ trợ. |