Tạo và gửi mã xác thực tự động bằng tin nhắn SMS

Để đáp ứng nhu cầu của người dùng về việc tự động tạo mã xác thực và gửi qua tin nhắn thương hiệu (SMS Brandname), chúng tôi đã thiết kế hai API: GENCODE để tạo mã và CHECKCODE để kiểm tra mã, giúp tối ưu hóa quy trình xác thực.

GENCODE: Tạo mã xác thực/mã OTP tự động, sau đó gửi tin nhắn đến máy khách hàng qua tin nhắn SMS.

CHECKCODE: Kiểm tra xem mã đã tạo có hợp lệ hay không, giúp xác minh tính đúng đắn và đảm bảo an toàn khi sử dụng.

• Lưu ý: khách hàng cần đăng ký brandname và template trước khi sử dụng API này.

• GENCODE: tạo và gửi mã xác thực tự động

GET https://rest.esms.vn/MainService.svc/json/SendMessageAutoGenCode_V4_get?Phone={{Phone}}&ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&TimeAlive={{TimeAlive}}&NumCharOfCode={{NumCharOfCode}}&Brandname={{Brandname}}&Type=2&message={{Content}}

• Response Type: application/json

curl --location --globoff 'https://rest.esms.vn/MainService.svc/json//SendMessageAutoGenCode_V4_get?Phone=0901888484&ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&TimeAlive=2&Brandname=Baotrixemay&Type=2&message={OTP} la ma xac minh dang ky Baotrixemay cua ban'

• Cấu trúc body của request:

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
Phone	string		Số điện thoại nhận tin.
ApiKey	string		ApiKey của tài khoản.
SecretKey	string		Secretkey của tài khoản.
TimeAlive	string		Thời gian hiệu lực của mã code. Đơn vị tính: Phút. Giới hạn từ 2 phút đến 10 phút.
NumCharOfCode	string		Số lượng ký tự của mã code. Mặc định khi không truyền là 6 ký tự.
Brandname	string		Tên Brandname (tên công ty hay tổ chức khi gửi tin sẽ hiển thị trên tin nhắn đó). Chú ý: sẽ phải đăng ký trước khi sử dụng.
Type	string		2: Gửi chăm sóc khách hàng.
message	string		Nội dung tin nhắn Thay thế mã code OTP bằng {OTP} - Ví dụ: Muốn nhận tin nhắn về máy với nội dung: "686868 la ma xac minh dang ky Baotrixemay cua ban". Thì ở mục message truyền: "{OTP} la ma xac minh dang ky Baotrixemay cua ban".
IsNumber	string		0: code chứa chữ và số. 1: code chỉ chứa số.

---

• Response:

100

{
    "CodeResult": "100",
    "CountRegenerate": 0,
    "SMSID": "d533459ee42b2b9525ba9eabf6a8156"
}

Request hợp lệ.

101

{
    "CodeResult": "101",
    "CountRegenerate": 0,
    "ErrorMessage": "Authorize Failed"
}

Sai thông tin ApiKey/SecretKey.

• Cấu trúc body của response:

Thuốc tính	Kiểu dữ liệu	Mô tả
CodeResult	string	Mã trả về.
SMSID	string	ID tin nhắn do esms trả về.
ErrorMessage	string	Thông tin lỗi trả về (nếu có lỗi).

• CHECKCODE: Kiểm tra xem mã đã tạo có hợp lệ hay không

GET https://rest.esms.vn/MainService.svc/json/CheckCodeGen_V4_get?ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&Phone={{{Phone}}&Code={{Code}}

• Response Type: application/json

curl --location --globoff 'https://rest.esms.vn/MainService.svc/json/CheckCodeGen_V4_get?ApiKey={{ApiKey}}&SecretKey={{SecretKey}}&Phone=0901888484&Code=1NTTJ6'

• Cấu trúc body của request:

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
ApiKey	string		ApiKey của tài khoản.
SecretKey	string		Secretkey của tài khoản.
Phone	string		Số điện thoại người nhận code.
Code	string		Mã code cần check.

• Response:

100

{
 "CodeResult": "100",
 "CountRegenerate": 0,
 "ErrorMessage": "0901888484, Content: Success!"
}

Request hợp lệ.

101

{
    "CodeResult": "101",
    "CountRegenerate": 0,
    "ErrorMessage": "Authorize Failed"
}

Sai thông tin ApiKey/SecretKey.

117

{
    "CodeResult": "117",
    "CountRegenerate": 0,
    "ErrorMessage": "0901888484, Content: 1NTTJ6 Code Invalid"
}

Mã code đã được sử dụng hoặc hết thời gian hiệu lực.

• Cấu trúc body của response:

Thuộc tính	Kiểu dữ liệu	Mô tả
CodeResult	string	Request được gửi đến ESMS thành công.
ErrorMessage	string	Thông tin lỗi trả về (nếu có lỗi).
Content	string	Trạng thái của code.

• Thông tin chi tiết mã lỗi xem ở bảng: Mã lỗi .

• Lấy code mẫu các ngôn ngữ trên Postman: Link code mẫu.