SMS API

6 min

To allow ﻿ use of ﻿ ﻿ ﻿s, ﻿s need to integrate this ﻿ with ﻿ ﻿ ﻿. The SMS API is a collection of ﻿ ﻿s that You can use in ﻿ ﻿-sending ﻿ to your ﻿s or other message recipients.
﻿
Process Flow
﻿
SMS API Flow
﻿
The ﻿ registers data.
The ﻿ sends data using ﻿ Registration ﻿ to ﻿.
﻿﻿ register data.
﻿﻿ sends ﻿ data info to ﻿ NICE ﻿ ﻿.
NICE ﻿ sends response data ﻿ to ﻿.

﻿﻿ sends data info to ﻿s.

NICE SMS will send ﻿ info to ﻿.
﻿﻿ processes ﻿ Data Status info and stores it in ﻿ DB.
﻿﻿ sends data ﻿s to ﻿s.
The ﻿ sends a request for ﻿ ﻿ to ﻿.
﻿﻿ sends response info 200 - OK to ﻿.
﻿
Integration Specification
﻿
Term
Description
Specification
Merchant
e-Commerce company or store that uses ﻿ ﻿ ﻿s.
﻿
Merchant Key
Authentication key prepared by ﻿ 
Must secure
MerchantToken
Token from ﻿ side
Don't create Token from ﻿ Client side
iMid
﻿﻿ ID
﻿
tXid
Transaction ID
﻿
smsMsg
Message content
Message Length
﻿﻿ will provide ﻿ message delivery in one ﻿ up to 640 characters or 4 ﻿ messages, with ﻿ following details:
160 characters = 1 message
If it is more than 160 characters, it will be calculated as follows
Semua Telecom Operator (Non XL).
161 - 320 characters = 2 messages.
321 - 459 characters = 3 messages.
481 - 640 characters = 4 messages.
XL Telecom Operator.
161 - 306 characters = 2 messages.
307 - 459 characters = 3 messages.
460 - 612 characters = 4 messages.
﻿
Valid Character
Alphabets (lowercase, uppercase)
Number
Special Characters ! @ $ * ( ) - + & _ = . , : ; / \ ? { } " % (space) (enter)
smsType
To determine ﻿ type of ﻿ sent
0 : Normal ﻿ 
1 : Alert ﻿ 
2 : OTP ﻿


For OTP ﻿ , ﻿ guarantees ﻿ delivery time from ﻿ company to ﻿ Telco is under 300 seconds, and ﻿ OTP will lower when ﻿ sending time is more than 300 seconds.
Special Character % must follow by a space.
﻿
SMS API Types
﻿
﻿SMS Transmit﻿ ﻿ used to sending ﻿.
﻿Notification SMS﻿ API used to check ﻿ sending ﻿. 
﻿SMS Inquiry﻿ ﻿ used to check ﻿ success ﻿ sending ﻿. 
﻿
See also
﻿﻿ ﻿ Payout (Disbursement) API﻿  ﻿ to learn detail ﻿ used on ﻿ ﻿.
﻿﻿ ﻿ FAQ NICEPAY API﻿ ﻿ if you want to find out frequently asked questions related to ﻿ ﻿.
﻿

Term	Description	Specification
Merchant	e-Commerce company or store that uses s.
Merchant Key	Authentication key prepared by	Must secure
MerchantToken	Token from side	Don't create Token from Client side
iMid	ID
tXid	Transaction ID
smsMsg	Message content	Message Length will provide message delivery in one up to 640 characters or 4 messages, with following details: 160 characters = 1 message If it is more than 160 characters, it will be calculated as follows Semua Telecom Operator (Non XL). 161 - 320 characters = 2 messages. 321 - 459 characters = 3 messages. 481 - 640 characters = 4 messages. XL Telecom Operator. 161 - 306 characters = 2 messages. 307 - 459 characters = 3 messages. 460 - 612 characters = 4 messages. Valid Character Alphabets (lowercase, uppercase) Number Special Characters ! @ $ * ( ) - + & _ = . , : ; / \ ? { } " % (space) (enter)
smsType	To determine type of sent	0 : Normal 1 : Alert 2 : OTP For OTP , guarantees delivery time from company to Telco is under 300 seconds, and OTP will lower when sending time is more than 300 seconds.

Notification - API Payout (Disbursement)

SMS Transmit

SMS API

Process Flow

Integration Specification

SMS API Types

See also

Welcome to NICEPAY DOCS