Web service qc smsbrandname

1. CÔNG TY VIỄN THÔNG VIETTEL
Mô tả bản tin kết nối với hệ thống nhắn tin quảng cáo
AMS API
Phiên bản tài liệu: v1.0
Hà Nội, 5/2011
1

2. BẢNG GHI NHẬN THAY ĐỔI
*A – Tạo mới, M – Sửa đổi, D – Xóa bỏ
Ngày
thay đổi
Vị trí
thay đổi
A*
M, D
Nguồn gốc Phiên
bản cũ
Mô tả thay đổi Phiên
bản mới
31/05/11 Tất cả tài
liệu
A N/A N/A Tạo mới tài liệu 1.0
2

3. Contents
3

4. I. Tổng quan
1. Mục đích tài liệu
Tài liệu xây dựng cổng kết nối dịch vụ với hệ thống nhắn tin quảng cáo AMS với mục
đích mô tả cách thức kết nối và đặc tả bản tin giao tiếp giữa CP và dịch vụ AMS (AMS
API).
2. Phạm vi
- Lưu hành nội bộ giữa AMS và đối tác.
3. Định nghĩa thuật ngữ và các từ viết tắt
Thuật ngữ Định nghĩa Ghi chú
AMS Advanced Message Service System Hệ thống nhắn quảng cáo
CP Content provider Nhà cung cấp nội dung
CpAdmin Quản trị của CP Mỗi CP sẽ có duy nhất một quản
trị, được tạo ra khi tạo CP. Có
mọi quyền trong phạm vi CP
CpUser User của CP User do CP tạo ra, chỉ có quyền
duy nhất là tạo CTQC
CTQC Chương trình quảng cáo
Bảng 1: Thuật ngữ và định nghĩa
4

5. II.Mô hình thiết kế - triển khai
1. Mô hình tương tác giữa các hệ thống:
Bảng 2: mô hình tương tác
Các thành phần trong mô hình tương tác:
a. CP: đối tác sử dụng dich vụ
b. AMS API: giao diện webservice dịch vụ
c. AMS System: Hệ thống nhắn tin quảng cáo
Thông tin WS
http://125.235.4.202:8999/adapi/Service.asmx?wsdl
hoặc link gán domain http://apismsbrand.viettel.vn:8999/amsapi/Service.asmx?
wsdl
2. Nhóm chức năng tiện ích
Lấy danh sách Alias – getAliases
- Mô tả: Lấy ra toàn bộ danh sách các Alias trên hệ thống AMS.
Request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
5

6. <soapenv:Body>
<tem:getAliases>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
</tem:getAliases>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
cpCode String Mã CP VNP
name String Tên đăng nhập Giống như đăng nhập
trên web
pass String Mật khẩu Giống mật khẩu trên
web
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getAliasesResponse xmlns:ns2="http://tempuri.org/">
<return>
<aliases>1313</aliases>
<aliases>ADSVIETTEL</aliases>
<aliases>AMS VIETTEL</aliases>
<aliases>COOPMART</aliases>
<aliases>DATXANH</aliases>
<aliases>KPLUS</aliases>
<aliases>LCS</aliases>
<aliases>METRO</aliases>
<aliases>QCVIETTEL</aliases>
<aliases>VNPAY</aliases>
<status>1</status>
6

7. </return>
</ns2:getAliasesResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
aliases String Danh sách các Alias QCVIETEL,
ADSVIETTEL, LCS
status Integer Trạng thái bản tin trả về
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
Lấy danh sách CTQC – getProgs
- Mô tả: Lấy toàn bộ mã chương trình (prog_code) của CP.
Request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:getProgs>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
</tem:getProgs>
</soapenv:Body>
</soapenv:Envelope>
7

8. Tham số Kiểu dữ liệu Mô tả Ví dụ
cpCode String Mã CP VNP
name String Tên đăng nhập Giống như đăng nhập
trên web
pass String Mật khẩu Giống mật khẩu trên
web
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProgsResponse xmlns:ns2="http://tempuri.org/">
<return>
<progs>CP_TEST123</progs>
<progs>CP_TEST124</progs>
...
<progs>CP_TEST81</progs>
<status>1</status>
</return>
</ns2:getProgsResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
progs String Mã CTQC
status Integer Trạng thái trả về
Bảng mô tả mã lỗi
Mã lỗi Mô tả
8

9. 0 Thất bại
1 Thành công
Lấy danh sách Category – getCategories
- Mô tả: Lấy ra danh sách các Category trên hệ thống AMS.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:getCategories>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
</tem:getCategories>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
cpCode String Mã CP VNP
name String Tên đăng nhập Giống như đăng nhập
trên web
pass String Mất khẩu đăng nhập Giống như mật khẩu
vào web
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getCategoriesResponse xmlns:ns2="http://tempuri.org/">
<return>
<categories catCode="BD" catName="B¿t d¿ng s¿n - Xây d¿ng"/>
<categories catCode="CK" catName="Ngân hàng, b¿o hi¿m, ch¿ng khoán"/>
9

