sms ws billupdate v1.1

2
Tài liệu tích hợp SMS qua NgânLượng.vn 1 Hướng dẫn tạo WS khi tích hợp SMS qua Ngân Lượng Để tích hợp SMS, site người bán (người nhận) cầntạo hàm WS theo yêu cầu sau: Tên hàm: BillUpdate(reciver_email, transaction_id, price, amount, fee, ref_code, keyword, service_id, message, client_mobile, telco, checksum) Thông tin các tham số đầu vào: reciver_email: địa chỉ email chính của tài khoản nhận tiền giao dịch SMS trên Ngân Lượng transaction_id: mã giao dịch SMS trên Ngân Lượng price: số tiền người dùng bị mất khi nhắn tin đến đầu số. VD: nhắn tin tới đầu số 8681 mất 10.000đ thì giá trị price = 10000 amount: số tiền tài khoản người nhận nhận được với giao dịch SMS trên. VD: nhắn tin tới đầu số 8681 mất 10.000đ, Ngân Lượng thu phí 75% thì giá trị amount = 7500 fee: số tiền Ngân Lượng thu phí cho giao dịch SMS trên. Công thức: fee = price amount ref_code: mã tham chiếu, đây là một phần trong nội dung tin nhắn mà người dùng nhắn tin lên đầu số theo hướng dẫn của chủ site. VD: người dùng nhắn tin “NL NAPTIEN nguyen van a” thì giá trị “NL NAPTIEN” là keyword Ngân Lượng cấp cho người nhận(chủ site), còn “nguyen van a” là mã tham chiếu ref_code keyword: từ khóa trong nội dung tin nhắn của người dùng, với ví dụ trên thì keyword = “NL NAPTIEN” service_id: đầu số người dùng nhắn tin đến, VD: service_id = 8681 message: đây là toàn bộ nội dung tin nhắn của người dùng. VD: message = “NL NAPTIEN nguyen van a” client_mobile: số điện thoại người dùng sử dụng để nhắn tin. VD: client_mobile = 0987654321 telco: mã nhà mạng của số điện thoại nhắn tin đến. Nhận các giá trị sau: o VIETTEL (mạng Viettel) o VNP (mạng Vinaphone) o VMS (mạng Mobifone) o VNM (mạng Vietnamobile) o SFONE (mạng Sfone) o GTEL (mạng Gmobile hoặc Beeline cũ) checksum: mã kiểm tra, mã này được sử dụng để kiểm tra giá trị các tham số trả về có hợp lệ hay không.

Upload: lee-tea

Post on 06-Sep-2015

212 views

Category:

Documents


0 download

DESCRIPTION

SMS WS BillUpdate v1.1 for smsgw

TRANSCRIPT

  • Ti liu tch hp SMS qua NgnLng.vn

    1

    Hng dn to WS khi tch hp SMS qua Ngn Lng

    tch hp SMS, site ngi bn (ngi nhn) cnto hm WS theo yu cu sau: Tn hm: BillUpdate(reciver_email, transaction_id, price, amount, fee, ref_code, keyword, service_id, message, client_mobile, telco, checksum)

    Thng tin cc tham s u vo:

    reciver_email: a ch email chnh ca ti khon nhn tin giao dch SMS trn Ngn Lng

    transaction_id: m giao dch SMS trn Ngn Lng

    price: s tin ngi dng b mt khi nhn tin n u s. VD: nhn tin ti u s 8681 mt 10.000 th gi tr price = 10000

    amount: s tin ti khon ngi nhn nhn c vi giao dch SMS trn. VD: nhn tin ti u s 8681 mt 10.000, Ngn Lng thu ph 75% th gi tr amount = 7500

    fee: s tin Ngn Lng thu ph cho giao dch SMS trn. Cng thc: fee = price amount

    ref_code: m tham chiu, y l mt phn trong ni dung tin nhn m ngi dng nhn tin ln u s theo hng dn ca ch site.

    VD: ngi dng nhn tin NL NAPTIEN nguyen van a th gi tr NL NAPTIEN l keyword Ngn Lng cp cho ngi nhn(ch site), cn nguyen van a l m tham chiu ref_code

    keyword: t kha trong ni dung tin nhn ca ngi dng, vi v d trn th keyword = NL NAPTIEN

    service_id: u s ngi dng nhn tin n, VD: service_id = 8681

    message: y l ton b ni dung tin nhn ca ngi dng. VD: message = NL NAPTIEN nguyen van a

    client_mobile: s in thoi ngi dng s dng nhn tin. VD: client_mobile = 0987654321

    telco: m nh mng ca s in thoi nhn tin n. Nhn cc gi tr sau: o VIETTEL (mng Viettel) o VNP (mng Vinaphone) o VMS (mng Mobifone) o VNM (mng Vietnamobile) o SFONE (mng Sfone) o GTEL (mng Gmobile hoc Beeline c)

    checksum: m kim tra, m ny c s dng kim tra gi tr cc tham s tr v c hp l hay khng.

  • Ti liu tch hp SMS qua NgnLng.vn

    2

    Tham s u ra:

    - Tham s u ra l mt chui c cu trc : [ErrorCode]|[MessageSMS] - Trong :

    o ErrorCode : nhn 2 gi tr l 0 v 1. Tr v gi tr 0 nu c li khi x l kt qu tr v trn h thng merchant. Tr v gi tr l 1 nu x l thnh cng.

    o MessageSMS : l chui ni dng tin nhn c m ha base64 m merchant mun gi n ngi dng nhn tin. Chui ni dung tin nhn khng c qu 150 k t, v l ting vit khng du.

    - VD: nu mun nhn tin phn hi n ngi dng vi ni dung Ban da nap tien vao he thong thanh cong th gi tr cn tr li ca hm BillUpdate l: 1|QmFuIGRhIG5hcCB0aWVuIHZhbyBoZSB0aG9uZyB0aGFuaCBjb25n

    iu kin kim tra:

    - Khi nhn c cc gi tr trn, hm BillUpdate cn to m kim tra theo cch sau : makiemtra = md5(reciver_email + "|" + transaction_id + "|" + price + "|" + amount + "|" + fee + "|" + ref_code + "|" + keyword + "|" + service_id + "|" + message + "|" + client_mobile + "|" + telco + "|" + Mt khu xc nhn giao dch) Trong : Mt khu xc nhn giao dch l gi tr c ngi nhn khai bo khi ng k mt keyword khi s dng dch v SMS ca Ngn Lng. Gi tr ny ch c thay i khi ngi nhn yu cu Ngn Lng

    - Tip n hm BillUpdate cn kim tra: o Nu makiemtra == checksum (m kim tra ng) th x l np tin, cng im (ty theo merchant) v hm BillUpdate cn tr li gi tr l 1 o Nu makiemtra != checksum (li m kim tra) th khng x l g trn h thng merchant, hm BillUpdate cn tr li gi tr l 0

    Din gii:

    - Khi giao dch c thc hin (ngi dng nhn tin) th Ngn Lng s t ng gi WS bn pha merchant. Trong WebService merchant s nhn cc thng tin bn Ngn Lng gi sang, sau kim tra xem tham s checksum gi n c tha mn iu kin kim tra trn hay khng, nu tha mn th khch hng s thc hin vic x l tip theo v hm BillUpdate cn tr li gi tr l 1, nu khng th tr li gi tr l 0.