fibo sms apifibosmsmarketing.com/content/document/635718215469380000.pdf · công ty tnhh phibo ......

www.FiboSMS.com - [email protected]

Trang 1

Cng ty TNHH PHIBO

a ch : P3 Bch M P15 Qun 10, TP H Ch Minh. - Tel : (08) 62645983 Fax : (08) 62645982

Website : www.fibosms.com - Email : [email protected]

FIBO SMS

API

Version : 2.2 Last Update : 23 Jun 2012.

www.FiboSMS.com - [email protected]

Trang 2

Cng ty TNHH PHIBO

a ch : P3 Bch M P15 Qun 10, TP H Ch Minh. - Tel : (08) 62645983 Fax : (08) 62645982

Website : www.fibosms.com - Email : [email protected]

Mc lc

1 Gii thiu: ....................................................................................................................................................... 3

1.1 Virtual SMS: ............................................................................................................................................... 3

1.2 SMS Hosting: .............................................................................................................................................. 3

1.3 Hm API: .................................................................................................................................................... 3

2 Cc hm API .................................................................................................................................................... 5

2.1 About ......................................................................................................................................................... 5

2.2 CheckClient ................................................................................................................................................ 5

2.3 GetClientBalance ....................................................................................................................................... 5

2.4 SendSMS .................................................................................................................................................... 6

2.5 SendMaskedSMS ....................................................................................................................................... 6

2.6 GetSMSStatus (Pull) ................................................................................................................................... 8

2.7 GetSMSStatus (Push) ................................................................................................................................. 9

2.8 GetClientSenderNameList .......................................................................................................................... 9

2.9 GetListSMSHostingWithBalance .............................................................................................................. 10

2.10 GetCommingSMSListFromID (Pull) .......................................................................................................... 10

2.11 GetCommingSMSListFromID (Push) ........................................................................................................ 11

2.12 SendSMSToMultiMessage_WithoutSplit (new) ...................................................................................... 11

1 Gii thiu: 1.1 Virtual SMS:

1.2 SMS Hosting:

Khc vi h thng u S SMS Gateway (8xxx, 6xxx, 1900xxxx, Private Number ) ch l Th ng (ch ngi nhn tin SMS vo ), h thng SMS Hosting ca Fibo mang tnh Ch ng , cho php ch ng gi cc thng tin quan trng n vi khch hng, i tc.. mt cch nhanh chng v thun tin.

SMS Hosting ( thng qua SMS API ) l c ch nn SMS, cho php cc nh pht trin dch v ton quyn tch hp h thng SMS vo bt k ng dng no. Fibo SMS Hosting chnh l c hi cho cc lp trnh vin, nhng nh pht trin ng dng, c th nhanh chng a SMS vo cuc sng.

Th trng Ni Dung S c d bo s bng n ti Vit Nam trong thi gian gn, v 90% cng vic cung cp thng tin ca th trng ny s c thng bo tc thi qua SMS ( SMS Marketing, Mobile Marketing, SMS Alert, SMS News ...)

Phm vi hot ng ca SMS Hosting gp nhiu ln so vi SMS Gateway, thng thng t l s dng l 20 SMSHossting 1 SMSGateway

C ch hot ng

S dng cc hm SMS API do Fibo cung cp

Xc thc nh danh ( username, password ) v s dng SMS API ny vo bt k ng dng no

Mi SMS ID s c cc quyn khc nhau o SMS thng thng o SMS theo BrandName ( gi SMS c tn thng hiu ) o S lng SMS c gi

Nguyn tc s dng

SMS Hosting c s dng ngc vi SMS Gateway, ph gi SMS s do cc nh cung cp chu trch nhim, chi ph thu v ( nu c ) t khch hng s c nhn qua 01 hnh thc khc.

SMS Hosting c cung cp theo tng gi dch v ( package ) v c chi ph tng ng.

Mt s ng dng thch hp cho SMS Hosting

SMS Marketing Mobile Marketing ( bt k h thng no cn qung co, tip th )

SMS tch hp vo cc ng dng khc

Tm ph sng ca cc ng dng SMS rt rng, theo bo co mi nht ca hng nghin cu th trng cng ngh Gartner , th mi ngy c trn 10.000.000.000SMS ( 10 t SMS ) c gi i, d kin 2 nghn t SMS s c gi i trong nm 2008. S lng ny gp 300-1000 ln s ngi truy cp Internet.

1.3 Hm API:

