sms api

HƯỚNG DẪN TÍCH HỢP API SMS ABENLA

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ề:

<CheckConnectionResponseMessage xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>

<Code>106</Code>

<Message>Success</Message>

</CheckConnectionResponseMessage>

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ố 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
Amount String Số tiền còn lại trong tài khoản

XML trả về:

<GetBalanceResponseMessage xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”xmlns=”http://tempuri.org/”>

<Code>106</Code>

<Message>Success</Message>

<Amount>100000</Amount>

</GetBalanceResponseMessage>

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ố 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ề:

<GetBrandNameResponseMessage xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”xmlns=”http://tempuri.org/”>

<Code>106</Code>

<Message>Success</Message>

<BrandNameList>

<string>BrandName1</string>

<string>BrandName2</string>

</BrandNameList>

</GetBrandNameResponseMessage>

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
serviceTypeId String X Mã dịch vụ Khách hàng đã sử dụng để gửi Sms
createdDate 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ề:

<GetSmsStatusResponseMessage xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”xmlns=”http://tempuri.org/”>

<Code>106</Code>

<Message>Success</Message>

<SmsStatus>1</SmsStatus>

<SentDate>2013-03-12T20:10:37</SentDate>

</GetSmsStatusResponseMessage>

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.

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 Khách hàng muốn sử dụng
serviceTypeId 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)-brandName-serviceTypeId

MD5 chuỗi trên

Nội dung tin nhắn có cấu trúc như sau:

<ListSms>

<Sms>

<PhoneNumber>097xxxxxxx</PhoneNumber>

<Message>Noi dung 1</Message>

<SmsGuid>32e2be93-c7d3-4c69-9</SmsGuid>

<ContentType>1</ContentType>

</Sms>

<Sms>

<PhoneNumber>090xxxxxxx</PhoneNumber>

<Message>Noi dung 2</Message>

<SmsGuid>39faeb8e-8374-42fd-8</SmsGuid>

<ContentType>1</ContentType>

</Sms>

<Sms>

<PhoneNumber>091xxxxxxx </PhoneNumber>

<Message>Noi dung 3</Message>

<SmsGuid>72719174-fad9-4835-b</SmsGuid>

<ContentType>1</ContentType>

</Sms>

</ListSms>

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
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:

<SendSmsResponseMessage xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”xmlns=”http://tempuri.org/”>

<Code>106</Code>

<Message>Success</Message>

<SmsFailList/>

<TotalSuccessSms>1</TotalSuccessSms>

<TotalFailSms>0</TotalFailSms>

</SendSmsResponseMessage>

  • Tin nhắn gửi thất bại:

<SendSmsResponseMessage xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”xmlns=”http://tempuri.org/”>

<Code>110</Code>

<Message>Success</Message>

<SmsFailList>

<string>32e2be93-c7d3-4c69-9</string>

<string>6c6d009d-bed2-4d20-8</string>

</SmsFailList>

<TotalSuccessSms>0</TotalSuccessSms>

<TotalFailSms>2</TotalFailSms>

</SendSmsResponseMessage>

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ề:

<GetServiceTypeListResponseMessage xmlns=”http://tempuri.org/” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>

<Code>106</Code>

<Message>Success</Message>

<ServiceTypeList>

<SubServiceType>

<ServiceTypeId>1</ServiceTypeId>

<ServiceTypeName>BrandName</ServiceTypeName>

</SubServiceType>

</ServiceTypeList>

</GetServiceTypeListResponseMessage>

7. GetBrandTemplate

Lấy danh sách mẫu tin nhắn của một brand name đã đượ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)- brandName

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 mẫu tin nhắn Khách hàng đăng ký thành công

XML trả về:

<?xml version=”1.0″ encoding=”utf-8″?>

<GetBrandTemplateResponseMessage xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns=”http://api.abenla.com/”>

<Code>106</Code>

<Message>Success</Message>

<TemplateList>

<string>Test Brand Template</string>

</TemplateList>

</GetBrandTemplateResponseMessage>

8. Phụ lục

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 Brand Name
109 Quá số lượng tin gửi trong một lần
110 Tin nhắn gửi thất bại
111 Sai mã dịch vụ

b. Bảng trạng thái tin nhắn

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