Everyware DocsAPI Base URL
All documentation

Creating Messages from Templates

Access Endpoint URL: https://rest.everyware.com/api/default/createtemplatemessage [POST]

You can use the CreateTemplateMessage method to send an SMS or MMS message to your contact/customer's mobile phone, with content generated from a template previously created in Everyware's Portal.

šŸ“˜ Creating and Using Templates

Templates must be created within the Everyware Portal UI (Left Navigation Bar: Messaging...SMS Templates) Acquire the unique template ID from the Template ID column in the 'Manage SMS Templates' table and use it for the API's SmsTemplateId input parameter.

šŸ“˜ Creating a Customer

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 to your location's default contact list.

Inbound Parameters

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

Parameter Name Description Optional/Required
FirstName Contact/Customer's first name. 
    * If the individual does not exist within the Everyware database, first and last name must be provided.
  </td><td>
    * Required
  </td></tr><tr><td>
    LastName
  </td><td>
    Contact/Customer's last name.  

    * If the individual does not exist within the Everyware database, first and last name must be provided.
  </td><td>
    * Required
  </td></tr><tr><td>
    MobilePhone
  </td><td>
    Contact/Customer's valid mobile phone number.
  </td><td>
    Required
  </td></tr><tr><td>
    SmsTemplateId
  </td><td>
    The unique identifier for the desired SMS Template.
  </td><td>
    Required
  </td></tr><tr><td>
    MessageExternalID
  </td><td>
    A unique identifier from an external system associated with the message.
  </td><td>
    Optional
  </td></tr><tr><td>
    ExternalID
  </td><td>
    A unique identifier from an external system associated with the individual.
  </td><td>
    Optional
  </td></tr><tr><td>
    Attachments
  </td><td>
    A string array for optional MMS attachments.
  </td><td>
    Required for MMS (see below)
  </td></tr><tr><td>
    Attachments - fileName
  </td><td>
    The original name of the binary file, with expected extension. This is how the MMS attachment will be sent to the recipient.
  </td><td>
    Required for MMS (see below)
  </td></tr><tr><td>
    Attachments - Base64String
  </td><td>
    The Base64 encoded payload which represents the original file to be sent.
  </td><td>
    Required for MMS (see below)
  </td></tr><tr><td>
    fileURL
  </td><td>
    The URL file that belongs to the attachment for a MMS.
  </td><td>
    Required for MMS (see below)
  </td></tr></tbody></table>

{
  "FirstName": "John",
  "LastName": "Doe",
  "MobilePhone": "5555551212",
  "SMSTemplateID": "405486",
  "MessageExternalId": "",
  "ExternalID": "12345"
}

curl --location 'https://rest.everyware.com/api/Default/CreateMessage' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
 "FirstName": "John",
  "LastName": "Doe",
  "MobilePhone": "5555551212",
  "SMSTemplateID": "405486",
  "MessageExternalId": "",
  "ExternalID": ""
}'

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

šŸš§ Attachments Optional

If you are sending a simple SMS without attachments, you can either leave out the Attachments array, or include it with a null value

CreateMessage - MMS Sent With Base64 Encoding

{
    "MobilePhone": "5551112222",
    "SMSTemplateID": "405486",
    "Attachments": [
      {
        "fileName": "testImage1.png",
        "Base64Stringā€: "[INSERT BASE64 ENCODED STRING]" 
      }
    ]
}

curl --location 'https://rest.everyware.com/api/Default/CreateMessage' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
 "FirstName": "John",
  "LastName": "Doe",
  "MobilePhone": "5555551212",
    "SMSTemplateID": "405486",
    "Attachments": [
    {
      "fileName": "testImage1.png",
      "Base64Stringā€: "[INSERT BASE64 ENCODED STRING]" 
    }
    ],
  "ExternalID": ""
}'

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

šŸ“˜ Base64 Encoding

In order to send the binary file over the API, it must first be Base64 encoded for transmission.

CreateMessage - MMS Sent With External Linked File

{
    "MobilePhone": "5551112222",
    "SMSTemplateID": "405486",
    "Attachments": [
      {
        "fileName": "testImage1.png",
        "Base64Stringā€: "[INSERT BASE64 ENCODED STRING]" 
      }
    ]
}

curl --location 'https://rest.everyware.com/api/Default/CreateMessage' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
 "FirstName": "John",
  "LastName": "Doe",
  "MobilePhone": "5555551212",
  "SMSTemplateID": "405486",
    "Attachments": [
    {
      "fileName": "testImage1.png",
      "Base64Stringā€: "[INSERT BASE64 ENCODED STRING]" 
    }
    ],
  "ExternalID": ""
}'

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

šŸš§ Prepare Your File Location

Make sure that the URL location mentioned in fileURL meets the following criteria:

  • Conforms to TLS1.2 standards
  • Is protected by HTTPS
  • Is open to the internet, not behind a firewall or anything that would prevent Everyware from retrieving the file.

CreateMessage - Sending Multiple MMS Attachments

{
    "MobilePhone": "5551112222",
    "SMSTemplateID": "405486",
    "Attachments": [
    {
      "fileName": "testImage1.png",
      "Base64Stringā€: "[INSERT BASE64 ENCODED STRING]" 
    },
{
      "fileName": "testImage2.png",
      "Base64Stringā€: "[INSERT BASE64 ENCODED STRING]" 
    }
  ]
}

curl --location 'https://rest.everyware.com/api/Default/CreateMessage' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
 "FirstName": "John",
  "LastName": "Doe",
  "MobilePhone": "5555551212",
  "SMSTemplateID": "405486",
    "Attachments": [
    {
      "fileName": "testImage1.png",
      "Base64Stringā€: "[INSERT BASE64 ENCODED STRING]" 
    },
    {
      "fileName": "testImage2.png",
      "Base64Stringā€: "[INSERT BASE64 ENCODED STRING]" 
    }
  "ExternalID": ""
}'

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

šŸ“˜ Mixing Attachment sources

It is completely fine to mix how you send binary files in the Attachments array. You can send one Base64 encoded, and one via fileURL pickup, or any combination.

šŸ“˜ RE: System

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