POST api/getSmsLogs
Get SMS logs. Use restrictByLocations query parameter for restrict list of desired locations. Status: All - 0, Pending - 1, Sent - 2, Delivered - 3, Undelivered - 4. Type: ALL - NULL, Regular - 0, Booking - 1, Marketing - 2, CustomerReview - 3, AuthCode - 4, System - 5, OneTimePassword - 6, PasswordResetCode - 7, UpdateShipInfo - 8, DirectToCustomer - 9, BookingReminder - 10, BookingWaiver - 11, BookingConfirmation - 12, BookingApproval - 13, Receipt - 14
Request Information
Allows multi-location processing, in case of using parent location token restrictByLocations parameter is strongly recommended with comma separated list of locations to select from or update in
URI Parameters
None.
Body Parameters
SmsLogsFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| PageIndex | integer |
None. |
|
| Status | ReportSmsStatus |
None. |
|
| StartDt | date |
None. |
|
| EndDt | date |
None. |
|
| CellPhone | string |
None. |
|
| SmsType | CustomerSmsType |
None. |
Request Formats
application/json, text/json
Sample:
{
"PageIndex": 1,
"Status": 0,
"StartDt": "2025-04-03T04:14:23.4749097-04:00",
"EndDt": "2025-04-03T04:14:23.4749097-04:00",
"CellPhone": "sample string 4",
"SmsType": 0
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |