---
title: Inquiry SMS
slug: nicepay-api-messaging-inquiry-sms-api
description: Informasi tentang API Inquiry SMS yang terdapat pada sistem Messaging - SMS API NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/w4cUfjXq2eG7O9WHNJH5e_nicepay-docs-logo.png
icon: {"faIcon":"fa-solid fa-receipt"}
docTags: 
createdAt: 2022-09-28T10:24:49.000Z
---

# Tentang Inquiry SMS

***

API ini digunakan Merchant untuk memeriksa status transmisi menggunakan API `InquiryMms` (hanya untuk status transmisi SMS yang berhasil).



# Specification for Inquiry SMS

***

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



## Request Parameter for Inquiry SMS

***

| **Parameter**                                              | **Tipe** | **Ukuran** | **Deskripsi**         | **Contoh / Catatan**                                             |
| ---------------------------------------------------------- | -------- | ---------- | --------------------- | ---------------------------------------------------------------- |
| `timeStamp`<br /><font color="#2166ae">Required</font>     | N        | 14         | API Request Date      | 20221219110059                                                   |
| `tXid`<br /><font color="#2166ae">Required</font>          | AN       | 30         | Transaction ID        | IONPAYTEST10202212191102221919                                   |
| `iMid`<br /><font color="#2166ae">Required</font>          | AN       | 10         | Merchant ID           | IONPAYTEST                                                       |
| `msgRefno`<br /><font color="#2166ae">Required</font>      | ANS      | 40         | Merchant Order Number | MSG-20221219110053                                               |
| `merchantToken`<br /><font color="#2166ae">Required</font> | AN       | 255        | Merchant Token        | e14233565538732e4273338e8b9ac36618028ffce810747913cd5e39b3fee4f9 |



## Response Parameter for Inquiry SMS

***

:::hint{type="warning"}
*Response Objects* dapat ditambahkan tanpa pemberitahuan terlebih dahulu.
:::

| **Parameter** | **Tipe** | **Ukuran** | **Deskripsi**                                                 | **Contoh / Catatan**                                   |
| ------------- | -------- | ---------- | ------------------------------------------------------------- | ------------------------------------------------------ |
| `resultCd`    | N        | 4          | 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         | Transaction ID (Key from NICEPAY)                             | IONPAYTEST10202212191102221919<br /><br />When Success |
| `transDt`     | N        | 8          | Transmission Date                                             | 20221219                                               |
| `transTm`     | N        | 6          | Transmission Time                                             | 110222                                                 |
| `msgRefno`    | ANS      | 40         | Merchant Order Number (Key from Merchant)                     | MSG-20221219110059                                     |
| `recipientNo` | N        | 16         | Receiver Phone Number                                         | 081294529025 or 6281294529025 <br /><br />When Success |
| `msgStatus`   | N        | 2          | [Transmission Status Code](docId:0dccdS0W5z7yNa0JULSsu)       | 00                                                     |



## Sample JSON for Inquiry SMS

***

:::CodeblockTabs
Java Request

```java
requestMap.put("timeStamp", "20221219110059");
requestMap.put("tXid", "IONPAYTEST10202212191102221919");
requestMap.put("iMid", "IONPAYTEST");
requestMap.put("msgRefno", "MSG-20221219110053");
requestMap.put("merchantToken", "e14233565538732e4273338e8b9ac36618028ffce810747913cd5e39b3fee4f9");
```

JSON Request

```json
{
	"timeStamp":"20221219110059",
	"msgRefno":"MSG-20221219110059",
	"iMid":"IONPAYTEST",
	"tXid":"IONPAYTEST10202212191102221919",
	"merchantToken":"e14233565538732e4273338e8b9ac36618028ffce810747913cd5e39b3fee4f9"
}
```

JSON Response

```json
{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST10202212191102221919",
    "transDt": "20221219",
    "transTm": "110222",
    "msgRefno": "MSG-20221219110059",
    "recipientNo": "081294529025",
    "msgStatus": "00"
}
```
:::



# See also

::::VerticalSplit{layout="middle"}
:::VerticalSplitItem
Kunjungi halaman [SMS Transmit](docId:0GwdGdsFm3-FGBHjsK7PO) untuk mengetahui rincian SMS API yang digunakan saat mengirim pesan.
:::

:::VerticalSplitItem
Kunjungi halaman [Notification SMS](docId\:hcRdbFh-9v_6do48MShRg) untuk mengetahui rincian SMS API yang digunakan saat mengirimkan notifikasi.
:::
::::