SMS API l giao thc kt ni s dng cc dch v SMS thng qua API (Application Programming Interface: giao din lp trnh ng dng ), nm trn nn Fibo SMS Hosting, cc kt ni t SMS API s giao tip vi nn tng SMS Hosting trin khai cc ng dng SMS. Lp trnh vin c th tch hp SMS vo bt k chng trnh no gi/nhn SMS

C th kt ni bng tt c cc ngn ng lp trnh thng dng: ASP, PHP, dotNet, thm ch c th k ni thng qua HTML

Chy a nn : Unix, Windows, Mac

C ch hot ng:

Kt ni thng qua Web Services : POST/GET, SOAP

H tr gi tin nhn SMS thng qua giao thc SMTP, SMPP ( tch hp vo cc ng dng chun theo giao thc ny)

Hng dn s dng - Source code : xem thm ti http://forum.fibo.vn

Mt s ng dng c xy dng t SMS API

Trin khai cc gii php SMS marketing, Mobile marketing

Lp trnh SMS tch hp h thng bo co, cc thng tin qun l vo website

H thng qun l : ERP, CRM, CMS....

Cc phn mm SMS s dng cho mc ch giao tip vi khch hng/ iu khin nhn vin

Bo ng, tin khn cp

Tin tc c bit

Bo gi (ch ng gi SMS): vng, chng khon, s x, bng ...

......

http://forum.fibo.vn/

2 Cc hm API 2.1 About

Tr v chui www.fibovietnam.com, khch hng c th dung hm ny kim tra xem c kt ni c vi Webservice khng Gi hm:

http://center.fibosms.com/Service.asmx/About Kt qu tr v :

www.Fibovietnam.com

2.2 CheckClient Kim tra account ca khch hng.

Gi hm:

http://center.fibosms.com/Service.asmx/CheckClient?clientNo=string&clientPass=string Tham s:

- clientNo - clientPass

Kt qu tr v :

Username/pass ng, tr v tn ca client:

0 Nguyen Van A< Time>

Username/pass khng ng:

100 Please check your account!

2.3 GetClientBalance Tr v s lng SMS ang c trong ti khon ca khch hng. Trong trng hp Khch hng s dng

dng gi tin th s lng tr v chnh l s tin cn li trong ti khon ca khch hng (tnh bng VN). Gi hm: http://center.fibosms.com/Service.asmx/GetClientBalance?clientNo=string&clientPass=string&serviceType=string Tham s:

- clientNo - clientPass - serviceType

Kt qu tr v:

529 - S >0 s lng sms c gi - S =0 khng th gi sms - S

2.4 SendSMS Hm gi mt tin nhn ti mt s in thoi

Gi hm: http://center.fibosms.com/Service.asmx/SendSMS?clientNo=string&clientPass=string&phoneNumber=string&smsMessage=string&smsGUID=string&serviceType=string Tham s:

- clientNo - clientPass - phoneNumber - smsMessage - smsGUID : ID ca tin nhn - serviceType

Kt qu tr v: Thnh cng :

200 Sending...

Sai username/password:


Ti khon ht hn:

102 Your balance is zero!

Sai s in thoi:

101 Please check your Phone number!

Sai ServiceID:

103 Service type is wrong!

2.5 SendMaskedSMS Hm gi mt tin nhn ti mt s in thoi, dng cho dch v Brand Name v dch v gi tin nhn thng

http://center.fibosms.com/Service.asmx/SendSMS?clientNo=string&clientPass=string&phoneNumber=string&smsMessage=string&smsGUID=string&serviceType=stringhttp://center.fibosms.com/Service.asmx/SendSMS?clientNo=string&clientPass=string&phoneNumber=string&smsMessage=string&smsGUID=string&serviceType=string

Gi hm: http://center.fibosms.com/service.asmx/SendMaskedSMS?clientNo=string&clientPass=string&senderName=&phoneNumber=string&smsMessage=string&smsGUID=string&serviceType=string Tham s:

- clientNo - clientPass - senderName - phoneNumber - smsMessage - smsGUID - serviceType

Trong :

- senderName: nu c ng k dch v sendername ca Fibo th truyn vo y, khng th trng - phoneNumber: c cu trc nh s in thoi hay dng - smsMessage: ni dung ca tin nhn - smsGUID: ID ca tin nhn, ID ny l t h thng ca khch hng cung cp, sau ny ly trng thi ca

tin nhn thng qua ID ny. Kt qu tr v:

Thnh cng :

200 Sending...



Ti khon ht hn:


Sai s in thoi:

101 Please check your Phone number!

Sai ServiceID:


