短信通道创建及发送Newsletter

Create and send newsletter 创建及发送Newsletter

Newsletter接口可以用来创建及发送Newsletter。内容可以与请求一并发送或是存储于外源（如，FTP服务器）

请求数据格式

创建Newsletter请求中的Data元素部分
Data子元素:
元素/属性 类型 描述
Recipients complex Newsletter目标收件人，必填.
Content complex 邮件内容，必填.
DeliverySettings complex 发送设置 (发送日期，通道等). 选填*. 如忽略, 会使用默认发送设置


Recipients子元素:

元素/属性 类型 描述
SubscriberLists array[integer] SubscriberLists元素组成的数组包含了Newsletter的目标收件人列表ID，选填.*
SubscriberSegments array[integer] SubscriberSegment元素组成的数组包含了Newsletter目标收件人细分ID，选填.*
SeedLists array[integer] SeedLists元素组成的数组包含了投递过程中所要发送的目标测试列表ID，选填.*
SuppressionLists array[integer] SuppressionLists元素组成的数组包含了投递过程中所要应用的禁止列表ID，选填.*

*Newsletter需至少选定一个收件人列表，收件人细分或测试列表。空的目标收件人集合会导致报错信息 

Content子元素:
元素/属性 类型 描述
Sender string SMS/MMS gateway创建于单元中的名称.必填.
CampaignDescription string 营销活动描述. 必填.
Plain string newsletter纯文本内容. 必填.
GoogleAnalyticsTags complex newsletter内容中链接添加的Google Analytics标签. 选填. 如省略, Google Analytics功能未启用.
Tags array[string] 用于辨识newsletter标签的清单. 选填.
EnableClickTrack boolean 如设置为 “false”, 不会进行点击追踪. 默认为 “true”. 选填.
GoogleAnalyticsTags子元素
元素/属性 类型 描述
Campaign string Google Analytics 标签 “utm_campaign”.选填.
Source string Google Analytics 标签 “utm_source”. 选填.
Content string Google Analytics 标签 “utm_content”. 选填.
注意：剩下的标签“utm_medium”被默认为“Email”.
DeliverySettings子元素:
元素/属性 类型 描述
DeliveryDate dateTime Newsletter发送日期. 选填. 若是默认，Newsletter会直接发送
TimeZone string 发送时间中所应用的时区.选填. 默认为标准（业务单元设置中）时区设置. 合理的取值.
OverrideDeliveryCap boolean 如设为 “true”, Newsletter会自动忽略邮件发送频率上限帽设置。选填. 默认为 “false”.
ThrottlingMethod string 邮件发送控制阀方式，见下方不同控制阀方式的介绍. 选填. 默认为 “None” (注意: 请务必改为Auto).
ManualThrottlingTime int 手动控制邮件发送数量控制阀的时间长度（小时为单位）。如果ThrottlingMethod 设定为“Manual”，就需要进行此项设置，其他情况则忽略.
邮件发送控制阀方式:
名称 操作
None(禁用)  不启用邮件发送控制阀.Newsletter会被以最快速度发送出. 这是默认方式, 但不推荐用于大量发送.
Auto 自动邮件发送控制阀.基于收件人数量及业务单元中的设置自动计算发送时间.
Manual* 手动邮件发送控制阀. 以小时为单位，手动设置完整发送完邮件所要用的时间.
* 注意: 最小的控制阀值为每分钟60条信息.

应答

返回值为已创建的newsletter ID. ID可以被用于暂停或发送状态为”InProgress”的newsletter (见 暂停和继续newsletter(SMS)).
应答Data元素:
元素/属性 类型 描述
(Data element content) int 已创建newsletter的ID.

示例

发送一个NEWSLETTER
请求:
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>
应答:
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>
发送全参数NEWSLETTER
请求:
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>