SMS Transmit

9 min

About SMS Transmit

This API uses to send messages to Customers from a Merchant or other related parties. NICEPAY has Single SMS transmit and is supported by 4 popular Provider Partners in Indonesia; Telkomsel, Indosat Ooredoo Hutchison, XL, dan Smartfren.

Ensure your SMS token balance is sufficient before proceeding with this SMS Transmit process. Please navigate to Balance Deposits for more detailed information regarding SMS balances.

Specification - SMS Transmit

API url	/nicepay/direct/v2/sms-transmit
Request Method	POST
Merchant Token	SHA256 (timestamp+ iMid+ msgRefNo+ merchantKey)

Request Parameter for SMS Transmit

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	API Request Date	20221219110059
iMid Required	AN	10	Merchant ID	IONPAYTEST
msgRefNo Required	ANS	40	Merchant Order Number (Key from Merchant)	MerchantReferenceNumber001
smsType Required	N	1	SMS Type 0 : Normal 1 : Alert 2 : OTP	2
reservedFlag Required	N	1	Sending Type 0 : Realtime Processing 1 : Batch Processing	0
reservedDt	N	8	Send Date Request (YYYYMMDD)
reservedTm	N	6	Send Time Request (HH24MiSS)
sender	AN	11	Sender’s Number or Masking	JATI_TSEL_IONPAYTEST001
recipientNo Required	N	16	Recipient's Mobile Number	+6281294529025
smsMsg Required	ANS	640	Message Content
dbProcessUrl Required	AN	255	Result Notification URL (Async Notification)	https://nicetest.requestcatcher.com/test
reqNm Required	AN	30	Requestor PIC Name
merchantToken Required	AN	255	Merchant Token	9b62af7cc5357e7071662e5bb7950a03bda2f9efb2e5801298f663001196a199

Response Parameter for SMS Transmit

Parameter	Type	Size	Description	Example / Notes
resultCd	N	14	Result Code: Error Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	NICEPAY Order Number (Key From NICEPAY)	IONPAYTEST10202212191102221919 When Success
msgStatus	N	2	Transmission Status Code

Sample JSON for SMS Transmit

requestMap.put("timeStamp", "20221219110059");
requestMap.put("iMid", "IONPAYTEST");
requestMap.put("merchantToken", 
"9b62af7cc5357e7071662e5bb7950a03bda2f9efb2e5801298f663001196a199");
requestMap.put("msgRefNo","MSG-20221219110059");
requestMap.put("smsType", "2");
requestMap.put("reservedFlag", "0");
requestMap.put("reservedDt", "");
requestMap.put("reservedTm", "");
requestMap.put("sender","JATI_TSEL_IONPAYTEST001");
requestMap.put("recipientNo","+6281294529025");
requestMap.put("smsMsg","Testing masukkan kode 123456 dalam 30 menit.");
requestMap.put("dbProcessUrl", "https://nicetest.requestcatcher.com/test");
requestMap.put("reqNm", "NICEPAY")

20221219110059