Create a New SMS Message | Knowledge Base

Overview

SMS campaigns are used to send SMS messages to a list of contacts. Creating and sending the campaign are two different actions.

Creating the campaign puts it in the ‘composing’ state, giving you the opportunity to add and remove lists, and tweak the campaign parameters.

Once you’re done tweaking, you can trigger the sending of the campaign by creating a Send SMS Action for the specific SMS.

The Method

API	-	Method
REST	POST	https://[Your URL]/api/2.0/sms
XML-RPC	Call	sms.CreateSms

Parameters

Property	Type	Description	Default	Required	Read Only
campaign_name	string	Campaign	empty	no	no
subject	string	Subject	empty	yes	no
from_email	string	From Email	empty	yes	no
from_name	string	From Name	empty	no	no
reply_email	string	Reply Email	empty	no	no
html_original	string	Original HTML	empty	no	no
text_original	string	Original Text	empty	no	no
is_html_fetch_from_url	string	Fetch HTML from URL Possible values: yes no	no	no	no
html_fetch_url	string	Fetch HTML URL	empty	no	no
html_fetch_when	string	Fetch HTML when Possible values: now confirm send	now	no	no
is_text_fetch_from_url	string	Fetch text from URL Possible values: yes no	no	no	no
text_fetch_url	string	Fetch text URL	empty	no	no
text_fetch_when	string	Fetch text when Possible values: now confirm send	now	no	no
is_copy_text_auto	string	Copy text from HTML Possible values: yes no	yes	no	no
attachments	string	Attachments	empty	no	no
list_ids	string	List identifiers	empty	no	no
filter_id	integer	Filter identifier	empty	no	no
template_id	integer	Template identifier	empty	no	no
is_scheduled	string	Scheduled Possible values: yes no	no	no	no
send_scheduled_date	integer	Schedule date	0	no	no
scheduled_recurrence	string	Schedule recurrance Possible values: once weekdays daily weekly monthly yearly	once	no	no
scheduled_previous_message_id	integer	Previous scheduled message identifier	0	no	no
approval_required	string	Approval required Possible values: yes no	no	no	no
approval_name	string	Name	empty	no	no
approval_email	string	Email	empty	no	no
inline_css	string	Convert CSS to inline styles Possible values: yes no	yes	no	no
embeded_images	string	Embed images Possible Values: yes no	no	no	no
track_links	string	Track link clicks Possible values: yes no	yes	no	no
track_reads	string	Track opens Possible values: yes no	yes	no	no
unsubscribe_type	string	Unsubscribe footer type Possible Values: none standard extra	none	no	no
insert_unsubscribe_link	string	Insert unsubscribe footer Possible values: yes no	no	no	no
include_analytics	string	Google analytics Possible values: yes no	no	no	no
priority	string	Priority Possible values: low medium high	medium	no	no
character_set	string	Character set	UTF-8	no	no
encoding	string	Encoding Possible values: 7bit 8bit binary quoted-printable base64	8bit	no	no
import_id	integer	The ID of a contacts import (Requires the list_ids property to be set)	empty	no	no

Example Request

POST /api/2.0/sms
 HTTP/1.1
Host: local.everlytic.com
Authorization: Basic YWRtaW5pc3RyYXRvcjp2bE1lTGk2UlVJR21SQzNvaWRMZXBsc2J5RU5NRkY3Yl85OTk=
Content-Type: application/json

{
  "subject":"subject",
  "text_original":"This is a test message",
  "list_ids":"1"
}

Example Response

{
    "links": [
        {
            "title": "Self",
            "rel": "self",
            "href": "https://local.everlytic.com/api/2.0/sms"
        },
        {
            "title": "Home",
            "rel": "home",
            "href": "https://local.everlytic.com/api/2.0/"
        }
    ],
    "item": {
        "id": 5,
        "hash": "jcBCIn0EpEsvVHI2",
        "type": "sms",
        "subject": "subject",
        "from_email": "[email protected]",
        "text_original": "This is a test message",
        "is_html_fetch_from_url": "no",
        "html_fetch_when": "now",
        "is_text_fetch_from_url": "no",
        "text_fetch_when": "now",
        "is_copy_text_auto": "yes",
        "remove_duplicates": "no",
        "list_ids": "1",
        "create_date": 1589805530,
        "is_scheduled": "no",
        "scheduled_recurrence": "once",
        "preparation_date": 0,
        "preparation_count": 0,
        "approval_required": "no",
        "inline_css": "no",
        "embed_images": "no",
        "track_links": "no",
        "track_reads": "yes",
        "track_attachments": "yes",
        "unsubscribe_type": "standard",
        "insert_unsubscribe_link": "yes",
        "include_analytics": "no",
        "include_custom_analytics": "no",
        "total_queued": 0,
        "total_in_queue": 0,
        "send_share_report": "no",
        "share_report_allow_export": "no",
        "status": "composing",
        "priority": "medium",
        "character_set": "utf-8",
        "encoding": "8bit"
    }
}