10. <categories catCode="DL" catName="Du l¿ch "/>
<categories catCode="DT" catName="Ði¿n tho¿i di d¿ng"/>
<categories catCode="ET" catName="Giai tri"/>
<categories catCode="GD" catName="Giáo d¿c - Ðào t¿o"/>
<categories catCode="GT" catName="Giao thông v¿n t¿i"/>
<categories catCode="HM" catName="Hóa m¿ ph¿m- Làm d¿p"/>
<categories catCode="KM" catName="Khuy¿n m¿i"/>
<categories catCode="NH" catName="Ngân hàng"/>
<categories catCode="OT" catName="Oto - Xe máy"/>
<categories catCode="PHIM" catName="Phim ¿nh"/>
<categories catCode="TH" catName="Th¿i trang"/>
<categories catCode="TP" catName="Th¿c ph¿m - п u¿ng"/>
<categories catCode="VT" catName="CNTT- Ði¿n t¿ vi¿n thông"/>
<categories catCode="YT" catName="Y t¿ - Du¿c"/>
<status>1</status>
</return>
</ns2:getCategoriesResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
catCode String Mã category
status Integer Trạng thái trả về
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
10

11. Lấy danh sách Zone – getZones
- Mô tả: Lấy ra danh sách các tỉnh và mã tỉnh.
Request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:getZones>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
</tem:getZones>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
cpCode String Mã CP VNP
name String Tên đăng nhập Giống như đăng nhập
trên web
pass String Mất khẩu đăng nhập Giống như mật khẩu
vào web
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getZonesResponse xmlns:ns2="http://tempuri.org/">
<return>
<status>1</status>
<zones zoneCode="AGG" zoneName="An Giang"/>
<zones zoneCode="BDG" zoneName="Bình Duong"/>
..
<zones zoneCode="VTU" zoneName="Vung Tàu"/>
11

12. <zones zoneCode="YBI" zoneName="Yên Bái"/>
</return>
</ns2:getZonesResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
zoneCode String Mã tỉnh
status Integer Trạng thái trả về
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
3. Nhóm chức năng quản lý User
Tìm kiếm người dùng – searchUser
- Mô tả: Tìm kiếm user trên hệ thống AMS.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:searchUser>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123" />
<tem:userName></tem:userName>
<tem:account>user</tem:account>
<tem:status></tem:status>
</tem:searchUser>
12

13. </soapenv:Body>
</soapenv:Envelope
Tham số Kiểu dữ liệu Mô tả Ví dụ
cpCode String Mã CP VNP
name String Tên đăng nhập Giống như đăng nhập
trên web
pass String Mất khẩu đăng nhập Giống như mật khẩu
vào web
userName String Search theo userName
account String Search theo tên đăng nhập
status String Search theo trạng thai thuê
bao
0: inactive
1: active
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:searchUserResponse xmlns:ns2="http://tempuri.org/">
<return>
<status>1</status>
<users>
<username>userxxx1</username>
<description>user dessc</description>
<account>userxxx</account>
<status>1</status>
<recycle>1</recycle>
</users>
<users>
<username>userbb1</username>
13

14. <description>user dessc</description>
<account>userxxx1</account>
<status>0</status>
<recycle>1</recycle>
</users>
<users>
<username>userbb1</username>
<description>user dessc</description>
<account>userkk</account>
<status>0</status>
<recycle>1</recycle>
</users>
<users>
<username>userbb1</username>
<description>user dessc</description>
<account>userkk1</account>
<status>0</status>
<recycle>1</recycle>
</users>
</return>
</ns2:searchUserResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
userName String Tên User
description String Mô tả User
account String Acc đăng nhập
status Integer Trạng thái User
(active/inactive)
14

15. recycle Integer Trạng thái User (xóa/hoạt
động)
1: chưa xóa
0: đã xóa
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
Tạo người dùng – createUser
- Mô tả: Tạo tài khoản người dùng trên hệ thống AMS, cho phép đăng nhập website.
Request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:createUser>
<!--Optional:-->
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:userName>quangdhx</tem:userName>
<tem:description>quangdhx</tem:description>
<tem:account>quangdhx</tem:account>
<tem:password>quangdhx</tem:password>
</tem:createUser>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
userName String Tên User
15

16. description String Mô tả User
account String Acc đăng nhập
password String Mật khẩu đăng nhập
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createUserResponse xmlns:ns2="http://tempuri.org/">
<return>1</return>
</ns2:createUserResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
result Int Trạng thái trả về
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
Sửa người dùng – updateUser
- Mô tả: Cập nhật người dùng.
Request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
16

17. <tem:updateUser>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:userName>quangdhx1</tem:userName>
<tem:description>quangdhx1</tem:description>
<tem:account>quangdhx</tem:account>
</tem:updateUser>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
userName String Tên User
description String Mô tả User
account String Acc đăng nhập
password String Mật khẩu đăng nhập
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateUserResponse xmlns:ns2="http://tempuri.org/">
<return>1</return>
</ns2:updateUserResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
result Int Trạng thái trả về
Bảng mô tả mã lỗi
17

18. Mã lỗi Mô tả
0 Không thành công
1 Thành công
Xóa người dùng – deleteUser
- Mô tả: Xóa người dùng trên hệ thống AMS.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:deleteUser>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:account>quangdhx</tem:account>
</tem:deleteUser>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
account String Tên đăngn hập cần xóa
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteUserResponse xmlns:ns2="http://tempuri.org/">
<return>1</return>
</ns2:deleteUserResponse>
</S:Body>
</S:Envelope>
18

19. Tham số Kiểu dữ liệu Mô tả Ví dụ
result Int Trạng thái trả về 200
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Không thành công
1 Thành công
Thay đổi mật khẩu – resetPass
- Mô tả: Reset mật khẩu cho người dùng.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:resetPass>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:account>quangdhx</tem:account>
</tem:resetPass>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
account String Acc đăng nhập
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:resetPassResponse xmlns:ns2="http://tempuri.org/">
19

