ESMS - VN TailieuAPI

VIHAT Technology Co.
LTD
168/75 D2, Binh Thanh, Ho Chi Minh City
Phone: 0902.435.340
Website: http://esms.vn
TI LIU API H THNG ESMS.VN
Contents
I. GII THIU H THNG API ........................................................................................................... 1
II. CC HM GI TIN CA H THNG ............................................................................................ 2
1. Hm ly s d .................................................................................................................................... 2
2. Hm gi tin bng giao thc HTTP GET ......................................................................................... 3
3. Hm gi tin nhn bng u s ngu nhin/c nh theo giao thc HTTP POST........................ 6
4. Hm gi tin nhn bng Brandname theo giao thc HTTP POST ................................................ 8
5. Hm kim tra trng thi tin nhn .................................................................................................. 10
6. Hm kim tra chi tit tng s trong tin nhn ............................................................................... 11
7. Hm np tin vo ti khon bng th in thoi .......................................................................... 13
8. Hm ly danh sch tin nhn theo khong thi gian ..................................................................... 14
III. CP NHT TRNG THI TIN NHN CHO I TC ............................................................... 15
I. GII THIU H THNG API
http://esms.vn
VIHAT Technology Co.LTD
Phone: 0902.435.340
Nu Website, h thng ca bn ang cn tnh nng gi SMS n in thoi chng hn nh nhn

m xc nhn khi ng k Website, hay phn mm qun l nhn s cn nhn tin thng bo lch hp,
chc mng sinh nht nhn vin H thng SMS API ca eSMS s p ng c hon ton cc
yu cu ca bn.
H thng API ca chng ti m bo tnh nhanh, n gin, tin cy v d dng tch hp vo bt k

h thng no.
C th kt ni bng tt c c cc ngn ng lp trnh nh C#, Java, ASP.NET, PHP.
C ch hot ng:
Kt ni thng qua Webservice: POST/Get

Xc thc: cc request ca bn s c h thng xc thc thng qua APIkey v SecretKey, 2 key
ny s c cp sau khi bn ng k ti khon ti eSMS.vn
Trc khi s dng eSMS API vui lng ng k ti khon ti esms.vn ly APIKey v
Secretkey. (C ngay 50 SMS dng th)
Sau khi ng k xong bn truy cp vo Menu Qun l API ly key
Lu : phn ny dnh cho cc lp trnh vin, cc n v c b phn IT. Nu bn khng c b phn

IT v mun chng ti h tr tch hp lin h vi chng ti qua s Hotline: 0902.435.340
Xem bi hng dn chi tit v ti code mu ti y:
esms.vn/blog/3-buoc-de-co-the-gui-tin-nhan-tu-website-ung-dung-cua-ban-bang-sms-api-cua-
esmsvn
II. CC HM GI TIN CA H THNG

1. Hm ly s d
y l hm c bn u tin m bn nn th, hm gip bn ly v s d trong ti khon ca bn.
C php:
http://api.esms.vn/MainService.svc/xml/GetBalance/{APIKey}/{SecrectKey}
http://esms.vn
Phone: 0902.435.340
Bn cn thc hin lnh gi n URL ny
Response tr v c dng:
<MemberModel xmlns="http://schemas.datacontract.org/2004/07/AdvertisingAPI.Model" xml

ns:i="http://www.w3.org/2001/XMLSchema-instance">
<Balance>47385280</Balance>
<CodeResponse>100</CodeResponse>
<ErrorMessage i:nil="true"/>
</MemberModel>
Thng tin tr v
Trng ngha
Balance Tng s d trong ti khon
CodeResponse M kt qu ca request
ErrorMessage Li chi tit nu c
Bng CodeResponseTrng
M ngha
100: Request thnh cng
99 Li khng xc nh , th li sau
101 ng nhp tht bi (api key hoc secrect key khng ng )
102 Ti khon b kha
103 S d ti khon khng d gi tin
104 M Brandname khng ng
2. Hm gi tin bng giao thc HTTP GET
Hm gip gi tin nhn n nhiu s in thoi bng cch gi lnh HTTP GET
Url: http://api.esms.vn/MainService.svc/xml/SendMultipleSMS_v3
http://esms.vn
Phone: 0902.435.340
Chui request c dng:
http://api.esms.vn/MainService.svc/xml/SendMultipleSMS_v3
?Phone={Phone}&Content={Content}&ApiKey={ApiKey}&SecretKey={SecretKey}&IsUni
code={IsUnicode}&Brandnamme={BrandnameCode}&SmsType={SmsType}&RequestID={
RequestID}
Thng tin tham s ca request
STT Tn tham s Kiu d liu ngha

