WhatsApp Inbox REST API
WhatsApp Inbox REST API for SMSGatewayCenter APIs
WhatsApp Inbox REST API
Use the Inbox REST API to fetch incoming WhatsApp messages for your account over HTTP. Filter by WABA number, sender mobile, reply status, assigned agent, message id, and date range. This endpoint is read-only, accepts GET requests, and returns JSON.
API Endpoint
https://unify.smsgateway.center/rest/wa/v1/inboxLegacy alias without v1 in the path is also supported: /rest/wa/inbox
Authentication
Send your account userid and password as request parameters, or send your account API key in the apikey request header. WhatsApp product access must be enabled on your account. Do not publish live usernames or passwords.
| Parameter | Required | Description | Example/Value |
|---|---|---|---|
| Authentication | |||
| userid | Yes | Your SMSGatewayCenter account username. Required even when the apikey header is used. | YourUsername |
| password | Yes* | Your account password. Not required when the apikey header is used. | ********** |
| output | Yes | Response format. Must be json. | json |
| Optional Parameters | |||
| action | Optional | Defaults to list. Only list is supported in v1. | list |
| wabaNumber | Optional | Filter by your WhatsApp Business Account number, digits only. Must belong to the authenticated account. | 9170396xxxxx |
| mobileNo | Optional | Filter by sender mobile number with country code, digits only. | 919876543210 |
| isReplied | Optional | Filter reply status: 0 not replied, 1 replied. | 0 |
| agentId | Optional | Filter by assigned agent id (numeric). | 12 |
| waMsgId | Optional | Filter by WhatsApp message id. Maximum 50 characters. | wamid.HBgMOTEXAMPLE |
| fromDate | Optional | Start of received date range. Format YYYY-MM-DD or full date/time. Date-only values start at 00:00:00. Alias: from. | 2026-07-14 |
| toDate | Optional | End of received date range. Format YYYY-MM-DD or full date/time. Date-only values end at 23:59:59. Alias: to. | 2026-07-14 |
| page | Optional | Page number. Default 1. | 1 |
| limit | Optional | Records per page. Default 50, maximum 200. | 50 |
Sample Request (cURL)
curl --location 'https://unify.smsgateway.center/rest/wa/v1/inbox?userid=YourUsername&password=xxxxx&output=json&action=list&fromDate=2026-07-14&toDate=2026-07-14&page=1&limit=50'
Sample Request - API Key Header (cURL)
curl --location --get 'https://unify.smsgateway.center/rest/wa/v1/inbox' \
--header 'apikey: YourApiKey' \
--data-urlencode 'userid=YourUsername' \
--data-urlencode 'output=json' \
--data-urlencode 'action=list' \
--data-urlencode 'wabaNumber=9170396xxxxx' \
--data-urlencode 'mobileNo=919876543210' \
--data-urlencode 'isReplied=0' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=50'
Sample Success Response
{
"status": "success",
"inboxList": [
{
"incomingId": "8801",
"wabaNumber": "9170396xxxxx",
"mobileNo": "919876543210",
"waMsgId": "wamid.HBgMOTEXAMPLE",
"messageType": "text",
"messageTypeId": 1,
"profileName": "Rahul",
"message": "Hi, I need help with my order",
"mediaUrl": "",
"isReplied": 0,
"repliedMedium": "",
"timestamp": 1752480000000,
"charges": "0.00",
"agentName": "NA"
}
],
"statusCode": "200",
"reason": "success",
"totalRecords": 1,
"page": 1,
"limit": 50,
"fromDate": "2026-07-14 00:00:00",
"toDate": "2026-07-14 23:59:59"
}
Sample Error Response
{
"status": "error",
"inboxList": [],
"statusCode": "403",
"reason": "WhatsApp product is not enabled for this account."
}
Notes
- Results are newest first.
- When
wabaNumberis sent, it must belong to the authenticated account. fromDatecannot be aftertoDate.- Expired accounts receive an expiry message and no inbox data.
- This API is read-only. To reply, use the Send WhatsApp Message API.
Testimonials
