创建收件人列表

Create subscribers list 创建收件人列表

Lists接口允许创建新的收件人列表. 已经创建的列表可以用于导入收件人或利用API、ExpertSender平台操作或其他有效方法手动逐个添加.

请求数据格式

创建收件人列表请求中的Data元素部分
Data子元素:
元素/属性 类型 描述
GeneralSettings complex 包含基本列表设置. 必填.
AddressSettings complex 列表的发送方公司地址设置. 选填.
SubscriberSettings complex 根据收件人特性的附加设置. 选填.
DomainSettings complex 发送域名设置. 选填.
ConfirmationEmail complex 具有双重选择加入(double opt-in)列表的确认邮件设置. 选填. 如忽略，则会采用默认的确认邮件.
GeneralSettings子元素:
元素/属性 类型 描述
IsSeedList boolean 标记说明创建列表是收件人列表还是测试列表. 选填. 默认值是“false”（收件人列表）
Name string 列表名称. 最多50个字符. 必填.
FriendlyName string 收件人可见的列表名称. 最多50个字符，选填.
Description string 方便内部管理的列表描述. 选填.
Language string 列表语言. 影响默认邮件页脚，日期/数字格式等. 默认值为 “en-US”. 选填. 可用的列表语言见下
OptInMode string 选择加入（Opt-in）模式. 默认值为 “SingleOptIn”. 对于需要发送确认邮件的列表来说，可以指定为”DoubleOptIn”.
Charset string Email字符集 (代码页). 选填. 默认为 “UTF-8”. 支持字符集见下.
SubscriptionConfirmPageUrl string 在收件人加入列表之后为之重新定向的URL.选填. 默认为空 (无重定向).
SubscriptionThankYouPageUrl string 在收件人确认加入列表之后为之重新定向的URL。选填。默认为空 (无重定向).
RemovalPageUrl string 在收件人从列表退订之后为之重新定向的URL。选填。默认为空(无重定向).
PreferencesChangeUrl string 收件人在”偏好中心” （Preference Center）改变任何选项后为之重新定向的URL.选填. 默认为空 (无重定向).
支持语言列表:
语言
en-US
pl-PL
ru-RU
zh-CN
支持字符集列表:
Charset
UTF-8
ISO-8859-1
ISO-8859-2

注意：语言和字符集列表是可以自定义的项目, 您可向ExpertSender团队询问其他可以被支持的语言/字符集 AddressSettings子元素.

AddressSettings子元素:
元素/属性 类型 描述
Company string 发送者公司名称，选填.
Address string 发送者公司地址，第一行，选填.
Address2 string 发送者公司地址，第二行，选填.
City string 城市，选填.
ZipPostalCode string 邮编，选填.
 
SubscriberSettings子元素:
元素/属性 类型 描述
DefaultSubscriberName string 如果收件人的名称在数据库中未找到，则该字符串将用来作为收件人名称的默认值.
DefaultSubscriberFirstname string 如果收件人的名字在数据库中未找到，则该字符串将用来作为收件人名字的默认值.
DefaultSubscriberLastname string 如果收件人的姓氏在数据库中未找到，则该字符串将用来作为收件人姓氏的默认值.
FrequencyCappingTimeEmail integer 向收件人发送两封邮件的最小时间间隔（小时为单位), 选填, 默认为0 (无限制).
FrequencyCappingTimeSmsMms integer 向收件人发送两封短信/彩信的最小时间间隔（小时为单位), 选填, 默认为0 (无限制).
DisableStandardMessageFooter boolean 如设为 “true” (注意小写！), 向列表中发送的邮件将不会有默认的邮件页脚. 选填, 默认为 “false”.
DisableListUnsubscribeHeader boolean 如设为 “true” (注意小写!), 向列表中发送的邮件将不会有”List-Unsubscribe:”邮件页眉. 选填. 默认为 “false”.
AskBeforeUnsubscribing boolean 如设为 “true” (注意小写!), 收件人在退订前会被要求确认从列表中的退订行为 (自动停用 “one-click unsubscribe” 一键退订). 选填. 默认为 “false”.
 
