Send Text

API

API này dùng để gửi tin nhắn văn bản (text message) đến một người dùng Viber thông qua tài khoản Viber Official (doanh nghiệp).

POST $BASE_URL/api/vendor/v1/viber/send-text

Lưu ý

API-KEY: là duy nhất
Các bước lấy API-KEY:
1. Doanh nghiệp đăng nhập
2. Di chuyển đến trang Key (hoặc License)
3. 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-text
Headers:
- accept: */*
- Content-Type: application/json
- API-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ường seq củ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.
- message: Nội dung tin nhắn. Tối đa 1000 ký tự.
- 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”.
- 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
message `body`	string	true	Nội dung tin nhắn. Tối đa 1000 ký tự.
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”.
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-text' \
--header 'API-KEY: EImADVLv3tjE0ExErTkhTbKxBWeWwhY' \
--header 'Content-Type: application/json' \
--data '{
  "priceConfigId": "68a7d376c90fc8fcb1aff366",
  "requestId": "1755850604680",
  "channel": "viber",
  "fromName": "InterITS",
  "serviceId": 34939,
  "to": "84961672190",
  "caption": "Click me!",
  "urlAction": "https://cpaas.interits.com:3030",
  "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	`0`: Thành công `1`: Lỗi máy chủ nội bộ. `2`: ID đã không được sử dụng trong hơn một năm/ID mới được tạo gần đây và chưa được tải lên máy chủ. `3`: Lỗi trong cấu trúc yêu cầu. Có thể là thiếu dấu phẩy, dấu ngoặc, văn bản dài hơn 1000 ký tự, v.v. `5`: Kiểu tin nhắn không đúng. Có thể là kiểu không được hỗ trợ hoặc giá trị không đúng. `6`: Thiếu các tham số bắt buộc, ví dụ: "tracking_data" khi sử dụng loại tin nhắn có thể trả lời. `7`: Chỉ ra thời gian chờ của máy chủ ở phía Viber. `8`: ID đã bị người dùng chặn/Người dùng đã chặn hoàn toàn tin nhắn doanh nghiệp trên thiết bị của họ. `9`: Số điện thoại đích không được đăng ký là người dùng Viber. `10`: Không phải thiết bị Android hoặc iOS có phiên bản Viber hỗ trợ Tin nhắn Doanh nghiệp (5.3 trở lên). `13`: Có lỗi trong quá trình thanh toán – vui lòng liên hệ partners@viber.com `18`: Giá trị bị thiếu/Giá trị không chính xác trong yêu cầu cho tham số “nhãn”. `20`: TTL dưới 30 giây/TTL trên 1.209.600 giây. `21`: Nỗ lực này đã vượt quá giới hạn 10 tin nhắn trong một phiên. `28`: Tệp đang được cố gắng gửi không có định dạng được hỗ trợ cho tính năng này. `29`: The name of the file is more than the maximum 25 characters. `30`: In case the thumbnail URL is compiled of more than 1000 characters. `31`: Kích thước của tệp video lớn hơn 200 MB. `32`: Thời lượng video là hơn 600 giây.
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": 1755850604680,
      "message_token": "6139592122826969076"
  },
  "message": "Success",
  "referentId": "6139592122826969076"
}

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ợ.

Send Text

Thông tin Request​

Thông tin Response​

Bảng Status Response​

Thông tin Request

Thông tin Response

Bảng Status Response