http://center.fibosms.com/service.asmx/SendMaskedSMS?clientNo=string&clientPass=string&senderName=&phoneNumber=string&smsMessage=string&smsGUID=string&serviceType=stringhttp://center.fibosms.com/service.asmx/SendMaskedSMS?clientNo=string&clientPass=string&senderName=&phoneNumber=string&smsMessage=string&smsGUID=string&serviceType=string

2.6 GetSMSStatus (Pull) Hm ny tr v danh sch trng thi cc tin nhn SMS da vo smsGuid ca khch hng. Vi phng

thc ny th khch hng phi gi ln server ca Fibo ly trng thi tin nhn. Tuy nhin, khch hng c th

dng phng thc hm GetSMSStatus (Push) c cp nht trng thi nhanh hn. Gi hm:

http://center.fibosms.com/Service.asmx/GetSMSStatus?clientNo=string&clientPass=string&smsList=string Cc tham s:

- clientNo - clientPass - smsList

Trong smsList c cu trc nh sau:

MaSoSMS MaSoSMS

Kt qu tr v: C tin nhn ng vi nhng m s khch hng truyn vo

1 3 +841215

1 3 +841215

SMSLIST: mi mt SMSLIST s cha m s (smsguid), trng thi (smsStatus) v s in thoi dng gi (sendername) ca mt SMS.

Khng c SMS:



Xy ra li:

202 Noi dung loi (tuy vao tung truong hop, he thong se co thong bao loi khac nhau)

http://center.fibosms.com/Service.asmx/GetSMSStatus?clientNo=string&clientPass=string&smsList=stringhttp://center.fibosms.com/Service.asmx/GetSMSStatus?clientNo=string&clientPass=string&smsList=string

2.7 GetSMSStatus (Push)

Fibo SMS Gateway Webpage x l cua

i tc

HTTP GET REQUEST

HTTP GET RESPONSE

M hnh kt ni SMS gia FiboSMSGateway v i tc qua giao thc HTTP GET Sau khi cp nht trng thi cui cng ca tin nhn, FiboSMSGateway s gi trang web ca i tc thng

qua giao thc HTTP GET. Trong qu trnh ny, FiboSMSGateway s truyn SMSGUID v Trng thi ca tin nhn n trang web i tc, i tc s s dng nhng thng tin ny x l v sau tr v trng thi x l tin. Ni dung phn hi phi theo chun XML Document do FiboSMSGateway t ra. Khi nhn c ni dung phn hi, FiboSMSGateway s cp nht li trng thi ca tin nhn n.

Vui lng lin h b phn sale nu qu khc hng cha c cung cp ti liu hng dn s dng chc

nng ny.

2.8 GetClientSenderNameList Hm ny tr v danh sch Sender Name m khch hng ng k

Gi Hm: http://center.fibosms.com/Service.asmx/GetClientSenderNameList?clientNo=string&clientPass=string Tham s:


Kt qu tr v:

FiboSMS 1 2008-09-24T11:42:00+07:00

SenderName1 1 2008-09-24T11:42:00+07:00

SenderName2 1 2008-09-24T11:42:00+07:00



Khng c SenderName no:

http://center.fibosms.com/Service.asmx/GetClientSenderNameList?clientNo=string&clientPass=string

2.9 GetListSMSHostingWithBalance Hm ny tr v danh sch cc dch v SMS Hosting m khch hng ng k cng vi s lng tin

nhn cn li ca mi dch v. Trong trng hp khch hng s dng dch v SMS Hosting dng tin th balance s hin th s tin cn li trong ti khon ca khch hng. Nn nu khch hng c dng nhiu dch v th mc balance Gi Hm: http://center.fibosms.com/Service.asmx/GetListSMSHostingWithBalance?clientNo=string&clientPass=string Tham s:


Kt qu tr v:

+841223100690 455

EMail (Free for testing) 2870

Trong : ServiceTypeName: l tn dch v m khch hng ng k Balance: l s lng tin cn li ca dch v



Khng c ng k dch v no:

2.10 GetCommingSMSListFromID (Pull)

Hm dng ly tin nhn n. Cho php ngi dng nhp ID bt u ly tin v. Tuy nhin, khch hng nn dng phng thc hm s 2.21 Fibo ch ng gi tin v li cho khch hng. Nh vy, khch hng s nhn c sms nhanh m khng phi request lin tc vo server Fibo.

Gi hm: http://center.fibosms.com/Service.asmx/GetCommingSMSListFromID?clientNo=string&clientPass=string&fromID=string&serviceTypeID=string Tham s:

