Embedded Files
API Documentation V2
SmsMmsNewsletters collection allows creating and sending SMS/MMS newsletter messages.
Request data format
Request data format
Data part of request for creating a new newsletter.
Data element children:
Recipients element children:
* Newsletter has to have at least one subscriber list, subscriber segment or seed list specified. Empty recipients element will trigger appropriate error message.
Content element children:
GoogleAnalyticsTags element children:
Note: The remaining tag, "utm_medium" is by default specified as "SMS".
DeliverySettings element children:
Delivery throttling methods:
* Note: The minimum throttling is 60 messages per minute. Longer throttling will be automatically adjusted.
Response
Response
Method returns ID of created newsletter. ID can be used to pause or resume newsletters with status "InProgress" (see Pause or resume newsletter (SMS)).
Response Data element:
Example
Example
Sending a simple newsletter
Request:
POST https://api.esv2.com/v2/Api/SmsMmsNewsletters HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
Content-Length: 471
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<ApiKey>2OAEcpz0Rwv3Mhc9nTQK</ApiKey>
<Data>
<Recipients>
<SubscriberLists>
<SubscriberList>77</SubscriberList>
</SubscriberLists>
</Recipients>
<Content>
<Sender>SmsGateway</Sender>
<CampaignDescription>Hello!</CampaignDescription>
<Plain>Hello friend, how are you?</Plain>
</Content>
</Data>
</ApiRequest>
Response:
HTTP/1.1 201 Created
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 3.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 27 Mar 2012 13:28:01 GMT
Content-Length: 149
<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Data>1498</Data>
</ApiResponse>
Sending newsletter with full options
Request:
POST https://api.esv2.com/v2/Api/SmsMmsNewsletters HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
Content-Length: 1727
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<ApiKey>2OAEcpz0Rwv3Mhc9nTQK</ApiKey>
<Data>
<Recipients>
<SubscriberLists>
<SubscriberList>77</SubscriberList>
</SubscriberLists>
<SubscriberSegments>
<SubscriberSegment>1</SubscriberSegment>
<SubscriberSegment>3</SubscriberSegment>
</SubscriberSegments>
<SeedLists>
<SeedList>1</SeedList>
</SeedLists>
<SuppressionLists>
<SuppressionList>1</SuppressionList>
</SuppressionLists>
</Recipients>
<Content>
<Sender>SmsGateway</Sender>
<CampaignDescription>Hello!</CampaignDescription>
<Plain>Hello friend, how are you?</Plain>
<GoogleAnalyticsTags>
<Campaign>testcampaign</Campaign>
<Source>testsource</Source>
<Content>testcontent</Content>
</GoogleAnalyticsTags>
<Tags>
<Tag>tag1</Tag>
<Tag>tag2</Tag>
</Tags>
<EnableClickTrack>false</EnableClickTrack>
</Content>
<DeliverySettings>
<DeliveryDate>2018-03-23T12:00:00</DeliveryDate>
<TimeZone>UTC</TimeZone>
<OverrideDeliveryCap>true</OverrideDeliveryCap>
<ThrottlingMethod>Manual</ThrottlingMethod>
<ManualThrottlingTime>10</ManualThrottlingTime>
</DeliverySettings>
</Data>
</ApiRequest>
Report abuse