20. <return>
<newPass>2039107</newPass>
<status>1</status>
</return>
</ns2:resetPassResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
result Int Kết quả trả về
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
4. Nhóm chức năng quản lý CTQC
Nhóm các mã chung
Tham số Kiểu dữ liệu Mô tả Ví dụ
progCode String MãCTQC
catCode String Mã Category
createDate String Ngày tạo yyyyMMdd
startDate String Ngày bắt đầu gửi tin
yyyyMMdd
status Int Trạng thái CTQC 0: Từ chối duyệt
1: Chưa duyệt
2: đã duyệt ND
20

21. 3: Test
4: Đang gửi test
5: Kết thúc test
6: Sẵn sàng gửi
7: đang gửi
8: tạm giữ
9: kết thúc
content String Nội dung CTQC
sentStartDate String Ngày bắt đầu – yyyyMMdd
sentFinishDa
te
String Ngày kết thúc – yyyyMMdd
maxSms Int Số SMS tối đa
alias String Alias gửi tin
sentSchedule String Lịch gửi tin Chuỗi ‘1234657’
1 – CN
2 – T2
…
7 – T7
exceptionDa
y
String Ngày ngoại lệ yyyyMMdd VD:
20110101,20110102,…
sentTimeZon
e
Int Khung giờ gửi tin 0: sáng
1: Chiều
2: Cả ngày
createdUser String Người tạo
createdDate String Ngày tạo yyyyMMdd 20110530
priority Int Độ ưu tiên 1  10
sentType Int Loại thuê bao gử tin 0: thuê bao tự up
1: thuê bao Viettel
21

22. 2: thêu bao User DK
qua website
zoneList String Vùng gửi tin HNI, HCM
catList String Các category muốn gửi tin KM,TT…
totalSub Int Số thuê bao tối đa muốn gửi
gender Int Giới tính 0: tất cả, 1: Nam, 2: nữ
minYear Int Tuổi min 0
maxYear Int Tuổi max 100
job Int Nghề nghiệp carrier_list=1__Kinh
doanh;2__Kế
toán;3__Kỹ sư;4__Kiến
trúc sư;5__Xây
dựng;6__An
ninh;7__Nghệ
sỹ;8__Giáo viên;9__Tự
do;10__Khác
income Int Thu nhập income_list=1__<5.000
.000
VND;2__5.000.000 -
10.000.000
VND;3__10.000.000 -
20.000.000
VND;4__>20.000.000
VND
Mã lỗi Mô tả
0 Thất bại
1 Thành công
2 Lỗi
3 Không rõ lỗi
22

23. 4 Prog null
5 Category không hợp lệ
6 Nội dung null
7 StartDate null
8 StartDate không hợp lệ
9 FinishDate null
10 FinishDate không hợp lệ
11 Alias không hợp lệ
12 MaxSms không hợp lệ
13 ToTalSub không hợp lệ
Tìm kiếm CTQC – searchProgs
- Mô tả: Tìm kiếm chương trình quảng cáo CP đã tạo.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:searchProgs>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:progCode>CP</tem:progCode>
<tem:category>KM</tem:category>
<tem:status>1</tem:status>
<tem:createdDate>20110510</tem:createdDate>
<tem:startDate>20110518</tem:startDate>
</tem:searchProgs>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
23

24. progCode String MãCTQC
catCode String Mã Category
createDate String Ngày tạo yyyyMMdd
startDate String Ngày bắt đầu gửi tin
yyyyMMdd
status Int Trạng thái CTQC 0: Từ chối duyệt
1: Chưa duyệt
2: đã duyệt ND
3: Test
4: Đang gửi test
5: Kết thúc test
6: Sẵn sàng gửi
7: đang gửi
8: tạm dữ
9: kết thúc
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:searchProgsResponse xmlns:ns2="http://tempuri.org/">
<return>
<progs>
<progCode>CP_TEST230</progCode>
<category>BD</category>
<content>ZZZ</content>
<sentStartDate>20110529</sentStartDate>
<sentFinishDate>20110529</sentFinishDate>
<maxSms>1</maxSms>
<alias>1313</alias>
24

25. <sentSchedule>1234567</sentSchedule>
<sentTimeZone>0</sentTimeZone>
<createdUser>quangdh</createdUser>
<createdDate>20110529</createdDate>
<priority>0</priority>
<status>1</status>
<sentType>2</sentType>
<zoneList>HNI,DNG,HCM,KTM,QNM,BDH,GLI,SLA,DLK,YBI,KHA,BNH,QNI,LCI,TTH,LCU,
GG,LSN,TGG,NAN,STG,BKN,DBN,TVH,BGG,PTO,HGG</zoneList>
<catList>ET,KM,VT,YT,GD,HM,TH,CK,TP,GT,DL,BD,DT,OT,PHIM,NH</catList>
<totalSub>10</totalSub>
<gender>0</gender>
<minYear>0</minYear>
<maxYear>0</maxYear>
<job>0</job>
<income>0</income>
<processStatus>0</processStatus>
</progs>
<status>1</status>
</return>
</ns2:searchProgsResponse>
</S:Body>
</S:Envelope>
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
25

26. Tạo CTQC – createProg
- Mô tả: Tạo chương trình quảng cáo.
Request
CTQC có tập thuê bao do CP up lên
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:createProg>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:tmpProg>
<category>KM</category>
<content>TEST SUCCESS</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
<alias>1313</alias>
<sentSchedule>1</sentSchedule>
<exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
<sentType>0</sentType>
</tem:tmpProg>
</tem:createProg>
</soapenv:Body>
</soapenv:Envelope>
CTQC lấy thuê bao của nhà mạng Viettel
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:createProg>
26

