获取短信/彩信消息清单

Get messages list 获取短信/彩信消息清单

Messages集合包含所有已发送的短信/彩信消息，可返回所有匹配指定条件的短信/彩信消息。短信/彩信消息的信息详情可通过指定对应的消息ID获取

请求数据格式

获取多条信息
请求URL参数:
参数 类型 描述
apiKey string 你的Api Key, 用于认证. 必填.
tag string 标签. 选填. 如指定, 只有添加了标签的信息被显示.
startDate date 开始日期. 选填. 如指定, 在开始日期之前的信息不会显示, 可与结束日期一起定义某一段时间区间.
endDate date 见开始日期
type string 只显示指定短信/彩信类型信息. 选填. 有效值:

    • Newsletter
    • 工作流信息

示例:

https://api.esv2.com/v2/Api/SmsMmsMessages?apiKey=YOUR_API_KEY_HEREhttps://api.esv2.com/v2/Api/SmsMmsMessages?apiKey=YOUR_API_KEY_HERE&tag=sportshttps://api.esv2.com/v2/Api/SmsMmsMessages?apiKey=YOUR_API_KEY_HERE&tag=sports&startDate=2016-05-20&endDate=2016-05-22https://api.esv2.com/v2/Api/SmsMmsMessages?apiKey=YOUR_API_KEY_HERE&tag=sports&startDate=2016-05-20&endDate=2016-05-22&type=WorkflowMessage
通过短信/彩信ID获取信息
请求URL参数:
参数 类型 描述
apiKey string 你的API Key, 需要验证. 必填.
ID int 短信/彩信ID. 要求以地址一部分的形式应用 (非GET参数). 见下例
示例:
https://api.esv2.com/v2/Api/SmsMmsMessages/123?apiKey=YOUR_API_KEY_HERE

应答

获取多条信息

应答Data元素:

元素/属性 类型 描述
Messages array[complex] Message元素组成的数组
Message子元素:
元素/属性 类型 描述
Id int 短信/彩信标识ID.
Sender string 短信/彩信中设定的发送方名称
CampaignDescription string 短信/彩信消息编辑器中’任务描述’的值
Subject string 短信/彩信标题
Type string 短信/彩信类型(Newsletter， 自动回复邮件， 触发式邮件等).
SentDate datetime 选填. 短信/彩信发送日期. 对于发送多次的短信/彩信， (如自动回复) 则为指定时间范畴内该邮件第一次发送的时间
Tags string 选填. 逗号分割短信/彩信的标签列表
通过短信/彩信ID获取信息
应答Data元素:
元素/属性 类型 描述
Id int 短信/彩信标识
FromEmail string 在短信/彩信中设定的发送方地址
FromName string 在短信/彩信中设定的发送方名称
Subject string 短信/彩信标题
Type string 短信/彩信类型(Newsletter， 自动回复邮件， 触发式邮件等)
SentDate datetime 选填. 短信/彩信发送日期. 对于发送多次的短信/彩信， (如自动回复) 则为指定时间范畴内该邮件第一次发送的时间
Tags string 选填. 逗号分割短信/彩信的标签列表
ThrottlingMethod string 选填. 短信/彩信发送控制阀类型
Throttling int 选填. 短信/彩信发送控制阀 (小时). 只有当ThrottlingMethod 被设置为 “Manual” (手动) 时需要填写
GoogleAnalyticsTags array[complex] 选填. GoogleAnalyticsTag元素组成的数组 (如果短信/彩信信息应用Google Analytics)
YandexListId complex 选填. Yandex列表ID信息 (如果短信/彩信集成Yandex)
Channels string 选填. 逗号分隔发送通道IP列表 (如果短信/彩信通过非默认通道发送)
Lists array[complex] 选填. List元素组成的数组 (目标收件人列表)
Segments array[complex] 选填. Segment元素组成的数组 (目标收件人细分)
Status string 选填. 只对Newsletter可用
GoogleAnalytics子元素
元素/属性 类型 描述
Name string 标签名称, 如: “utm_source”
Value string 标签值
YandexListId子元素
元素/属性 类型 描述
Identifier string Yandex标识
Comment string 注释
List子元素:
元素/属性 类型 描述
Id int 列表标识ID
Name string 列表名称
Segment子元素:
元素/属性 类型 描述
Id int 收件人细分标识ID
Name string 收件人细分名称
合法的ThrottlingMethod模式值：
ThrottlingMethod值 描述
None 不启用任何发送控制阀
Auto 启用自动发送控制阀
Manual 手动控制发送控制阀 (见 “Throttling” 元素)
所有合法的邮件状态值:
Status value
Scheduled
InProgress
Sent
Paused
Draft
Deleted

