---
title: Inquiry SMS
slug: en/nicepay-api-messaging-inquiry-sms-api
description: Information about SMS Inquiry API available on NICEPAY Messaging - SMS API system
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/mtZ03NzF0-QaTc5kmcYqg_nicepay-docs-logo.png
icon: {"faIcon":"fa-solid fa-receipt"}
docTags: 
createdAt: 2022-09-28T10:24:49.000Z
---

# About Inquiry SMS 

***

The Merchant uses this API to check transmission status using `InquiryMMs` API (only successful SMS transmission status).

 

# 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**                                              | **Type** | **Size** | **Description**       | **Example / Notes**                                              |
| ---------------------------------------------------------- | -------- | -------- | --------------------- | ---------------------------------------------------------------- |
| `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 can be added without prior notification .
:::

| **Parameter** | **Type** | **Size** | **Description**                                               | **Example / Notes**                                    |
| ------------- | -------- | -------- | ------------------------------------------------------------- | ------------------------------------------------------ |
| `resultCd`    | N        | 4        | Result Code:<br />[Error Code](docId\:yn6J-nZYl5Br-FEXKBPXH)  | 0000                                                   |
| `resultMsg`   | AN       | 255      | Result Message: [Error Code](docId\:yn6J-nZYl5Br-FEXKBPXH)    | 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\:fUh0PlDM3Q0aVv5_APMzP)      | 00                                                     |



## Sample JSON

***

:::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
Visit the [SMS Transmit](docId\:tmBC9t4otgO1HCWOYgFMz) page to know detail SMS API used to sending message. &#x20;
:::

:::VerticalSplitItem
Visit the [Notification SMS](docId\:T5yPftyWX7DHhvNrHuoe_) page to learn SMS API detail used to send notification.
:::
::::