27. <tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:tmpProg>
<category>KM</category>
<content>TEST SUCCESS</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
<alias>1313</alias>
<sentSchedule>1</sentSchedule>
<exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
<sentType>1</sentType>
<zoneList>HNI</zoneList>
<totalSub>1</totalSub>
</tem:tmpProg>
</tem:createProg>
</soapenv:Body>
</soapenv:Envelope>
CTQC từ tập thuê bao DK trên website
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:createProg>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:tmpProg>
<category>KM</category>
<content>TEST SUCCESS</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
27

28. <alias>1313</alias>
<sentSchedule>1</sentSchedule>
<exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
<sentType>2</sentType>
<zoneList>HNI</zoneList>
<catList>KM</catList>
<totalSub>1</totalSub>
<gender>1</gender>
<minYear>11</minYear>
<maxYear>15</maxYear>
<job>1</job>
<income>1</income>
</tem:tmpProg>
</tem:createProg>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
category String Mã category KM
content String Nội dung tin nhắn
sentStartDate String Ngày bắt đầu gửi tin
yyyyMMdd
20150115
sentFinishDa
te
String Ngày kết thúc gửi tin
yyyyMMdd
20150115
maxSms Int Số tin nhắn tối đa 100
alias String Alias gửi tin QC
sentSchedule String Ngày gửi tin 1234567
exceptionDa String Ngày ngoại lệ không gửi tin 20150116
28

29. y yyyyMMdd
sentTimeZon
e
Int Múi giờ gửi tin 0: buổi sáng, 1: buổi
chiều, 2: cả ngày
sentType Int Hình thức gửi tin (1-3) 1
zoneList String Danh sách mã tỉnh HNI,HCM
catList String Danh sách tiêu chí
totalSub Int Tổng số thuê bao gửi tin
gender Int Giới tính
minYear Int Độ tuổi nhỏ nhất
maxYear Int Độ tuổi lớn nhất
job Int Công việc
income Int Thu nhập
Response
CTQC thuê bao do CP cung cấp
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createProgResponse xmlns:ns2="http://tempuri.org/">
<return>
<progCode>CP_TEST305</progCode>
<category>KM</category>
<content>TEST SUCCESS</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
<alias>1313</alias>
<sentSchedule>1</sentSchedule>
<exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
29

30. <createdUser>quangdh</createdUser>
<createdDate>20110531</createdDate>
<priority>1</priority>
<status>1</status>
<sentType>0</sentType>
<zoneList/>
<catList/>
<totalSub>0</totalSub>
<gender>0</gender>
<minYear>0</minYear>
<maxYear>0</maxYear>
<job>0</job>
<income>0</income>
<processStatus>1</processStatus>
</return>
</ns2:createProgResponse>
</S:Body>
</S:Envelope>
CTQC lấy thuê bao nhà mạng Viettel
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createProgResponse xmlns:ns2="http://tempuri.org/">
<return>
<progCode>CP_TEST306</progCode>
<category>KM</category>
<content>TEST SUCCESS</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
<alias>1313</alias>
<sentSchedule>1</sentSchedule>
30

31. <exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
<createdUser>quangdh</createdUser>
<createdDate>20110531</createdDate>
<priority>1</priority>
<status>1</status>
<sentType>1</sentType>
<zoneList>HNI</zoneList>
<catList/>
<totalSub>1</totalSub>
<gender>0</gender>
<minYear>0</minYear>
<maxYear>100</maxYear>
<job>0</job>
<income>0</income>
<processStatus>1</processStatus>
</return>
</ns2:createProgResponse>
</S:Body>
</S:Envelope>
CTQC lấy thuê bao DK từ website
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createProgResponse xmlns:ns2="http://tempuri.org/">
<return>
<progCode>CP_TEST307</progCode>
<category>KM</category>
<content>TEST SUCCESS</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
31

32. <alias>1313</alias>
<sentSchedule>1</sentSchedule>
<exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
<createdUser>quangdh</createdUser>
<createdDate>20110531</createdDate>
<priority>1</priority>
<status>1</status>
<sentType>2</sentType>
<zoneList>HNI</zoneList>
<catList>KM</catList>
<totalSub>1</totalSub>
<gender>1</gender>
<minYear>11</minYear>
<maxYear>15</maxYear>
<job>1</job>
<income>1</income>
<processStatus>1</processStatus>
</return>
</ns2:createProgResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
32

33. Sửa CTQC – updateProg
- Mô tả: Cập nhật chương trình quảng cáo.
Request
CTQC có tập thuê bao của CP
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:updateProg>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:tmpProg>
<progCode>CP_TEST315</progCode>
<category>KM</category>
<content>TEST SUCCESS 1</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
<alias>1313</alias>
<sentSchedule>1</sentSchedule>
<exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
<createdUser>quangdh</createdUser>
<createdDate>20110601</createdDate>
<priority>1</priority>
<status>1</status>
<sentType>0</sentType>
</tem:tmpProg>
</tem:updateProg>
</soapenv:Body>
</soapenv:Envelope>
CTQC có tập thuê bao Viettel
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
33

34. xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:updateProg>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:tmpProg>
<progCode>CP_TEST316</progCode>
<category>KM</category>
<content>TEST SUCCESS</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
<alias>1313</alias>
<sentSchedule>1</sentSchedule>
<exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
<createdUser>quangdh</createdUser>
<createdDate>20110601</createdDate>
<priority>1</priority>
<status>1</status>
<sentType>1</sentType>
<zoneList>HNI</zoneList>
<totalSub>1</totalSub>
</tem:tmpProg>
</tem:updateProg>
</soapenv:Body>
</soapenv:Envelope>
CTQC có tập thê bao khách hàng DK
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
34

35. <soapenv:Body>
<tem:updateProg>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:tmpProg>
<progCode>CP_TEST312</progCode>
<category>KM</category>
<content>TEST SUCCESS</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
<alias>1313</alias>
<sentSchedule>1</sentSchedule>
<exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
<createdUser>quangdh</createdUser>
<createdDate>20110531</createdDate>
<priority>1</priority>
<status>1</status>
<sentType>2</sentType>
<zoneList>HNI, HCM</zoneList>
<catList>KM</catList>
<totalSub>1</totalSub>
<gender>1</gender>
<minYear>11</minYear>
<maxYear>15</maxYear>
<job>1</job>
<income>1</income>
</tem:tmpProg>
</tem:updateProg>
</soapenv:Body>
</soapenv:Envelope>
35

36. Tham số Kiểu dữ liệu Mô tả Ví dụ
category String Mã category KM
content String Nội dung tin nhắn
sentStartDate String Ngày bắt đầu gửi tin
yyyyMMdd
20150115
sentFinishDa
te
String Ngày kết thúc gửi tin
yyyyMMdd
20150115
maxSms Int Số tin nhắn tối đa 100
alias String Alias gửi tin QC
sentSchedule String Ngày gửi tin 1234567
exceptionDa
y
String Ngày ngoại lệ không gửi tin
yyyyMMdd
20150116
sentTimeZon
e
Int Múi giờ gửi tin 0: buổi sáng, 1: buổi
chiều, 2: cả ngày
sentType Int Hình thức gửi tin (1-3) 1
zoneList String Danh sách mã tỉnh HNI,HCM
catList String Danh sách tiêu chí
totalSub Int Tổng số thuê bao gửi tin
gender Int Giới tính
minYear Int Độ tuổi nhỏ nhất
maxYear Int Độ tuổi lớn nhất
job Int Công việc
income Int Thu nhập
priority Int Độ ưu tiên
status Int Trạng thái
36

37. Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateProgResponse xmlns:ns2="http://tempuri.org/">
<return>
<progCode>CP_TEST312</progCode>
<category>KM</category>
<content>TEST SUCCESS</content>
<sentStartDate>20110101</sentStartDate>
<sentFinishDate>20110101</sentFinishDate>
<maxSms>1</maxSms>
<alias>1313</alias>
<sentSchedule>1</sentSchedule>
<exceptionDay>20110101</exceptionDay>
<sentTimeZone>1</sentTimeZone>
<createdUser>quangdh</createdUser>
<createdDate>20110531</createdDate>
<priority>1</priority>
<status>1</status>
<sentType>2</sentType>
<zoneList>HNI,HCM</zoneList>
<catList>KM</catList>
<totalSub>1</totalSub>
<gender>1</gender>
<minYear>11</minYear>
<maxYear>15</maxYear>
<job>1</job>
<income>1</income>
<processStatus>1</processStatus>
</return>
</ns2:updateProgResponse>
</S:Body>
37

38. </S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
result String Mã kết quả thực hiện giao
dịch, là chuỗi gồm 3 kí tự số.
200
Bảng mô tả mã lỗi
Mã lỗi Mô tả
Xóa CTQC – deleteProg
- Mô tả: Xóa chương trình quảng cáo.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:deleteProg>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:progCode>CP_TEST312</tem:progCode>
</tem:deleteProg>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
cpCode String Mã CP
name String User đăng nhập
38

39. pass String Mật khẩu
progCode String Mã chương trình
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteProgResponse xmlns:ns2="http://tempuri.org/">
<return>1</return>
</ns2:deleteProgResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
result String Mã kết quả thực hiện giao
dịch, là chuỗi gồm 3 kí tự số.
200
Bảng mô tả mã lỗi
Mã lỗi Mô tả
200 Giao dịch thành công
Duyệt CTQC – acceptProg
- Mô tả: Phê duyệt chương trình nhắn tin.
Request
<soapenv:Header/>
<soapenv:Body>
<tem:acceptProg>
<!--Optional:-->
<tem:authen cpCode="CP_TEST" name="cp_test" pass="123">
<isAdmin>?</isAdmin>
39

40. </tem:authen>
<!--Optional:-->
<tem:progCode>CP_TEST1</tem:progCode>
<tem:priority>3</tem:priority>
</tem:acceptProg>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
priority int Độ ưu tiên Từ 1 -> 10
cpCode String Mã CP
name String User đăng nhập
pass String Mật khẩu
progCode String Mã chương trình
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:acceptProgResponse xmlns:ns2="http://tempuri.org/">
<return>1</return>
</ns2:acceptProgResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
result String Mã kết quả thực hiện giao
dịch, là chuỗi gồm 3 kí tự số.
1: thành công
40

