SMS API ABENLA (SMS Application Programing Interface) là giao thức kết nối sử dụng sms thông qua API như: kiểm tra các kết nối đến hệ thống sms, kiểm tra tài khoản, lấy trạng thái tin nhắn đã gửi, gửi tin nhắn đến hàng loạt số phone,…giúp cho việc lập trình SMS trở nên dễ dàng. Tại ABENLA, chúng tôi đảm bảo tính nhanh, đơn giản, tin cậy và dễ dàng tích hợp vào bất kỳ hệ thống nào.
1. Checkconnection
Kiểm tra kết nối tới hệ thống Sms.
Các tham số:
| Tham số | Kiểu dữ liệu | Bắt buộc | Mô tả |
| loginName | String | X | Tài khoản đăng nhập hệ thống |
| Sign | String | X | loginName-MD5(sendSMSPassword)
MD5 chuỗi trên |
Tham số trả về
| Tham số | Kiểu dữ liệu | Mô tả |
| Code | String | Tham chiếu bảng mã lỗi ở phụ lục |
| Message | String | Nội dung thông báo |
XML trả về:
106
Success
2. GetBalance
Lấy về số tiền còn lại trong tài khoản Khách hàng.
Các tham số:
| Tham số | Kiểu dữ liệu | Bắt buộc | Mô tả |
| loginName | String | X | Tài khoản đăng nhập hệ thống |
| Sign | String | X | loginName-MD5(sendSMSPassword)
MD5 chuỗi trên |
| Tham số | Kiểu dữ liệu | Mô tả |
| Code | String | Tham chiếu bảng mã lỗi ở phụ lục |
| Message | String | Nội dung thông báo |
| Amount | String | Số tiền còn lại trong tài khoản |
XML trả về:
106
Success
100000
3. GetBrandName
Lấy về danh sách Brand Name Khách hàng đã đăng ký thành công.
Các tham số:
| Tham số | Kiểu dữ liệu | Bắt buộc | Mô tả |
| loginName | String | X | Tài khoản đăng nhập hệ thống |
| Sign | String | X | loginName-MD5(sendSMSPassword)
MD5 chuỗi trên |
| Tham số | Kiểu dữ liệu | Mô tả |
| Code | String | Tham chiếu bảng mã lỗi ở phụ lục |
| Message | String | Nội dung thông báo |
| BrandNameList | Array | Danh sách Brand Name Khách hàng đăng ký thành công |
XML trả về:
106
Success
BrandName1
BrandName2
4. GetSmsStatus
Lấy trạng thái của tin nhắn Khách hàng đã gửi trước đó.
Các tham số:
| Tham số | Kiểu dữ liệu | Bắt buộc | Mô tả |
| loginName | String | X | Tài khoản đăng nhập hệ thống |
| smsGuid | String | X | SmsId lưu tại hệ thống Khách hàng |
| serviceTypeld | String | X | Mã dịch vụ Khách hàng đã sử dụng để gửi Sms |
| createdDay | String | X | Ngày gửi tin nhắn. Theo định dạng yyymmdd |
| sign | String | X | loginName-MD5(sendSmsPassword)-smsGuid-serviceTypeId-createdDate
MD5 chuỗi trên |
Tham số trả về:
| Tham số | Kiểu dữ liệu | Mô tả |
| Code | String | Tham chiếu bảng mã lỗi ở phụ lục |
| Message | String | Nội dung thông báo |
| SmsStatus | String | Trạng thái tin nhắn. Tham khảo bảng trạng thái tin nhắn ở phụ lục |
| SentDate | String | Thời gian gửi tin cụ thể |
XML trả về:
106
Success
1
2013-03-12T20:10:37
5. SendSms
Gửi danh sách tin nhắn đến hệ thống Sms System. Tối đa một gói là 100 tin nhắn.
| Tham số | Kiểu dữ liệu | Bắt buộc | Mô tả |
| loginName | String | X | Tài khoản đăng nhập hệ thống |
| smsGuid | String | X | SmsId lưu tại hệ thống Khách hàng |
| serviceTypeld | String | X | Mã dịch vụ Khách hàng đã sử dụng để gửi Sms |
| Content | String | X | Nội dung tin nhắn. Cấu trúc nội dung tin nhắn tham khảo bên dưới |
| sign | String | X | loginName-MD5(sendSmsPassword)-smsGuid-serviceTypeId-createdDate
MD5 chuỗi trên |
Nội dung tin nhắn có cấu trúc như sau:
097xxxxxxx
Noi dung 1
32e2be93-c7d3-4c69-9
1
090xxxxxxx
Noi dung 2
39faeb8e-8374-42fd-8
1
091xxxxxxx
Noi dung 3
72719174-fad9-4835-b
1
| Tham số | Kiểu dữ liệu | Mô tả |
| Code | String | Tham chiếu bảng mã lỗi ở phụ lục |
| Message | String | Nội dung thông báo |
| SmsFailList | String | Danh sách SmsId (Id tại hệ thống Khách hàng) không được lưu vào hệ thống |
| TotalSucessSms | String | Tổng tin lưu thành công vào hệ thống |
| TotalFailSms | String | Tổng tin xử lý thất bại |
XML trả về:
Tin nhắn gửi thành công:
106
Success
1
0
Tin nhắn gửi thất bại:
110
Success
32e2be93-c7d3-4c69-9
6c6d009d-bed2-4d20-8
0
2
6. GetServiceTypeList
Lấy danh sách dịch vụ trong tài khoản của Khách hàng.
Các tham số:
| Tham số | Kiểu dữ liệu | Bắt buộc | Mô tả |
| loginName | String | X | Tài khoản đăng nhập hệ thống |
| Sign | String | X | loginName-MD5(sendSMSPassword)
MD5 chuỗi trên |
Tham số trả về:
| Tham số | Kiểu dữ liệu | Mô tả |
| Code | String | Tham chiếu bảng mã lỗi ở phụ lục |
| Message | String | Nội dung thông báo |
| BrandNameList | Array | Danh sách Brand Name Khách hàng đăng ký thành công |
XML trả về:
106
Success
1
BrandName
7. GetBrandTemplate
Lấy danh sách mẫu tin nhắn của một SMS API ABENLA đã được duyệt bởi nhà mạng.
Các tham số:
| Tham số | Kiểu dữ liệu | Bắt buộc | Mô tả |
| loginName | String | X | Tài khoản đăng nhập hệ thống |
| Brandname | String | X | Brand name muốn lấy mẫu tin nhắn |
| Sign | String | X | loginName-MD5(sendSMSPassword)
MD5 chuỗi trên |
| Tham số | Kiểu dữ liệu | Mô tả |
| Code | String | Tham chiếu bảng mã lỗi ở phụ lục |
| Message | String | Nội dung thông báo |
| BrandNameList | Array | Danh sách Brand Name Khách hàng đăng ký thành công |
XML trả về:
106
Success
Test Brand Template
8. Phụ lục SMS API ABENLA
a. Bảng mã lỗi
| Mã lỗi | Mô tả |
| 100 | Lỗi khác |
| 101 | Sai loginName |
| 102 | Sai mật khẩu |
| 103 | Tài khoản chưa được kích hoạt |
| 104 | Không thể truy cập (IP không được phép) |
| 105 | Tài khoản hết tiền |
| 106 | Xử lý yêu cầu thành công |
| 107 | Sai chữ ký |
| 108 | Sai Brandname |
| 109 | Quá số lượng tin gửi trong một lần |
| 110 | Tin nhắn gửi thất bại |
b. Bảng trạng thái tin nhắn
| Mã | Mô tả |
| 1 | Tin nhắn đang trong hàng đợi |
| 2 | Tin nhắn đang được gửi tới nhà mạng |
| 3 | Tin nhắn gửi thành công |
| 4 | Tin nhắn gửi thất bại |
| 5 | Số điện thoại nhận không hợp lệ |
| 6 | Tài khoản hết hạn sử dụng |
| 7 | Tài khoản hết tiền |
| 8 | Không có bảng giá cho tin nhắn này |
| 9 | Không thể gửi tin nhắn đi (vì một số lý do khách quan) |
| 10 | Số điện thoại nằm trong danh sách từ chối nhận tin |
| 11 | Tin nhắn chưa tới thời gian gửi |
