Send Message

API

Ý nghĩa: Api dùng để gửi tin nhắn đến người nhận theo số điện thoại.

POST $BASE_URL/api/vendor/v1/sms/send-message

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

Thông tin Request

• Method: POST

• URL: /api/vendor/v1/sms/send-message

• Headers:

  • accept: */*

  • Content-Type: application/json

  • API-KEY: {API_KEY}

• Parameters:

  • API-KEY: Key License

• Body:

  • destinations: Danh sách các số điện thoại (string) nhận tin
  • from: Tên Brandname dùng để gửi tin
  • templateId: Id Template SMS
  • text: Nội dung tin
  • scheduled: Gửi tin đặt lịch
  • requestId: ID định danh của đối tác
  • useUnicode: Gửi tin Unicode
  • type: Loại gửi tin
  • ext: Trường dự phòng, có thể bỏ trống.

• Cấu trúc request

Key	Type Value	Required	Description
API-KEY header	string	true	Key License
destinations body	array	true	Danh sách các số điện thoại (string) nhận tin
from body	string	true	Tên Brandname dùng để gửi tin
templateId body	string	true	Id Template SMS
text body	string	true	Nội dung tin
scheduled body	string	false	Gửi tin đặt lịch
requestId body	string	false	ID định danh của đối tác, sẽ gửi lại trong nội dung phản hồi hoặc để trống
useUnicode body	string	true	0: Gửi tin notUnicode 1: Nội dung Unicode 2: Tự động chuyển đổi nội dung Unicode sang notUnicodecode
type body	number	true	0: Tư vấn 1: Quảng cáo 2: OTP
ext body	object	false	Trường dự phòng, có thể bỏ trống

• Ví dụ Request

curl --location 'https://cpaas.interits.com:8080/api/vendor/v1/sms/send-message' \
--header 'API-KEY: EImADVLv3tjE0ExErTkhTbKxBWeWwhY' \
--header 'Content-Type: application/json' \
--data '{
  "destinations": [
    "0869952231"
  ],
  "templateId": "Example",
  "from": "InterITS",
  "text": "GIỖ TỔ HÙNG VƯƠNG 10/03",
  "scheduled": "2025-04-23T17:04:04.000Z",
  "requestId": "",
  "useUnicode": 1,
  "type": 0,
  "ext": {}
}'

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
to	string	Số điện thoại người nhận
telco	string	Không quan tâm
type	number	Loại tin tương ứng với request
from	string	Brandname gửi
message	string	Nội dung tin nhắn
scheduled	string	Lịch gửi tin
requestId	string	ID định danh của tối tác được gửi từ request
useUnicode	number	0: Gửi tin notUnicode 1: Nội dung Unicode 2: Tự động chuyển đổi nội dung Unicode sang notUnicodecode
ext	string	Không quan tâm

• Ví dụ Response

{
    "code": 200,
    "data": {
        "to": "84869952231",
        "telco": "04",
        "type": 1,
        "from": "InterITS",
        "message": "GIỖ TỔ HÙNG VƯƠNG 10/03",
        "scheduled": "24-04-2025 00:04",
        "requestId": "",
        "useUnicode": 1,
        "ext": {}
    },
    "message": "Success",
    "referentId": "API_CSKH_interITStest1_46ebe14e4bbd4ad0b84406dbcb5747d0"
}

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ệ message: NoError: Không lỗi InputNotValid: Có lỗi giá trị không phù hợp với kiểu dữ liệu mô tả TokenNotValid: Token không hợp lệ UserIsLock: Tài khoản bị khóa UserNotValid: Tài khoản không đúng UserNotRoleValid: Tài khoản không có quyền DuplicateMessage: Tin bị lặp trong 5 phút hoặc trùng requestID trong 1h BrandnameNotValid: Brandname không hợp lệ MessageTypeNotValid: Loại tin không hợp lệ MessageTypeNotAllow: Loại tin không được phép gửi ReceiverNotValid: Số điện thoại nhận không hợp lệ TelcoNotValid: Mã nhà mạng không hợp lệ ContentContainsBlockedWord: Token không hợp lệ ContentContainsUnicode: Nội dung chứa ký tự unicode ContentNotValidateGsm0338: Nội dung có ký tự không hợp lệ LengthOfContentNotValid: Độ dài nội dung không hợp lệ NotMatchTemplate: Nội dung không khớp với mẫu khai NotMatchTemplatePriority: Nội dung không khớp với mẫu tin ưu tiên (OTP) TelcoNotAllow: Tài khoản không được phân gửi tới nhà mạng MsisdnInBlacklist: Số điện thoại nhận trong danh sách cấm gửi AccountNotEnoughToPay: Tài khoản không đủ tiền để chi trả AccountNotEnoughQuota: Tài khoảng không đủ tin để gửi ScheduledNotValid: Thời gian gửi tin không hợp lệ OrderCodeNotValid: Mã order không hợp lệ PackageCodeNotValid: Mã gói không hợp lệ MsisdnNotValid: Số điện thoại không hợp lệ đói với hàm gửi tin CSKH ReceiverNotEnough: Số điện thoại nhận không đủ đối với hàm gửi tin QC TelcoFilter: Số điện thoại không trong danh sách nhà mạng được lọc BlockingTimeAdv: Gửi vào thời điểm bị cấm gửi quảng cáo FormatOfContentNotValid: Định dạnh nội dung không hợp lệ OverMaxMT: Số MT vượt quá giới hạn maxMt CantConvertToNotUnicode: Không thể Convert sang ký tự NotUnicode (Áp dụng trường hợp sử dụng tham số useUnicode(2)) TemplateNotSet: Mẫu tin chưa được thiết lập AccountNotSetProfile: Tài khoản chưa được thiết lập profile AccountNotSetPrice: Tài khoản chưa được thiết lập giá RouterNotAvaiable: Đường gửi tin chưa được thiết lập RouterNotSuportUnicode: Đường gửi tin không hỗ trợ unicode ErrorOnServer: Lỗi khác trên hệ thống
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ợ.