41. Test CTQC – testProg
- Mô tả: Tạo chương trình test.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:testProg>
<!--Optional:-->
<tem:authen cpCode="CP_TEST" name="cp_test" pass="123">
<isAdmin>?</isAdmin>
</tem:authen>
<!--Optional:-->
<tem:progCode>CP_TEST111</tem:progCode>
<!--Optional:-->
<tem:startTest>20130620</tem:startTest>
<!--Optional:-->
<tem:finishTest>20130621</tem:finishTest>
<!--Zero or more repetitions:-->
<tem:msisdns>84972218325</tem:msisdns>
<tem:msisdns>84972218326</tem:msisdns>
</tem:testProg>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
startTest String Ngày bắt đầu test yyyyMMdd
finishTest String Ngày kết thúc test yyyyMMdd
Msisdns String Số điện thoại test
41

42. cpCode String Mã CP
name String User đăng nhập
pass String Mật khẩu
progCode String Mã chương trình
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:testProgResponse xmlns:ns2="http://tempuri.org/">
<return>1</return>
</ns2:testProgResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
Result String Mã kết quả thực hiện giao
dịch, là chuỗi gồm 3 kí tự số.
1: thành công
Xem chi tiết CTQC – getProg
- Mô tả: Xem thông tin chương trình nhắn tin.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:getProg>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:progCode>CP_TEST181</tem:progCode>
42

43. </tem:getProg>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
cpCode String Mã CP
name String User đăng nhập
pass String Mật khẩu
progCode String Mã chương trình
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getProgResponse xmlns:ns2="http://tempuri.org/">
<return>
<progCode>CP_TEST181</progCode>
<category>GT</category>
<content>1</content>
<sentStartDate>20110518</sentStartDate>
<sentFinishDate>20110518</sentFinishDate>
<maxSms>10</maxSms>
<alias>1313</alias>
<sentSchedule>1234567</sentSchedule>
<sentTimeZone>0</sentTimeZone>
<createdUser>quangdh</createdUser>
<createdDate>20110510</createdDate>
<priority>0</priority>
<status>1</status>
<sentType>1</sentType>
43

44. <zoneList>HNI,DNG,HCM,KTM,QNM,BDH,GLI,SLA,DLK,YBI,KHA,BNH,QNI,LCI,TTH,LCU,
GG,LSN,TGG,NAN,STG,BKN,DBN,TVH,BGG,PTO,HGG</zoneList>
<catList/>
<totalSub>100</totalSub>
<gender>0</gender>
<minYear>0</minYear>
<maxYear>0</maxYear>
<job>1</job>
<income>0</income>
<processStatus>0</processStatus>
</return>
</ns2:getProgResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
result String Mã kết quả thực hiện giao
dịch, là chuỗi gồm 3 kí tự số.
200
Bảng mô tả mã lỗi
Mã lỗi Mô tả
200 Giao dịch thành công
Xem tất cả thuê bao – getAllMsisdns
- Mô tả: Lấy ra danh sách các thuê bao mang đi gửi tin.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
44

45. <soapenv:Body>
<tem:getAllMsisdns>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:progCode>CP_TEST313</tem:progCode>
</tem:getAllMsisdns>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
cpCode String Mã CP
name String User đăng nhập
pass String Mật khẩu
progCode String Mã chương trình
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getAllMsisdnsResponse xmlns:ns2="http://tempuri.org/">
<return>
<msisdns>84984350452</msisdns>
<msisdns>84984350451</msisdns>
<msisdns>84984350450</msisdns>
<status>1</status>
</return>
</ns2:getAllMsisdnsResponse>
</S:Body>
</S:Envelope>
45

46. Tham số Kiểu dữ liệu Mô tả Ví dụ
result String Mã kết quả thực hiện giao
dịch, là chuỗi gồm 3 kí tự số.
200
Bảng mô tả mã lỗi
Mã lỗi Mô tả
200 Giao dịch thành công
Thêm thuê bao – uploadMsisdns
- Mô tả: Add thêm các thuê bao cần gửi tin.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:uploadMsisdns>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:progCode>CP_TEST313</tem:progCode>
<tem:msisdns>84984350450</tem:msisdns>
<tem:msisdns>84984350451</tem:msisdns>
<tem:msisdns>84984350452</tem:msisdns>
</tem:uploadMsisdns>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
Msisdns String Số điện thoại gửi tin
84985000999
cpCode String Mã CP
46

47. name String User đăng nhập
pass String Mật khẩu
progCode String Mã chương trình
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:uploadMsisdnsResponse xmlns:ns2="http://tempuri.org/">
<return>1</return>
</ns2:uploadMsisdnsResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
result String Mã kết quả thực hiện giao
dịch, là chuỗi gồm 3 kí tự số.
200
Bảng mô tả mã lỗi
Mã lỗi Mô tả
200 Giao dịch thành công
Xóa thuê bao – removeMsisdns
- Mô tả: Xóa thuê bao khỏi tập danh sách gửi tin.
Request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
47

48. <soapenv:Body>
<tem:removeMsisdns>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:progCode>CP_TEST313</tem:progCode>
<tem:msisdns>84984350451</tem:msisdns>
</tem:removeMsisdns>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
Msisdns String Số điện thoại
84985000999
cpCode String Mã CP
name String User đăng nhập
pass String Mật khẩu
progCode String Mã chương trình
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeMsisdnsResponse xmlns:ns2="http://tempuri.org/">
<return>1</return>
</ns2:removeMsisdnsResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
48

49. Bảng mô tả mã lỗi
Mã lỗi Mô tả
5. Nhóm chức năng báo cáo
Thống kê tin nhắn theo ngày – getDailySmsReport
- Mô tả: Báo cáo theo ngày.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:getDailySmsReport>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:progCode>CP_TEST314</tem:progCode>
<tem:catCode>KM</tem:catCode>
<tem:fromDate>20110529</tem:fromDate>
<tem:toDate>20110530</tem:toDate>
</tem:getDailySmsReport>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
progCode String MãCTQC
catCode String Mã Category
49

