Overview

This request will return a subset of all your SMSs. Use the page and count parameters to get the whole list.

The Method

API-Method
RESTGEThttps://[Your URL]/api/2.0/sms
XML-RPCCallsms.ListSms

Parameters

PropertyTypeDescriptionDefaultRequired
$pageintegerThe page number of the list.1no
$countintegerThe number of results to return per page.100no
$orderintegerThe name of the field to order the listing by.emptyno
$directionintegerThe direction of the ordering: ‘asc’ or ‘desc’.emptyno
$filtersintegerThe fields to filter on.emptyno

Example Request

GET /api/2.0/sms
 HTTP/1.1
Host: local.everlytic.com
Authorization: Basic YWRtaW5pc3RyYXRvcjp2bE1lTGk2UlVJR21SQzNvaWRMZXBsc2J5RU5NRkY3Yl85OTk=

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/"
        }
    ],
    "collection": [
        {
            "href": "https://local.everlytic.com/api/2.0/sms/5",
            "data": {
                "id": 5,
                "hash": "jcBCIn0EpEsvVHI2",
                "campaign_id": 0,
                "recreated_from_message_id": 0,
                "type": "sms",
                "compose_with": "",
                "campaign_name": "",
                "subject": "subject",
                "from_email": "[email protected]",
                "from_name": "",
                "reply_email": "",
                "preheader_text": null,
                "html_original": "",
                "text_original": "This is a test message",
                "is_html_fetch_from_url": "no",
                "html_fetch_url": "",
                "html_fetch_when": "now",
                "is_text_fetch_from_url": "no",
                "text_fetch_url": "",
                "text_fetch_when": "now",
                "is_copy_text_auto": "yes",
                "remove_duplicates": "no",
                "attachments": "",
                "has_dynamic_attachments": "no",
                "thumbnail": "",
                "list_ids": "1",
                "filter_id": 0,
                "import_id": 0,
                "message_workflow_id": 0,
                "template_id": 0,
                "create_date": 1589805530,
                "is_scheduled": "no",
                "send_scheduled_date": 0,
                "scheduled_recurrence": "once",
                "scheduled_previous_message_id": 0,
                "preparation_date": 0,
                "preparation_count": 0,
                "send_date": 0,
                "approval_required": "no",
                "approval_request_date": 0,
                "approval_name": "",
                "approval_email": "",
                "approved_date": 0,
                "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",
                "analytics_custom_tag": "",
                "analytics_tag": "",
                "analytics_medium_tag": "email",
                "total_sent": 0,
                "total_actual_sent": 0,
                "total_failed": 0,
                "total_actual_failed": 0,
                "total_to_be_queued": 0,
                "total_queued": 0,
                "total_in_queue": 0,
                "total_link_clicks": 0,
                "total_link_clicks_unique": 0,
                "total_link_clicks_anonymous": 0,
                "total_reads": 0,
                "total_reads_inferred": 0,
                "total_reads_unique": 0,
                "total_reads_anonymous": 0,
                "message_total_reads_unique_desktop": 0,
                "message_total_reads_desktop": 0,
                "message_total_reads_unique_web": 0,
                "message_total_reads_web": 0,
                "message_total_reads_unique_mobile": 0,
                "message_total_reads_mobile": 0,
                "message_total_reads_unique_unknown": 0,
                "message_total_reads_unknown": 0,
                "total_unsubscribes": 0,
                "total_bounces": 0,
                "total_bounces_hard": 0,
                "total_bounces_soft": 0,
                "total_bounces_policy": 0,
                "total_bounces_blacklist": 0,
                "total_complaints": 0,
                "total_complaints_real": 0,
                "total_complaints_fbl": 0,
                "total_forwards": 0,
                "total_autoresponders": 0,
                "total_unique_ attachments": 0,
                "total_attachments": 0,
                "total_bounces_unidentified": 0,
                "send_share_report": "no",
                "share_report_recipients": "",
                "share_report_delay_days": 0,
                "share_report_allow_export": "no",
                "status": "composing",
                "priority": "medium",
                "character_set": "utf-8",
                "encoding": "8bit",
                "public_report_url": "https://local.everlytic.com/public/sms/reports/5/KxAfVBsrjPDfLaEl",
                "public_old_report_url": "https://local.everlytic.com/public/message-report/5/jcBCIn0EpEsvVHI2",
                "export_report_url": "https://local.everlytic.com/public/sms/reports/5/l0mvaq3kz6iJUoxt",
                "online_urls": {
                    "1": "https://local.everlytic.com/api/2.0/public/messages/view-online/0Zvvcn6rO5PjUIwm/jcBCIn0EpEsvVHI2"
                }
            }
        },
        {
            "href": "https://local.everlytic.com/api/2.0/sms/4",
            "data": {
                "id": 4,
                "hash": "UKamO3QVpQUvHQqn",
                "campaign_id": 0,
                "recreated_from_message_id": 0,
                "type": "sms",
                "compose_with": "classic",
                "campaign_name": "afdsgadfbafb",
                "subject": "tyest",
                "from_email": "[email protected]",
                "from_name": "",
                "reply_email": "",
                "preheader_text": null,
                "html_original": "",
                "text_original": "",
                "is_html_fetch_from_url": "no",
                "html_fetch_url": "",
                "html_fetch_when": "now",
                "is_text_fetch_from_url": "no",
                "text_fetch_url": "",
                "text_fetch_when": "now",
                "is_copy_text_auto": "yes",
                "remove_duplicates": "no",
                "attachments": "",
                "has_dynamic_attachments": "no",
                "thumbnail": "",
                "list_ids": "",
                "filter_id": 0,
                "import_id": 0,
                "message_workflow_id": 0,
                "template_id": 0,
                "create_date": 1557914159,
                "is_scheduled": "no",
                "send_scheduled_date": 0,
                "scheduled_recurrence": "once",
                "scheduled_previous_message_id": 0,
                "preparation_date": 0,
                "preparation_count": 0,
                "send_date": 0,
                "approval_required": "no",
                "approval_request_date": 0,
                "approval_name": "",
                "approval_email": "",
                "approved_date": 0,
                "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",
                "analytics_custom_tag": "",
                "analytics_tag": "",
                "analytics_medium_tag": "email",
                "total_sent": 0,
                "total_actual_sent": 0,
                "total_failed": 0,
                "total_actual_failed": 0,
                "total_to_be_queued": 0,
                "total_queued": 0,
                "total_in_queue": 0,
                "total_link_clicks": 0,
                "total_link_clicks_unique": 0,
                "total_link_clicks_anonymous": 0,
                "total_reads": 0,
                "total_reads_inferred": 0,
                "total_reads_unique": 0,
                "total_reads_anonymous": 0,
                "message_total_reads_unique_desktop": 0,
                "message_total_reads_desktop": 0,
                "message_total_reads_unique_web": 0,
                "message_total_reads_web": 0,
                "message_total_reads_unique_mobile": 0,
                "message_total_reads_mobile": 0,
                "message_total_reads_unique_unknown": 0,
                "message_total_reads_unknown": 0,
                "total_unsubscribes": 0,
                "total_bounces": 0,
                "total_bounces_hard": 0,
                "total_bounces_soft": 0,
                "total_bounces_policy": 0,
                "total_bounces_blacklist": 0,
                "total_complaints": 0,
                "total_complaints_real": 0,
                "total_complaints_fbl": 0,
                "total_forwards": 0,
                "total_autoresponders": 0,
                "total_unique_ attachments": 0,
                "total_attachments": 0,
                "total_bounces_unidentified": 0,
                "send_share_report": "no",
                "share_report_recipients": "",
                "share_report_delay_days": 0,
                "share_report_allow_export": "no",
                "status": "sent",
                "priority": "medium",
                "character_set": "utf-8",
                "encoding": "8bit",
                "public_report_url": "https://local.everlytic.com/public/sms/reports/4/Md984VVIDbACyT3l",
                "public_old_report_url": "https://local.everlytic.com/public/message-report/4/UKamO3QVpQUvHQqn",
                "export_report_url": "https://local.everlytic.com/public/sms/reports/4/fKUOQq08u2Tqve3l",
                "online_urls": []
            }
        }
    ]
}