获得列表导入进度

Get subscriber import progress 获得列表导入进度

请求数据格式

请求URL参数:

参数 类型 描述
apiKey string 你的API Key, 需要验证. 必填.
ID integer 导入 ID. 要求以地址一部分的形式应用 (非 GET参数). 见下例

示例URL:

https://api.esv2.com/v2/Api/ImportToListTasks/19?apiKey=test_api_key1

应答

接口返回值描述目标导入列表任务与其执行历史

应答数据元素:

元素/属性 类型 描述
Name string 导入任务的名称
List string 导入目标列表的名称
Url string 包含所导入收件人数据的文件所在URL地址
History array[complex] Import元素所组成的数组，描述导入执行.*

*如导入任务还未被执行则History为空

Import子元素:

元素/属性 类型 描述
StartedAt dateTime 导入起始时间.
UpdatedAt dateTime 导入任务状态的最后变化时间.
Status string 导入状态. 为: “Queued(排队等候)”In, “Progress(正在进行)”, “Completed(完成)”, “Error(发生错误)”, “Warning(警告)”其中之一.
Details string 附加信息, 如，导入失败会产生的报错信息.

示例

请求:

GET https://api.esv2.com/v2/Api/ImportToListTasks/19?apiKey=test_api_key1 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com
应答:
HTTP/1.1 200 OK
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:50:13 GMT
Content-Length: 559

<ApiResponse xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
 <Data>
  <Name>API test import</Name>
  <List>API test list</List>
  <Url>ftp://ftp.expertsender.com/Lists/test.csv</Url>
  <History>
   <Import>
    <StartedAt>2012-03-27T11:01:18</StartedAt>
    <UpdatedAt>2012-03-27T11:01:27</UpdatedAt>
    <Status>Completed</Status>
    <Details>ftp://ftp.expertsender.com/Lists/test.csv</Details>
   </Import>
  </History>
 </Data>
</ApiResponse>