---
title: SMS Transmit
slug: nicepay-api-messaging-sms-transmit-sms-api
description: Informasi tentang API SMS Transmit yang terdapat pada sistem Messaging - SMS API NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/HLdOKs4--eqPkmy2EfGwE_nicepay-docs-logo.png
icon: {"faIcon":"fa-solid fa-comment-sms"}
docTags: 
createdAt: 2022-09-28T10:22:16.000Z
---

# Tentang SMS Transmit

***

API ini digunakan untuk mengirimkan pesan kepada para Pelanggan suatu Merchant atau pihak-pihak terkait lainnya. NICEPAY memiliki *Single SMS transmit* dan didukung oleh 4 Provider Partner populer di Indonesia, yaitu Telkomsel, Indosat Ooredoo Hutchison, XL, dan Smartfren.

:::hint{type="warning"}
Pastikan token saldo SMS Anda cukup sebelum Anda melakukan proses SMS Transmit ini. Silakan kunjungi halaman [Deposit Saldo](docId\:VdIDXX3uGz0y1dGVucMGp) untuk mendapatkan rincian informasi terkait.
:::



# Specification - SMS Transmit

***

| **API url**         | `/nicepay/direct/v2/sms-transmit`                       |
| ------------------- | ------------------------------------------------------- |
| **Request Method**  | <font color="#3b9f0f">**POST**</font>                   |
| **Merchant Token**  | SHA256 (`timestamp`+ `iMid`+ `msgRefNo`+ `merchantKey`) |



## Request Parameter for SMS Transmit

***

| **Parameter**                                              | **Tipe** | **Ukuran** | **Deskripsi**                                                            | **Contoh / Catatan**                                             |
| ---------------------------------------------------------- | -------- | ---------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------- |
| `timeStamp`<br /><font color="#2166ae">Required</font>     | N        | 14         | API Request Date                                                         | 20221219110059                                                   |
| `iMid`<br /><font color="#2166ae">Required</font>          | AN       | 10         | Merchant ID                                                              | IONPAYTEST                                                       |
| `msgRefNo`<br /><font color="#2166ae">Required</font>      | ANS      | 40         | Merchant Order Number (Key from Merchant)                                | MerchantReferenceNumber001                                       |
| `smsType`<br /><font color="#2166ae">Required</font>       | N        | 1          | SMS Type<br />`0` : Normal <br />`1` : Alert <br />`2` : OTP             | 2                                                                |
| `reservedFlag`<br /><font color="#2166ae">Required</font>  | N        | 1          | Sending Type<br />`0` : Realtime Processing <br />`1` : Batch Processing | 0                                                                |
| `reservedDt`                                               | N        | 8          | Send Date Request (`YYYYMMDD`)                                           |                                                                  |
| `reservedTm`                                               | N        | 6          | Send Time Request<br />(`HH24MiSS`)                                      |                                                                  |
| `sender`                                                   | AN       | 11         | Sender’s Number or Masking                                               | JATI\_TSEL\_IONPAYTEST001                                        |
| `recipientNo`<br /><font color="#2166ae">Required</font>   | N        | 16         | Recipient's Mobile Number                                                | +6281294529025                                                   |
| `smsMsg`<br /><font color="#2166ae">Required</font>        | ANS      | 640        | Message Content                                                          |                                                                  |
| `dbProcessUrl`<br /><font color="#2166ae">Required</font>  | AN       | 255        | Result Notification URL<br />(Async Notification)                        | https\://nicetest.requestcatcher.com/test                        |
| `reqNm`<br /><font color="#2166ae">Required</font>         | AN       | 30         | Requestor PIC Name                                                       |                                                                  |
| `merchantToken`<br /><font color="#2166ae">Required</font> | AN       | 255        | Merchant Token                                                           | 9b62af7cc5357e7071662e5bb7950a03bda2f9efb2e5801298f663001196a199 |



## Response Parameter for SMS Transmit

***

| **Parameter** | **Tipe** | **Ukuran** | **Deskripsi**                                                 | **Contoh / Catatan**                                   |
| ------------- | -------- | ---------- | ------------------------------------------------------------- | ------------------------------------------------------ |
| `resultCd`    | N        | 14         | Result Code:<br />[Error Code](docId\:JKO_1O-kS-XzfZAqPwNIN)  | 0000                                                   |
| `resultMsg`   | AN       | 255        | Result Message: [Error Code](docId\:JKO_1O-kS-XzfZAqPwNIN)    | SUCCESS                                                |
| `tXid`        | AN       | 30         | NICEPAY Order Number (Key From NICEPAY)                       | IONPAYTEST10202212191102221919<br /><br />When Success |
| `msgStatus`   | N        | 2          | [Transmission Status Code](docId:0dccdS0W5z7yNa0JULSsu)       |                                                        |



## Sample JSON for SMS Transmit

***

:::CodeblockTabs
JSON Request

```json
{
    "timeStamp": "20221219110059",
    "iMid": "IONPAYTEST",
    "smsType": "2",
    "reservedFlag": "0",
    "reservedDt": "",
    "reservedTm": "",
    "msgRefno": "MSG-20221219110059",
    "recipientNo": "+6281294529025",
    "smsMsg": "Testing masukkan kode 123456 dalam 30 menit.",
    "dbProcessUrl": "https://nicetest.requestcatcher.com/test",
    "reqNm": "NICEPAY",
    "sender": "JATI_TSEL_IONPAYTEST001",
    "merchantToken": "9b62af7cc5357e7071662e5bb7950a03bda2f9efb2e5801298f663001196a199"
}
```

JSON Response

```json
{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST10202212191102221919",
    "msgStatus": "00"
}
```

Java Request

```java
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")
```
:::



# See also

::::VerticalSplit{layout="middle"}
:::VerticalSplitItem
Kunjungi halaman [Notification SMS](docId\:hcRdbFh-9v_6do48MShRg) untuk mengetahui rincian SMS API yang digunakan saat mengirimkan notifikasi.
:::

:::VerticalSplitItem
Kunjungi halaman [Inquiry SMS](docId:0bfa4LFEowD2edz37yLWh) untuk mengetahui rincian SMS API yang digunakan untuk melakukan inquiry.
:::
::::