Creating Automatic SMS Reminders

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

You can use the CreateSMSReminderMessage method to configure the automatic reminder messages that follow the original SMS invoice.

Inbound Parameters

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

Parameter Name	Description	Optional/Required
MobilePhone	The mobile phone number of the contact/customer (10-digits max, not formatted). Must be valid or the message will not be sent. Everyware checks for mobile number validation. Example: 3055551212	Required
MessageText	The body of the SMS message sent to the contact/customer. If you want to include the "Pay By Text" link in the reminder, you can find it in the original response to the CreateInvoice call for this customer.	Required
OrderNumber	The number associated with the invoice. It appears both on the top of the customer-facing invoice and throughout Portal as the "Invoice #".	Required

Parameter Name

Description

Optional/Required

MobilePhone

The mobile phone number of the contact/customer (10-digits max, not formatted).

Must be valid or the message will not be sent. Everyware checks for mobile number validation.

Example: 3055551212

Required

MessageText

The body of the SMS message sent to the contact/customer.

If you want to include the "Pay By Text" link in the reminder, you can find it in the original response to the CreateInvoice call for this customer.

Required

OrderNumber

The number associated with the invoice. It appears both on the top of the customer-facing invoice and throughout Portal as the "Invoice #".

Required

Code Sample

{
  "MobilePhone": "5125555555",
  "MessageText": "Hi this is a reminder your payment is due. [PBTLINK]",
  "OrderNumber": "5555"
}

curl --location 'https://rest.everyware.com/api/Default/CreateSMSReminderMessage' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
  "MobilePhone": "5555555555",
  "MessageText": "Hi this is a reminder your payment is due. [PBTLINK]",
  "OrderNumber": "5555"
}'

{
    "IsSuccess": true,
    "Message": "Hi this is a reminder your payment is due. https://ebtly.com/0029E619",
    "Data": "4620347",
    "OrderNumber": null
}