Get Messages
Access Endpoint URL: https://rest.everyware.com/api/Default/GetMessages [POST]
Retrieve messages that have been sent to and received by a business through Everyware using this endpoint
Inbound Parameters
Parameter | Definition | REQUIRED / NOT |
---|---|---|
NewOnly | 1 if you want only unread messages 0 if you want all messages, read or unread | REQUIRED |
DateFrom | Beginning date of timeframe within which you want to pull in messages. Formatted as MM-DD-YYYY | REQUIRED |
DateTo | End date of timeframe within which you want to pull in messages. Formatted as MM-DD-YYYY | REQUIRED |
Sample Code
Inputs and response code sample below.
{
"NewOnly": "0",
"DateFrom": "01-01-2023",
"DateTo": "01-02-2023"
}
curl --location 'https://rest.everyware.com/api/Default/GetMessages' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
"NewOnly": "0",
"DateFrom": "01-01-2023",
"DateTo": "01-02-2023"
}'
{
"OrderNumber": null,
"SMSID": null,
"IsSuccess": true,
"Message": "Check data field for returned messages.",
"Data": "[{\"MessageID\":\"226733352\",\"IndividualID\":\"17433131\",\"DateAdded\":\"7/28/2023 2:42:56 PM\",\"MessageText\":\"This is a test message.\",\"DirectionName\":\"Out\",\"AddedByUserID\":\"16257\",\"AddedByIndividualID\":\"133099\",\"CustomerName\":\"Test Employee\",\"EmployeeID\":\"165437\",\"ExternalID\":null,\"EmployeeName\":\"System \",\"EmployeeAvatar\":\"\",\"MediaURL\":\"\",\"AllowPushNotifications\":\"\",\"PushNotificationToken\":\"\",\"DeviceTypeID\":\"\",\"EmployeePhoneNumber\":\"9709999991\",\"AssignedPhoneNumber\":\"9708888888\",\"RoutePhoneNumber\":\"9709999999\",\"ExternalPhoneNumber\":\"9709999991\",\"Error\":\"\",\"ErrorStack\":\"\",\"Response\":\"Success\",\"ResponseMessage\":\"\"},{\"MessageID\":\"22467595\",\"IndividualID\":\"19324327\",\"DateAdded\":\"7/28/2023 2:23:39 PM\",\"MessageText\":\"Hi happy Friday!\",\"DirectionName\":\"In\",\"AddedByUserID\":\"0\",\"AddedByIndividualID\":\"0\",\"CustomerName\":\"Test CUstomer\",\"EmployeeID\":\"\",\"ExternalID\":null,\"EmployeeName\":\"\",\"EmployeeAvatar\":\"\",\"MediaURL\":\"\",\"AllowPushNotifications\":\"\",\"PushNotificationToken\":\"\",\"DeviceTypeID\":\"\",\"EmployeePhoneNumber\":\"9709999991\",\"AssignedPhoneNumber\":\"9708888888\",\"RoutePhoneNumber\":\"9709999991\",\"ExternalPhoneNumber\":\"9709999991\",\"Error\":\"\",\"ErrorStack\":\"\",\"Response\":\"Success\",\"ResponseMessage\":\"\"}
}
Updated about 2 months ago