POST 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/createmessage

Inbound Parameters

Example of basic text message service:

{
  "FirstName": "FirstName",
  "LastName": "LastName",
  "MobilePhone": "5555551212",
  "MessageText": "Message",
  "ExternalID": "123456"
}

{
    "IsSuccess": true,
    "Message": "Your message was successfully sent.",
    "Data": "4962577",
    "OrderNumber": null
}

CreateMessage MMS Link - Client would host media file on server. Everyware would pull that file, store on our Amazon S3 Server, and send out the MMS image via Twilio.

{
    "MobilePhone": "5551112222",
    "MessageText": "Testing MMS attachment.”
    "Attachments": [
    {
      "fileName": "testImage1.png",
      "Base64String”: "[INSERT STRING]" 
    }
  ]
}

{
    "MobilePhone": "5551112222",
    "MessageText": "Testing 2 MMS attachments.”
    "Attachments": [
    {
      "fileName": "testImage1.png",
      "Base64String”: "[INSERT STRING]" 
    },
    {
      "fileName": "testImage2.png",
      "Base64String”: "[INSERT STRING]" 
    },

  ]
}

CreateMessage MMSBase64 - Client would send a base64 encoded image to Everyware. The image would be stored in Everyware's database and re-encoded to a binary image.

📘

RE: System

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