1 APIKEY string Api key dng s dng esms api (c
cung cp khi ng k ti khon ti esms.vn
)
2 SECRETKEY string Secret key dng s dng esms api (c
)
3 Phone String S in thoi cn gi , nu nhiu s cch
nhau bng du , (Ti a 50 s in thoi)
4 Content String Ni dung tin nhn
5 IsUnicode String Tin nhn c Unicode hay khng
6 BrandnameCode String Tn brandname cn gi (Khng bt buc)
7 SmsType String Loi tin nhn
1:Brandname qung co
2:Brandname CSKH
3:u s ngu nhin(tin nhn s gi dng s
bt k 09xxxxx)
4: u s c nh 19001534(gi s cao h
n)
6: u s c nh 8755 (ng k trc khi
s dng)
7: Tin nhn tc cao u s ngu nhin
8: Tin nhn tc cao u s c nh
9 RequestID String ID SMS ca i tc.
Thng tin kt qu
Trng ngha
SMSID ID ca tin nhn lu trn h thng esms.vn, qu khch lu li c
th truy xut cc thng tin chi tit v trng thi SMS v sau
http://esms.vn
Phone: 0902.435.340
CodeResult M kt qu ca request
ErrorMessage Chi tit li nu c
Bng CodeResponse
M ngha
100 Request thnh cng
102 Ti khon b kha
118 Loi tin nhn khng hp l
119 Brandname qung co phi gi t nht 20 s in thoi
131 Tin nhn brandname qung co di ti a 422 k t
132 Khng c quyn gi tin nhn u s c nh 8755
Url mu:
http://api.esms.vn/MainService.svc/xml/SendMultipleSMS_v3?Phone=0933556925&Content=X
in+ch%c3%a0o+b%e1%ba%a1n+%3a+&ApiKey=XXX&SecretKey=YYY
Lu :
Nu khng truyn tham s sau y , h thng s t xc nh nh sau
1. SmsType = 3 Tin nhn ngu nhin

2. IsUnicode = false
Ni dung tin nhn trnh sai lch khi truyn trn RestFull, ngh qu khch EncodeURL Ni dung
tin nhn trc khi gi
http://esms.vn
Phone: 0902.435.340
V d:
string Content = "Xin cho bn : ";

Content = HttpUtility.UrlEncode(Content);
3. Hm gi tin nhn bng u s ngu nhin/c nh theo giao thc HTTP POST
Hm cho php bn gi tin nhn n 1 hoc nhiu s in thoi bng u s ngu nhin(tin
nhn ngi nhn s thy mc gi n l mt s in thoi dng 09xxxx) hoc bng u s c
nh 19001534(chi ph cao hn)
ng dn:
http://api.esms.vn/MainService.svc/xml/SendMultipleMessage_V2/
Cc bn cn gi lnh POST n URL trn vi data POST ln c dng nh sau:
<RQST>
<APIKEY>yourapikey</APIKEY>
<SECRETKEY>yoursecretkey</SECRETKEY>
<ISFLASH>0</ISFLASH>"
<UNICODE>0<UNICODE>
<SMSTYPE>X<SMSTYPE>
<REQUESTID>X<REQUESTID>
<CONTENT>Welcome to esms.vn</CONTENT>
<CONTACTS>
<CUSTOMER>
<PHONE>.</PHONE>
</CUSTOMER>
<CUSTOMER>
<PHONE>.</PHONE>
</CUSTOMER>
</CONTACTS>
</RQST>
Tham s:
Tham s ngha
PHONE S in thoi cn gi
CONTENT Ni dung tin nhn

UNICODE 0: gi tin nhn khng du. Tin nhn khng du 160 k t/tin
1: gi tin nhn c du, lc ny content cn c escapse html. Tin c du
: 70 k t/tin
http://esms.vn
Phone: 0902.435.340
SMSTYPE Loi tin nhn