- clientNo - clientPass - fromID - serviceType

Trong :

- fromID l ID bt u ly tin nhn, y l ID ca h thng Fibo SMS. ln gi u tin s c gi tr 0.

http://center.fibosms.com/Service.asmx/GetListSMSHostingWithBalance?clientNo=string&clientPass=string%0Dhttp://center.fibosms.com/Service.asmx/GetCommingSMSListFromID?clientNo=string&clientPass=string&fromID=string&serviceTypeID=stringhttp://center.fibosms.com/Service.asmx/GetCommingSMSListFromID?clientNo=string&clientPass=string&fromID=string&serviceTypeID=string

Kt qu tr v: Thnh cng :

357478 +841658555046 Noi dung tin nhan 2009-08-04T20:28:00+07:00 2 2009-08-04T20:28:00+07:00 1429 PrivateFiboSMS

Trong : - ClientCommingSMSID: l ID pht sinh ca h thng FiboSMS, ngi dng lu li ln sau

ly ID ln nht truyn vo link x l cho ln gi tip theo.



Khng c SMS:

301 No SMS!

2.11 GetCommingSMSListFromID (Push)

Fibo SMS Gateway Webpage x l cua

i tc

HTTP GET REQUEST

HTTP GET RESPONSE

Khi nhn c tin nhn do khch hng phn hi ti Modem ring ca i tc, FiboSMSGateway s gi trang web ca i tc thng qua giao thc HTTP GET. Trong qu trnh ny, FiboSMSGateway s truyn tt c thng tin ca ni dung tin nhn n trang web i tc, i tc s s dng nhng thng tin ny x l v sau tr v trng thi x l tin. Ni dung phn hi phi theo chun XML Document do FiboSMSGateway t ra. Khi nhn c ni dung phn hi, FiboSMSGateway s cp nht li trng thi ca tin nhn n.

Vui lng lin h b phn sale nu qu khc hng cha c cung cp ti liu hng dn s dng chc

nng ny.

2.12 SendSMSToMultiMessage_WithoutSplit (new) Hm ny dng gi n ni dung tin nhn ti n s in thoi. Mi s in thoi c mt ni dung ring. Ni

dung ca tin nhn s gii hn l 600 k t bao gm khong trng. Vi hm ny, khch hng ch ng

trong vic nhn sms, khng cn phi tch tin nhn di ra thnh nhiu tin, khng cn phi khai bo s dng chc nng ni tin, v gim thi gian x l trong hng i do s nhn tin nhn nhanh hn. Gi Hm: http://center.fibosms.com//Service.asmx/SendSMSToMultiMessage_WithoutSplit?clientNo=string&clientPass=string&senderName=string&smsMessage=string &serviceType=string Tham s:

- clientNo: m s ti khon ca KH - clientPass: mt khu gi SMS - senderName: nu c ng k dch v sendername ca Fibo th truyn vo y, khng th truyn vo l

n/a - smsMessage: ni dung ca tin nhn v s in thoi ca mi tin nhn. Ti a 600 k t - serviceType: m dch v

Cu trc ca mt smsMessage:

0903636635 acce8d19-2106-46f9-a2d1-8b7991f30232

noi dung tin nhan 1

0903636636 62c55648-29fb-4765-9ec4-a591f0a2b29f noi dung tin nhan 2

Trong PhoneNumber:S in thoi SMSGUID: ID ca tin nhn Message: Ni dung tin nhn Kt qu tr v: Thnh cng :

200 Sending...

Nu c tin nhn khng a c vo h thng ca Fibo:

62c55648-29fb-4765-9ec4-a591f0a2b29f 62c55648-29fb-4765-9ec4-a591f0a2b29f



http://center.fibosms.com/Service.asmx/SendSMSToMultiMessage_WithoutSplit?clientNo=string&clientPass=string&senderName=string&smsMessage=string%20&serviceType=stringhttp://center.fibosms.com/Service.asmx/SendSMSToMultiMessage_WithoutSplit?clientNo=string&clientPass=string&senderName=string&smsMessage=string%20&serviceType=string

Ti khon ht hn:


Nu c tin nhn khng c a vo trong h thng:

SMS ID SMS ID

Sai ServiceID:


S lng tin nhn cn gi nhiu hn s lng tin nhn cn li trong ti khon:

104 The number of SMS is greater than SMS balance!

fibo sms apifibosmsmarketing.com/content/document/635718215469380000.pdf · công ty tnhh phibo ......

Documents