50. fromDate String Ngày bắt đầu yyyyMMdd
toDate String Ngày kết thúc yyyyMMdd
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getDailySmsReportResponse xmlns:ns2="http://tempuri.org/">
<return>
<smsRecords>
<date>20110529</date>
<moReply>0</moReply>
<mt1Error>0</mt1Error>
<mt1NotSend>0</mt1NotSend>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<numOder>0</numOder>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
<subUnReg>0</subUnReg>
</smsRecords>
<smsRecords>
<date>20110530</date>
<moReply>0</moReply>
<mt1Error>0</mt1Error>
<mt1NotSend>0</mt1NotSend>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<numOder>0</numOder>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
<subUnReg>0</subUnReg>
50

51. </smsRecords>
<status>1</status>
</return>
</ns2:getDailySmsReportResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
String <moReply>0</moReply>
<mt1Error>0</mt1Error>
<mt1NotSend>0</mt1NotSe
nd>
<mt1Success>0</mt1Succes
s>
<mt2Success>0</mt2Succes
s>
<numOder>0</numOder>
<sms1Success>0</sms1Succ
ess>
<sms2Success>0</sms2Succ
ess>
<subUnReg>0</subUnReg>
Số MO phản hồi
MT1 lỗi
MT1 chưa gửi
MT1 thành công
Mt2 thành công
SMS1 thành công
SMS2 thành công
Số thuê bao chưa gửi
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
Thống kê tin nhắn theo tháng – getMonthSmsReport
- Mô tả: Báo cáo theo tháng
51

52. Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:getMonthSmsReport>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:progCode>CP_TEST314</tem:progCode>
<tem:catCode>KM</tem:catCode>
<tem:month>201105</tem:month>
</tem:getMonthSmsReport>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
progCode String MãCTQC
catCode String Mã Category
month String Tháng yyyyMM
progCod String MãCTQC
catCode String Mã Category
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getMonthSmsReportResponse xmlns:ns2="http://tempuri.org/">
<return>
<smsRecords>
<date>20110501</date>
<moReply>0</moReply>
<mt1Error>0</mt1Error>
52

53. <mt1NotSend>0</mt1NotSend>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<numOder>0</numOder>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
<subUnReg>0</subUnReg>
</smsRecords>
...
<smsRecords>
<date>20110531</date>
<moReply>0</moReply>
<mt1Error>0</mt1Error>
<mt1NotSend>0</mt1NotSend>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<numOder>0</numOder>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
<subUnReg>0</subUnReg>
</smsRecords>
<status>1</status>
</return>
</ns2:getMonthSmsReportResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
53

54. Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
Thống kê tin nhắn theo năm – getYearSmsReport
- Mô tả: Báo cáo theo năm.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:getYearSmsReport>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:progCode>CP_TEST314</tem:progCode>
<tem:catCode>KM</tem:catCode>
<tem:year>2011</tem:year>
</tem:getYearSmsReport>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
progCod String MãCTQC
catCode String Mã Category
year String Năm yyyy
progCod String MãCTQC
catCode String Mã Category
Response
54

55. <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getYearSmsReportResponse xmlns:ns2="http://tempuri.org/">
<return>
<smsRecords>
<date>201101</date>
<moReply>0</moReply>
<mt1Error>0</mt1Error>
<mt1NotSend>0</mt1NotSend>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<numOder>0</numOder>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
<subUnReg>0</subUnReg>
</smsRecords>
...
<smsRecords>
<date>201112</date>
<moReply>0</moReply>
<mt1Error>0</mt1Error>
<mt1NotSend>0</mt1NotSend>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<numOder>0</numOder>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
<subUnReg>0</subUnReg>
</smsRecords>
<status>1</status>
</return>
</ns2:getYearSmsReportResponse>
55

56. </S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
Thống kê CTQC theo ngày – getDailyProgReport
- Mô tả: Báo cáo chương trình nhắn tin theo ngày.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:getDailyProgReport>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:catCode>KM</tem:catCode>
<tem:fromDate>20100501</tem:fromDate>
<tem:toDate>20100502</tem:toDate>
</tem:getDailyProgReport>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
catCode String Mã Category
56

57. fromDate String Ngày bắt đầu yyyyMMdd
toDate String Ngày kết thúc yyyyMMdd
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getDailyProgReportResponse xmlns:ns2="http://tempuri.org/">
<return>
<progSmsRecords>
<date>20100501</date>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<progComplete>0</progComplete>
<progCreate>0</progCreate>
<progFinish>0</progFinish>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
</progSmsRecords>
<progSmsRecords>
<date>20100502</date>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<progComplete>0</progComplete>
<progCreate>0</progCreate>
<progFinish>0</progFinish>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
</progSmsRecords>
<status>1</status>
</return>
</ns2:getDailyProgReportResponse>
57

58. </S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
String <date>20100501</date>
<mt1Success>0</mt1Succes
s>
<mt2Success>0</mt2Succes
s>
<progComplete>0</progCo
mplete>
<progCreate>0</progCreate
>
<progFinish>0</progFinish>
<sms1Success>0</sms1Succ
ess>
<sms2Success>0</sms2Succ
ess>
yyyyMMdd
MT1 thành công
MT2 thành công
Số CTQC hoàn thành
Số CTQC được tạo
Số CTQC đã kết thúc
SMS1 thành công
SMS2 thành công
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
Thống kê CTQC theo tháng – getMonthProgReport
- Mô tả: Báo cáo chương trình nhắn tin theo tháng.
Request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
58

