Creating Automatic SMS Reminders
Endpoint Access URL: https://rest.everyware.com/api/Default/CreateSMSReminderMessage[POST]
After you send an SMS invoice, use CreateSMSReminderMessage to control the automatic reminder messages that follow.
Inbound Parameters
Parameter Name | Description | Required/Not |
---|---|---|
MobilePhone | Mobile phone number of customer, provided in 10 digit format: 3055551212. Must be a valid mobile number or the message will be not be sent. Everyware checks for mobile number validation. | REQUIRED |
MessageText | The body of the outbound SMS message to the contact. To include the pay by text link in the reminder, find it in the original CreateInvoice call response for this customer. | REQUIRED |
OrderNumber | This is the number associated with the invoice that appears on the top of the customer facing invoice as "Invoice #" and throughout the Everyware portal. | 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
}
Updated 5 months ago