Everyware DocsAPI Base URL
All documentation

Fetch SMS Message

Access Endpoint URL: https://rest.everyware.com/api/Default/FetchSMSMessages [POST]

Summary

You can use the FetchSMSMessages method to return an array holding information about all the SMS messages that fulfill the requirements set via the request body's parameters.

Inbound Parameters

Parameters should be passed in a single JSON-body object.

Parameter Name Description Optional/Required
MessageID The ID associated with the SMS within the Everyware system. Optional
FirstName The first name of the customer/contact to which the message was sent. Optional
LastName The last name of the customer/contact to which the message was sent. Optional
MobilePhone The phone number (10-digits max, no formatting) to which the message was sent. Optional
IndividualID The ID associated with the contact/customer within the Everyware system. Optional
MessageExternalID The ID associated with the message in an external system. Optional
StartDate Establishes the earliest date in the range you would like to pull SMS messages from. Optional
EndDate Establishes the latest date in the range you would like to pull SMS messages from. Optional
DateSent Returns the date and time at which the message was sent. Optional
MessageText The content of the message that was sent out to the customer/contact. Optional
DirectionID The direction of the message. 
    1 - Inbound\
    2- Outbound
  </td><td>
    Optional
  </td></tr></tbody></table>

Sample Code

{
    "MessageID": "123456",
    "FirstName": "John",
    "LastName": "Smith",
    "MobilePhone": "3055551212",
    "IndividualID": "87654321",
    "MessageExternalID": "",
    "StartDate": "",
    "EndDate": "",
    "DateSent": "",
    "MessageText": "",
    "DirectionID": "1"
}

curl --location 'https://rest.everyware.com/api/Default/FetchSMSMessages' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "MessageID": "123456",
    "FirstName": "John",
    "LastName": "Smith",
    "MobilePhone": "3055551212",
    "IndividualID": "87654321",
    "MessageExternalID": "",
    "StartDate": "",
    "EndDate": "",
    "DateSent": "",
    "MessageText": "",
    "DirectionID": "1"
}'

{
	"OrderNumber": null,
  "SMSID": null,
	"IsSuccess": true,
	"Message": "Check data field for returned messages.",
  "Data": "[{
  	\"MessageID\":\"123456\",
    \"FirstName\":\"John\",
    \"LastName\":\"Smith\",
    \"MobilePhone\":\"3055551212\",
    \"IndividualID\":\"87654321\",
    \"MessageExternalID\":\"\",
    \"StartDate\":null,
    \"EndDate\":null,
    \"Status\":\"\",
    \"DateSent\":\"3/15/2024 4:07:34 PM\",
    \"MessageText\":\"Hello there John\",
    \"DirectionID\":\"2\",
    \"APIKey\":null,
    \"Username\":null,
    \"SalesSiteID\":null,
    \"DeviceID\":null,
    \"FingerprintSessionID\":null
  }]"
}