59. <soapenv:Header/>
<soapenv:Body>
<tem:getMonthProgReport>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:catCode>KM</tem:catCode>
<tem:month>201105</tem:month>
</tem:getMonthProgReport>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
catCode String Mã Category
month String Tháng yyyyMM
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getMonthProgReportResponse xmlns:ns2="http://tempuri.org/">
<return>
<progSmsRecords>
<date>20110501</date>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<progComplete>0</progComplete>
<progCreate>0</progCreate>
<progFinish>0</progFinish>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
</progSmsRecords>
...
59

60. <progSmsRecords>
<date>20110601</date>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<progComplete>0</progComplete>
<progCreate>0</progCreate>
<progFinish>0</progFinish>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
</progSmsRecords>
<status>1</status>
</return>
</ns2:getMonthProgReportResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
Thống kê CTQC theo năm – getYearProgReport
- Mô tả: Báo cáo chương trình nhắn tin theo năm.
Request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
60

61. <soapenv:Header/>
<soapenv:Body>
<tem:getYearProgReport>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:catCode>KM</tem:catCode>
<tem:year>2011</tem:year>
</tem:getYearProgReport>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
catCode String Mã Category
năm String Năm yyyy
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getYearProgReportResponse xmlns:ns2="http://tempuri.org/">
<return>
<progSmsRecords>
<date>201101</date>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<progComplete>0</progComplete>
<progCreate>0</progCreate>
<progFinish>0</progFinish>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
</progSmsRecords>
...
61

62. <progSmsRecords>
<date>201112</date>
<mt1Success>0</mt1Success>
<mt2Success>0</mt2Success>
<progComplete>0</progComplete>
<progCreate>0</progCreate>
<progFinish>0</progFinish>
<sms1Success>0</sms1Success>
<sms2Success>0</sms2Success>
</progSmsRecords>
<status>1</status>
</return>
</ns2:getYearProgReportResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
Bảng mô tả mã lỗi
Mã lỗi Mô tả
0 Thất bại
1 Thành công
6. Nhóm chức năng tài khoản ảo
Thống kê tài khoản ảo – searchBalance
- Mô tả: Kiểm tra lịch sử trừ tài khoản.
Request
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
62

63. xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:searchBanlance>
<tem:authen cpCode="CP_TEST" name="quangdh" pass="123"/>
<tem:startDate>20110501</tem:startDate>
<tem:endDate>20110530</tem:endDate>
</tem:searchBanlance>
</soapenv:Body>
</soapenv:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
startDate String Ngày bắt đầu – yyyyMMdd 20110501
endDate String Ngày kết thúc – yyyyMMdd 20110501
Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:searchBanlanceResponse xmlns:ns2="http://tempuri.org/">
<return>
<balance>1133</balance>
<minusBalances>
<cpCode>CP_TEST</cpCode>
<cpName>CP_TEST</cpName>
<minusTime>2011-05-11T00:00:00+07:00</minusTime>
<progCode>CP_TEST191</progCode>
<smsMinus>30</smsMinus>
<type>0</type>
</minusBalances>
<minusBalances>
63

64. <cpCode>CP_TEST</cpCode>
<cpName>CP_TEST</cpName>
<minusTime>2011-05-30T00:00:00+07:00</minusTime>
<progCode>CP_TEST284</progCode>
<smsMinus>3</smsMinus>
<type>0</type>
</minusBalances>
<minusBalances>
<cpCode>CP_TEST</cpCode>
<cpName>CP_TEST</cpName>
<minusTime>2011-05-30T00:00:00+07:00</minusTime>
<progCode>CP_TEST294</progCode>
<smsMinus>3</smsMinus>
<type>0</type>
</minusBalances>
<minusBalances>
<cpCode>CP_TEST</cpCode>
<cpName>CP_TEST</cpName>
<minusTime>2011-05-11T00:00:00+07:00</minusTime>
<progCode>CP_TEST190</progCode>
<smsMinus>10</smsMinus>
<type>0</type>
</minusBalances>
<minusBalances>
<cpCode>CP_TEST</cpCode>
<cpName>CP_TEST</cpName>
<minusTime>2011-05-11T00:00:00+07:00</minusTime>
<progCode>CP_TEST187</progCode>
<smsMinus>20</smsMinus>
<type>0</type>
</minusBalances>
<status>1</status>
64

65. </return>
</ns2:searchBanlanceResponse>
</S:Body>
</S:Envelope>
Tham số Kiểu dữ liệu Mô tả Ví dụ
balance String Tài khoản hiện tại của CP
Tài khoản trừ String <minusBalances>
<cpCode>CP_TEST</cpCod
e>
<cpName>CP_TEST</cpNa
me>
<minusTime>2011-
05-
11T00:00:00+07:00</minus
Time>
<progCode>CP_TEST191</
progCode>
<smsMinus>30</smsMinus>
<type>0</type>
</minusBalances>
cpCode – mã CP
cpName – tên CP
minusTime – Thời gian
trừ
progCode – Mã CTQC
smsMinus – Số SMS bị
trừ
type – 0: trừ theo MT
1: từ theo MO
Tương tự các thàn phần khác
Bảng mô tả mã lỗi
Mã lỗi Mô tả
65

66. 0 Thất bại
1 Thành công
66