CreateSMSMessage

You can send an SMS message to your customer or contact's mobile phone using this method.

This also creates a new contact in the system, much like CreateCustomer. If the name and mobile phone do not match anyone in your Contact list, it will be added against your business.

Access URL: https://rest.everyware.com/api/Default/CreateSMSMessage

Inbound Parameters

Parameter Name

Description

Required/Not

FirstName

Contact (customer/message recipient’s) first name

REQUIRED

LastName

Contact (customer/message recipient’s)last name

REQUIRED

MobilePhone

Contact (customer/message recipient’s) Valid mobile phone

REQUIRED

MessageText

The body of the outbound SMS message to the contact.

REQUIRED

ExternalID

Unique identifier Everyware can store optionally.

Optional

{
  "FirstName": "FirstName",
  "LastName": "LastName",
  "MobilePhone": "000-000-0000",
  "MessageText": "Message",
  "MessageExternalID": "1",
  "ExternalID": "123456"
}
{
    "IsSuccess": true,
    "Message": "Your message was successfully sent.",
    "Data": "4962577",
    "OrderNumber": null
}

📘

RE: System

When a message is sent through the API, the sender will appear as "System" in the Messages page in the Everyware portal.

Preview Image

In the Everyware portal creating a new message and sending to a contact would look like this:

12981298

Sample CreateSMSMessage Code

{
  "FirstName": "John",
  "LastName": "Doe",
  "MobilePhone": "5551112222",
  "MessageText": "Hello this is a test.",
  "ExternalID": "12345"
}

Did this page help you?