3: u s ngu nhin(tin nhn s gi dng s bt k 09xxxxx)
4: u s c nh 19001534(gi s cao hn)
6: u s c nh 8755, ch dng chm sc khch hng. Gi thp hn 1
9001534 v cao hn ngu nhin.
Lu : Khi dng tin nhn xc thc hoc OTP nn dng cc u s c n
h s m bo tc cao nht.
APIKEY APIKey c cp vi ti khon ng k trn esms.vn
SECRETKEY SecretKey c cp vi ti khon ng k trn esms.vn
REQUESTID ID SMS ca i tc
Kt qu tr v c dng:
<SmsResultModel>
<CodeResult></CodeResult>
<ErrorMessage></ErrorMessage>
<SMSID></SMSID>
</SmsResultModel>
Thng tin kt qu
Trng ngha
Bng CodeResponse
M ngha
102 Ti khon b kha
http://esms.vn
Phone: 0902.435.340
4. Hm gi tin nhn bng Brandname theo giao thc HTTP POST

Hm cho php bn gi tin nhn n 1 hoc nhiu s in thoi bng Brandname(tin nhn ngi
nhn s thy mc gi n l tn cng ty).
Tuy nhin gi c tin nhn Brandname bn cn ng k Brandname vi chng ti. ng

k vui lng lin h b phn kinh doanh: 0902.435.340
ng dn:
http://api.esms.vn/MainService.svc/xml/SendMultipleSMSBrandname/
Cc bn cn gi lnh POST n URL trn vi data POST ln c dng nh sau:
<RQST>
<APIKEY></APIKEY>
<SECRETKEY></SECRETKEY>
<CONTENT></CONTENT>
<SMSTYPE></SMSTYPE>
<BRANDNAME></BRANDNAME>
<CONTACTS> // Loop here
<CUSTOMER>
<PHONE></PHONE>
<CUSTOMER>
<CUSTOMER>
<PHONE></PHONE>
<CUSTOMER>
</CONTACTS>
</RQST>
Tham s:
http://esms.vn
Phone: 0902.435.340
Tham s ngha
PHONE S in thoi cn gi
CONTENT Ni dung tin nhn

APIKEY APIKey c cp vi ti khon ng k trn esms.vn
SECRETKEY SecretKey c cp vi ti khon ng k trn esms.vn
Brandname Brandname ng k thnh cng vi eSMS.vn

SMSTYPE Loi tin nhn : 1 BrandName qung co ; 2 BrandName CSKH
Kt qu tr v c dng
<SmsResultModel>
<SMSID></SMSID>
</SmsResultModel>
Thng tin kt qu
Trng ngha
Bng CodeResponse
M ngha
102 Ti khon b kha
104 Brandname cha c ng k
http://esms.vn
Phone: 0902.435.340
118 SmsType khng ng
5. Hm kim tra trng thi tin nhn

Hm gip bn kim tra trng thi ca tin nhn gi i.
ng dn:
http://api.esms.vn/MainService.svc/xml/GetSmsStatus/
POST Data:
<RQST>
<APIKEY>YourAPIKey</APIKEY>
<SECRETKEY>YourSecretkey</SECRETKEY>
<SMSID>xxx</SMSID>
</RQST>
Tham s:
Tham s ngha
APIKey APIKey c cp vi ti khon ng k trn esms.vn
SecretKey SecretKey c cp vi ti khon ng k trn esms.vn

SMSID ID ca SMS c tr v sau khi gi cc lnh gi tin
Kt qu tr v
<SmsStatus>
<StatusCode></StatusCode>
<SuccessCount></SuccessCount>
<FailedCount></FailedCount>
<TotalSent></TotalSent>
http://esms.vn
Phone: 0902.435.340
<TotalReceiver></TotalReceiver>
</SmsStatus>
Bng kt qu
M ngha
SmsID M tin nhn, c tr v sau khi gi API gi tin
SendStatus Trng thi tin nhn:

1: ang ch duyt
2: ang ch gi
3: ang gi
4: b t chi
5: gi xong
6: b xa
TotalSent Tng s tin nhn cn gi

TotalReceiver Tng s ngi nhn
SentSuccess Tng s tin nhn gi thnh cng
SentFailed Tng s tin nhn gi tht bi
6. Hm kim tra chi tit tng s trong tin nhn

