{"id":3613,"date":"2023-08-29T20:58:15","date_gmt":"2023-08-29T19:58:15","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3613"},"modified":"2025-10-03T12:41:39","modified_gmt":"2025-10-03T11:41:39","slug":"get-messages-list","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/sms-mms-messages\/get-messages-list\/","title":{"rendered":"Get messages list"},"content":{"rendered":"\n

SMS or MMS messages collection contains a list of all sent messages. Multiple messages matching specified criteria can be retrieved. Specifying single message ID can be used to retrieve detailed information about a specific message.<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Get multiple messages<\/strong><\/p>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
tag<\/td>string<\/td>Tag. Optional. If specified, only messages tagged with its value will be returned.<\/td><\/tr>
startDate<\/td>date<\/td>Start date. Optional. If specified, messages sent before this date will not be returned. May be used together with endDate to specify a period of time. YYYY-MM-DD format.<\/td><\/tr>
endDate<\/td>date<\/td>See startDate.<\/td><\/tr>
type<\/td>string<\/td>Only return specific message types. Optional. Valid values:
Newsletter
WorkflowMessage<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessages?apiKey=YOUR_API_KEY_HERE<\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessages?apiKey=YOUR_API_KEY_HERE&tag=sports<\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessages?apiKey=YOUR_API_KEY_HERE&tag=sports&startDate=2016-05-20&endDate=2016-05-22<\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessages?apiKey=YOUR_API_KEY_HERE&tag=sports&startDate=2016-05-20&endDate=2016-05-22&type=WorkflowMessage<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Get message by Message ID<\/strong><\/p>\n\n\n\n
Request URL parameters:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
ID<\/td>int<\/td>SMS\/MMS message ID. Required as a part of address (not GET parameter). See example below.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessages\/123?apiKey=YOUR_API_KEY_HERE<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Re<\/strong>sponse<\/strong><\/h3>\n\n\n\n
Get multiple messages<\/strong><\/p>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Messages<\/td>array[complex]<\/td>Array of Message elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Message element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>int<\/td>Message identifier.<\/td><\/tr>
Sender<\/td>string<\/td>Option selected in “Sender” field in SMS\/MMS message wizard<\/td><\/tr>
CampaignDescription<\/td>string<\/td>Value from “Campaign description” field in SMS\/MMS message wizard<\/td><\/tr>
Subject<\/td>string<\/td>Message subject. Only for MMS<\/td><\/tr>
Type<\/td>string<\/td>Message type (Newsletter, WorkflowMessage etc).<\/td><\/tr>
SentDate<\/td>datetime<\/td>Optional. Date when the message was sent. For messages that are sent many times (e.g. Autoresponders) it is the first date matching specified date range.<\/td><\/tr>
Tags<\/td>string<\/td>Optional. List of comma-separated message tags.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Get message by Message ID<\/strong><\/p>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>int<\/td>Message identifier. Subject string Message subject.<\/td><\/tr>
Sender<\/td>string<\/td>Option selected in “Sender” field in SMS\/MMS message wizard<\/td><\/tr>
CampaignDescription<\/td>string<\/td>Value from “Campaign description” field in SMS\/MMS message wizard <\/td><\/tr>
Subject<\/td>string<\/td>Message subject. Only for MMS.<\/td><\/tr>
Type<\/td>string<\/td>Message type (Newsletter, WorkflowMessage etc).<\/td><\/tr>
SentDate<\/td>datetime<\/td>Optional. Date when the message was sent. For messages that are sent many times (e.g. Autoresponders) it is the first date matching specified date range.<\/td><\/tr>
Tags<\/td>string<\/td>Optional. List of comma-separated message tags.<\/td><\/tr>
ThrottlingMethod<\/td>string<\/td>Optional. Throttling method.<\/td><\/tr>
Throttling<\/td>int<\/td>Optional. Throttling period (hrs.). Filled only if ThrottlingMethod is “Manual”.<\/td><\/tr>
GoogleAnalyticsTags<\/td>array[complex]<\/td>Optional. Array of GoogleAnalyticsTag elements (if message uses Google Analytics).<\/td><\/tr>
CustomUtms<\/td>array[complex]<\/td>Array of CustomUtm elements used to add custom information to URLs in the newsletter. Optional.<\/td><\/tr>
Lists<\/td>array[complex]<\/td>Optional. Array of List elements (target subscriber lists).<\/td><\/tr>
Segments<\/td>array[complex]<\/td>Optional. Array of Segment elements (target subscriber segments).<\/td><\/tr>
ExcludedLists<\/td>array[complex]<\/td>Optional. Array of excluded List elements (target subscriber lists).<\/td><\/tr>
ExcludedSegments<\/td>array[complex]<\/td>Optional. Array of excluded Segment elements (target subscriber segments).<\/td><\/tr>
Status<\/td>string<\/td>Optional. Available only for newsletters.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
GoogleAnalyticsTag element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Name<\/td>string<\/td>Tag name, e.g. “utm_source”.<\/td><\/tr>
Value<\/td>string<\/td>Tag value.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
CustomUtms element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Name<\/td>string<\/td>The name of the custom UTM parameter. Maximum length: 255 characters. The name cannot be empty and must be unique.
Do not reuse names already reserved by Google Analytics (e.g., utm_source, utm_medium, utm_campaign, utm_term, utm_content).<\/td><\/tr>
Value<\/td>string<\/td>The value assigned to the UTM parameter. Maximum length: 255 characters. The value cannot be empty.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
List element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>int<\/td>List identifier.<\/td><\/tr>
Name<\/td>string<\/td>List name.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Segment element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>int<\/td>Segment identifier.<\/td><\/tr>
Name<\/td>string<\/td>Segment name.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
ExcludedLists element children:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Id<\/td>int<\/td>List identifier.<\/td><\/tr>
Name<\/td>string<\/td>List name.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
ExcludedSegments element children:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Id<\/td>int<\/td>Segment identifier.<\/td><\/tr>
Name<\/td>string<\/td>Segment name.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
List of all possible ThrottlingMethod values:<\/p>\n\n\n\n
ThrottlingMethod values<\/th>Notes<\/th><\/tr><\/thead>
None<\/td>Message is not throttled<\/td><\/tr>
Auto<\/td>Automatic throtling speed is applied.<\/td><\/tr>
Manual<\/td>Throttling time was specified manually (see “Throttling” element)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
List of all possible Status values:<\/p>\n\n\n\n
Status value<\/th><\/tr><\/thead>
Scheduled<\/td><\/tr>
InProgress<\/td><\/tr>
Sent<\/td><\/tr>
Paused<\/td><\/tr>
Draft<\/td><\/tr>
Deleted<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples<\/strong><\/h3>\n\n\n\n
Get multiple messages<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET <\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessages?startDate=2016-05-19&apiKey=test_api_key1 HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nContent-Encoding: gzip <\/span><\/span>\nVary: Accept-Encoding <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=cu23cqm125fq1qih1kg4ux45; path=\/; HttpOnly <\/span><\/span>\nX-AspNetMvc-Version: 1.0 <\/span><\/span>\nX-AspNet-Version: 2.0.50727 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Mon, 24 May 2010 12:56:22 GMT <\/span><\/span>\nContent-Length: 415  <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Messages<\/span>><\/span><\/span>\n       <\/span><<\/span>Message<\/span>><\/span><\/span>\n         <\/span><<\/span>Id<\/span>><\/span>892<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n         <\/span><<\/span>Type<\/span>><\/span>Newsletter<\/span><\/<\/span>Type<\/span>><\/span><\/span>\n         <\/span><<\/span>SentDate<\/span>><\/span>2016-05-19T19:35:08<\/span><\/<\/span>SentDate<\/span>><\/span><\/span>\n         <\/span><<\/span>Sender<\/span>><\/span>John Smith<\/span><\/<\/span>Sender<\/span>><\/span><\/span>\n         <\/span><<\/span>CampaignDescription<\/span>><\/span>test newsletter<\/span><\/<\/span>CampaignDescription<\/span>><\/span><\/span>\n       <\/span><\/<\/span>Message<\/span>><\/span><\/span>\n       <\/span><<\/span>Message<\/span>><\/span><\/span>\n         <\/span><<\/span>Id<\/span>><\/span>893<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n         <\/span><<\/span>Type<\/span>><\/span>Newsletter<\/span><\/<\/span>Type<\/span>><\/span><\/span>\n         <\/span><<\/span>SentDate<\/span>><\/span>2016-05-21T14:09:15<\/span><\/<\/span>SentDate<\/span>><\/span><\/span>\n         <\/span><<\/span>Tags<\/span>><\/span>test 1<\/span><\/<\/span>Tags<\/span>><\/span><\/span>\n         <\/span><<\/span>Sender<\/span>><\/span>SmsApiTest<\/span><\/<\/span>Sender<\/span>><\/span><\/span>\n         <\/span><<\/span>CampaignDescription<\/span>><\/span>test newsletter 2<\/span><\/<\/span>CampaignDescription<\/span>><\/span><\/span>\n       <\/span><\/<\/span>Message<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Messages<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Get message by Message ID<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET <\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessages\/893?apiKey=test_api_key1 HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n