DomainSettings子元素:
元素/属性 类型 描述
ClickTrackingDomain string 将发送至该列表的email中链接所用的自定义域名, 选填, 默认为标准（业务单元）设置
ConfirmationEmail子元素:
元素/属性 类型 描述
FromName string 字符串放入确认邮件的 “发送方名称: “, 必填.
FromEmail string Email地址放入确认邮件 “发送方电邮地址:”, 必填.
Subject string 确认邮件标题. 必填.
Html string 确认邮件包含的HTML内容. 为了XML的字符转义完整, HTML内容应封装在CDATA节点中, 请查看示例. 必填.*
Plain string 确认邮件中的纯文本内容. 必填.*
*为了最易于收件人阅读，确认邮件需要HTML及纯文本内容. 这是一个特殊情况，对于普通邮件，如Newsletter，则没有这项要求 应答 接口将返回创建的收件人列表ID. ID可以被用于，如向该列表进行数据导入

应答

接口返回已创建列表ID. ID可以被指定, 如发起指定列表导入 
应答Data元素:
 
元素/属性 类型 描述
(Data element content) int 创建的列表的ID.

示例

创建新列表（默认设置)
请求:
POST https://api.esv2.com/v2/Api/Lists HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: application/xml 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 278 
 
<ApiRequest xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xs=”http://www.w3.org/2001/XMLSchema”>
  <ApiKey>test_api_key1</ApiKey>
  <Data>
    <GeneralSettings>
      <Name>API test list</Name>
    </GeneralSettings>
  </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: Thu, 05 Apr 2012 15:25:57 GMT 
Content-Length: 147 
 
 <ApiResponse xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
   <Data>33</Data>
 </ApiResponse>

创建列表 (全参数设置)

请求:
POST https://api.esv2.com/v2/Api/Lists HTTP/1.1 
Accept-Encoding: gzip,deflate 
Content-Type: application/xml 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com 
Content-Length: 1983 
 
 
 <ApiRequest xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xs=”http://www.w3.org/2001/XMLSchema”>
   <ApiKey>test_api_key1</ApiKey>
   <Data>
     <GeneralSettings>
       <Name>API test list</Name>
       <FriendlyName>Best offers!</FriendlyName>
       <Description>This is a test list created using API</Description>
       <Language>en-US</Language>
       <OptInMode>DoubleOptIn</OptInMode>
       <Charset>ISO-8859-1</Charset>
       <SubscriptionConfirmPageUrl>
         http://www.test.com
       </SubscriptionConfirmPageUrl>
       <SubscriptionThankYouPageUrl>
         http://www.test.com
       </SubscriptionThankYouPageUrl>
       <RemovalPageUrl>http://www.test.com</RemovalPageUrl>
       <PreferencesChangeUrl>http://www.test.com</PreferencesChangeUrl>
     </GeneralSettings>
     <AddressSettings>
       <Company>TestCompany</Company>
       <Address>Test Blvd.</Address>
       <Address2>123</Address2>
       <City>New York</City>
       <ZipPostalCode>12345</ZipPostalCode>
       <StateProvinceRegion>CA</StateProvinceRegion>
       <Country>USA</Country>
     </AddressSettings>
     <SubscriberSettings>
       <DefaultSubscriberName>Respectful Customer</DefaultSubscriberName>
       <DefaultSubscriberFirstname>Customer</DefaultSubscriberFirstname>
       <DefaultSubscriberLastname>Respectful</DefaultSubscriberLastname>
       <FrequencyCappingTimeEmail>12</FrequencyCappingTimeEmail>
       <FrequencyCappingTimeSmsMms>24</FrequencyCappingTimeSmsMms>
       <DisableStandardMessageFooter>true</DisableStandardMessageFooter>
       <DisableListUnsubscribeHeader>true</DisableListUnsubscribeHeader>
       <AskBeforeUnsubscribing>true</AskBeforeUnsubscribing>
     </SubscriberSettings>
     <DomainSettings>
       <ClickTrackingDomain>testdomain.com</ClickTrackingDomain>
     </DomainSettings>
     <ConfirmationEmail>
       <FromName>Test</FromName>
       <FromEmail>test@test.pl</FromEmail>
       <Subject>to jest testowy subject</Subject>
       <Html>
         <![CDATA[<a href=”*[link_confirm]*”>Confirm subscription</a>]]>
       </Html>
       <Plain>Confirm your subscription: *[link_confirm]*</Plain>
     </ConfirmationEmail>
   </Data>
 </ApiRequest>