Hm ly danh sch s in thoi ca mt tin nhn gi(da trn SmsID h thng tr v ) km
theo trng thi gi ( S in thoi gi thnh cng cha ? )
Url: http://api.esms.vn/MainService.svc/xml/GetSmsReceiverStatus/
Chui request c dng:

<RQST>
<APIKEY></APIKEY>
<SMSID></SMSID>
</RQST>
http://esms.vn
Phone: 0902.435.340

)
)
3 SMSID String ID ca tin nhn (c h thng tr v khi
gi tin nhn )
Chui response c dng:
<SmsReceiver>
<Receiver>
<Phone></Phone>
<SentResult></SentResult>
</Receiver>
<Receiver>
<Phone></Phone>
<SentResult></SentResult>
</Receiver>
</SmsReceiver>
Thng tin tham s ca Response
STT Tn tham s Kiu d ngha

liu
1 CodeResult string M trng thi thng bo kt qu

request
2 ErrorMessage string Chi tit li (nu c)
3 Phone String S in thoi ngi nhn
4 SentResult String Kt qu gi (True:thnh cng , False:
tht bi)
http://esms.vn
Phone: 0902.435.340
Bng m ca CodeResult
STT M tr v ngha
1 100 Thnh cng
2 99 Li khng xc nh
3 105 SMS ID khng tn ti trong h thng
4 101 Api key / Secret key khng ng
7. Hm np tin vo ti khon bng th in thoi
Hm gip np tin vo ti khon eSMS.vn bng th co in thoi
Url: http://api.esms.vn/MainService.svc/xml/ChargeByMobileCard/
Chui request c dng:

<RQST>
<APIKEY></APIKEY>
<CARDSERI></CARDSERI>
<CARDSECRET></CARDSECRET>
<CARDTYPE></CARDTYPE>
</RQST>

)
)
3 CARDSERI String S seri th co
4 CARDSECRET String M th co
5 CARDTYPE String Nh mng: mobifone, vinaphone,viettel
Chui response c dng:
<MobileChargeResponse>
<CodeResponse></CodeResponse>
<AmountCharge></AmountCharge>
</MobileChargeResponse>
http://esms.vn
Phone: 0902.435.340
Thng tin tham s ca Response
STT Tn tham s Kiu d ngha

liu
1 CodeResponse string M trng thi thng bo kt qu

request
2 ErrorMessage string Chi tit li (nu c)
3 AmountCharge String S tin thc nhn (sau khi tr ph np
tin)
Bng m ca CodeResult
STT M tr v ngha
1 100 Thnh cng
2 99 Li khng xc nh
3 119 S seri khng tn ti
4 120 M th khng tn ti
5 121 M nh mng khng tn ti
6 122 Np tht bi (Nguyn nhn tr v trong ErrorMessage)
8. Hm ly danh sch tin nhn theo khong thi gian
Url: http://api.esms.vn/MainService.svc/xml/GetSmsSentData/
Chui request c dng:
<RQST>
<APIKEY></APIKEY>
<FROM></FROM>
<TO></TO>
</RQST>

)
http://esms.vn
Phone: 0902.435.340

)
3 FROM String Thi gian bt u (nh dng:
MM/dd/YYYY)
4 TO String Thi gian kt thc (nh dng:
MM/dd/YYYY)
Thng tin kt qu
Trng ngha
SentTime Thi gian gi
Phone S in thoi
Content Ni dung
SmsType Loi tin nhn
SentStatus Trng thi gi
Bng CodeResponse
M ngha
100 Request thnh cng
140 nh dng thi gian gi ln khng hp l
III. CP NHT TRNG THI TIN NHN CHO I TC
http://esms.vn
Phone: 0902.435.340
Ngoi vic c th ch ng gi API get trng thi tin nhn ly tnh trng gi tin ca tin
nhn, khch hng c th cu hnh nhn cc request cp nht trng thi tin vi bng tham
s nh sau:
Khch hng cung cp URL dng: http://yourdomain.com/URLNhanRequest
URL m eSMS.vn s request sang i tc:
yourdomain.com/URLNhanRequest?RequestId=XXX&SmsId=XXX&CustomerPhone=X
XX&SentStatus=XXX&ErrorInfo=XXX
Trong :
Trng ngha
RequestId L ID ca SMS ca pha i tc truyn ln khi gi tin nhn
(SMSID ca i tc)
SmsId L ID ca SMS m pha eSMS.vn pht sinh sau khi tin nhn
c to (SMSID ca eSMS.vn)
CustomerPhone S in thoi ngi nhn tin nhn
SentStatus Trng thi tin nhn ca s in thoi tng ng (1 l thnh cng,

0 l tht bi)
ErrorInfo Chi tit li
Lin h:
Mi vn v API vui lng lin