示例

获取多个短信/彩信信息

请求:

GET 
https://api.esv2.com/v2/Api/SmsMmsMessages?startDate=2016-05-19&apiKey=test_api_key1 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com
OK应答:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=cu23cqm125fq1qih1kg4ux45; path=/; HttpOnly
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Mon, 24 May 2010 12:56:22 GMT
Content-Length: 415

<ApiResponse xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
 <Data>
  <Messages>
    <Message>
    <Id>892</Id>
    <FromName>John Smith</FromName>
    <FromEmail>j.smith@domain.com</FromEmail>
    <Subject>test newsletter</Subject>
    <Type>Newsletter</Type>
    <SentDate>2010-05-19T19:35:08</SentDate>
   </Message>
   <Message>
    <Id>893</Id>
    <FromName>Your Favorite Shop</FromName>
    <FromEmail>contact@yfs.com</FromEmail>
    <Subject>test newsletter 2</Subject>
    <Type>Newsletter</Type>
    <SentDate>2010-05-21T14:09:15</SentDate>
    <Tags>test 1</Tags>
   </Message>
  </Messages>
 </Data>
</ApiResponse>
通过短信/彩信ID获取信息
请求:
GET 
https://api.esv2.com/v2/Api/SmsMmsMessages/893?apiKey=test_api_key1 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com
OK应答:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=3e0htsjefgfcby55ra5b2045; path=/; HttpOnly
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Mon, 24 May 2010 12:59:37 GMT
Content-Length: 369

<ApiResponse xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
 <Data>
  <Id>893</Id>
  <FromName>Your Favorite Shop</FromName>
  <FromEmail>contact@yfs.com</FromEmail>
  <Subject>test newsletter 2</Subject>
  <Type>Newsletter</Type>
  <SentDate>2010-05-21T14:09:15</SentDate>
  <Tags>test 1</Tags>
  <Channels>192.168.10.2, 192.168.10.3</Channels>
  <Status>Sent</Status>
  <Lists>
   <List>
    <Id>2</Id>
    <Name>test list</Name>
   </List>
  </Lists>
 </Data>
</ApiResponse>
Google Analytics标签和Yandex列表ID应答示例:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=3e0htsjefgfcby55ra5b2045; path=/; HttpOnly
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Mon, 24 May 2010 12:59:37 GMT
Content-Length: 455

<ApiResponse xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
 <Data>
  <Id>123951</Id>
  <FromName>myFromName</FromName>
  <FromEmail>myfromEmail@domain.com</FromEmail>
  <Subject>Google Analytics tags test</Subject>
  <Type>Newsletter</Type>
  <ThrottlingMethod>Auto</ThrottlingMethod>
  <GoogleAnalyticsTags>
   <GoogleAnalyticsTag>
    <Name>utm_source</Name>
    <Value>testsource</Value>
   </GoogleAnalyticsTag>
   <GoogleAnalyticsTag>
    <Name>utm_medium</Name>
    <Value>Email</Value>
   </GoogleAnalyticsTag>
   <GoogleAnalyticsTag>
    <Name>utm_content</Name>
    <Value>testcontent</Value>
   </GoogleAnalyticsTag>
   <GoogleAnalyticsTag>
    <Name>utm_campaign</Name>
    <Value>testcampaign</Value>
   </GoogleAnalyticsTag>
  </GoogleAnalyticsTags>
  <YandexListId>
   <Identifier>testid</Identifier>
   <Comment>testcomment</Comment>
  </YandexListId>
  <Status>Draft</Status>
 </Data>
</ApiResponse>