SMS API
To allow the use of NICEPAY SMS products, Merchants need to integrate this API with the Merchant system. The SMS API is a collection of NICEPAY APIs that You can use in the SMS-sending process to your customers or other message recipients.
![SMS API Flow SMS API Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/pLcW-u2GdWk4tPOlzBSHX_nicepay-archbee-payment-sms.png?format=webp)
- The Merchant registers data
- The Merchant sends data using the Registration API to NICEPAY
- NICEPAY register data
- NICEPAY sends SMS data info to the NICE SMS service
- NICE SMS sends response data information to NICEPAY
- NICEPAY sends data info to Merchants
- NICE SMS will send status info to NICEPAY
- NICEPAY processes the Data Status info and stores it in the DB
- NICEPAY sends data notifications to Merchants
- The Merchant sends a request for status information to NICEPAY
- NICEPAY sends response info 200 - OK to Merchant
Term | Description | Specification |
Merchant | e-Commerce company or store that uses NICEPAY SMS services. | |
Merchant Key | Authentication key prepared by NICEPAY | Must secure |
MerchantToken | Token from NICEPAY side | Don't create Token from the client side |
iMid | Merchant ID | |
tXid | Transaction ID | |
smsMsg | Message content | Message Length NICEPAY will provide transaction message delivery in one transaction up to 640 characters or 4 transaction messages, with the following details:
Karakter yang Berlaku
|
smsType | To determine the type of SMS sent | 0 : Normal SMS 1 : Alert SMS 2 : OTP SMS For OTP SMS. NICEPAY guarantees the delivery time from the company to the Telco is under 300 seconds, and the OTP will lower when the sending time is more than 300 seconds |
Special Character % must follow by a space
![Link block header image](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/9YBrDpEFQGBYDp9a1FZdy_api-sms-transmit.png?format=webp)
SMS Transmit API used to sending SMS.
![Link block header image](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/ltDh9WnggP-k9h-5Llf61_api-sms-notification.png?format=webp)
Notification SMS API used to check SMS sending status.
![Link block header image](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/e-7rTwUF1i01I1H7TwPJy_api-sms-inquiry.png?format=webp)
SMS Inquiry API used to check the success SMS sending status.
Visit the Payout (Disbursement) API page to learn detail API used on Payout process.
Visit the FAQ NICEPAY API page if you want to find out frequently asked questions related to NICEPAY API.