h:
Email: contact@esms.vn
Phone: 0902.435.340
Skype: kaioken14
http://esms.vn

ESMS - VN TailieuAPI

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ESMS - VN TailieuAPI

Uploaded by

Copyright:

Available Formats

VIHAT Technology Co.

TI LIU API H THNG ESMS.VN

I. GII THIU H THNG API

Nu Website, h thng ca bn ang cn tnh nng gi SMS n in thoi chng hn nh nhn

H thng API ca chng ti m bo tnh nhanh, n gin, tin cy v d dng tch hp vo bt k

C th kt ni bng tt c c cc ngn ng lp trnh nh C#, Java, ASP.NET, PHP.

Kt ni thng qua Webservice: POST/Get

Sau khi ng k xong bn truy cp vo Menu Qun l API ly key

Lu : phn ny dnh cho cc lp trnh vin, cc n v c b phn IT. Nu bn khng c b phn

Xem bi hng dn chi tit v ti code mu ti y:

II. CC HM GI TIN CA H THNG

Bn cn thc hin lnh gi n URL ny

<MemberModel xmlns="http://schemas.datacontract.org/2004/07/AdvertisingAPI.Model" xml

100: Request thnh cng

101 ng nhp tht bi (api key hoc secrect key khng ng )

102 Ti khon b kha

103 S d ti khon khng d gi tin

104 M Brandname khng ng

2. Hm gi tin bng giao thc HTTP GET

Chui request c dng:

Thng tin tham s ca request

STT Tn tham s Kiu d liu ngha

9 RequestID String ID SMS ca i tc.

100 Request thnh cng

101 ng nhp tht bi (api key hoc secrect key khng ng )

102 Ti khon b kha

103 S d ti khon khng d gi tin

104 M Brandname khng ng

118 Loi tin nhn khng hp l

119 Brandname qung co phi gi t nht 20 s in thoi

131 Tin nhn brandname qung co di ti a 422 k t

132 Khng c quyn gi tin nhn u s c nh 8755

Nu khng truyn tham s sau y , h thng s t xc nh nh sau

1. SmsType = 3 Tin nhn ngu nhin

string Content = "Xin cho bn : ";

Cc bn cn gi lnh POST n URL trn vi data POST ln c dng nh sau:

CONTENT Ni dung tin nhn

SMSTYPE Loi tin nhn

SECRETKEY SecretKey c cp vi ti khon ng k trn esms.vn

101 ng nhp tht bi (api key hoc secrect key khng ng )

102 Ti khon b kha

103 S d ti khon khng d gi tin

104 M Brandname khng ng

4. Hm gi tin nhn bng Brandname theo giao thc HTTP POST

Tuy nhin gi c tin nhn Brandname bn cn ng k Brandname vi chng ti. ng

Cc bn cn gi lnh POST n URL trn vi data POST ln c dng nh sau:

<CONTACTS> // Loop here

CONTENT Ni dung tin nhn

SECRETKEY SecretKey c cp vi ti khon ng k trn esms.vn

Brandname Brandname ng k thnh cng vi eSMS.vn

101 ng nhp tht bi (api key hoc secrect key khng ng )

102 Ti khon b kha

103 S d ti khon khng d gi tin

104 Brandname cha c ng k

118 SmsType khng ng

5. Hm kim tra trng thi tin nhn

APIKey APIKey c cp vi ti khon ng k trn esms.vn

SecretKey SecretKey c cp vi ti khon ng k trn esms.vn

SmsID M tin nhn, c tr v sau khi gi API gi tin

SendStatus Trng thi tin nhn:

TotalSent Tng s tin nhn cn gi

6. Hm kim tra chi tit tng s trong tin nhn

Chui request c dng: