淘宝开放平台

登录
文档中心 > API类目 > 驿马前台api

驿马前台api

cainiao.yima.communication.task.list (获取通知发送任务列表)

获取通知发送任务列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
count Number 必须 10 请求个数
user_id Number 必须 23412341 user id
session_code String 必须 23432ldsaf21432 session code
start_index Number 必须 2341324 下次请求索引

响应参数

名称 类型 示例值 描述
data TaskListDto data data
  • └ is_end
  • Boolean
  • true
  • 是否还有数据
  • └ next_index
  • Number
  • 213432
  • 下次请求索引
  • task_list
  • TaskDto []
  • TaskDto
  • 任务列表
  • └ content
  • String
  • XXXXXX
  • 内容
  • └ create_time
  • Number
  • 21342341
  • 创建时间
  • └ fail_count
  • Number
  • 10
  • 失败数目
  • └ id
  • Number
  • 13243214
  • id
  • └ notify_type
  • Number
  • 1
  • 通知类型
  • └ status
  • Number
  • 1
  • 状态
  • └ success_count
  • Number
  • 10
  • 成功条数
  • └ title
  • String
  • XXXX
  • 标题
  • └ total_count
  • Number
  • 20
  • 总条数
status_code String INVALID_PARAM 状态码
status_message String 无效参数 状态消息
is_success Boolean false 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
1
2
3
4
5
6
7
8
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaCommunicationTaskListRequest req = new CainiaoYimaCommunicationTaskListRequest();
req.setCount(10L);
req.setUserId(23412341L);
req.setSessionCode("23432ldsaf21432");
req.setStartIndex(2341324L);
CainiaoYimaCommunicationTaskListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<cainiao_yima_communication_task_list_response>
    <data>
        <is_end>true</is_end>
        <next_index>213432</next_index>
        <task_list>
            <task_dto>
                <content>XXXXXX</content>
                <create_time>21342341</create_time>
                <fail_count>10</fail_count>
                <id>13243214</id>
                <notify_type>1</notify_type>
                <status>1</status>
                <success_count>10</success_count>
                <title>XXXX</title>
                <total_count>20</total_count>
            </task_dto>
        </task_list>
    </data>
    <status_code>INVALID_PARAM</status_code>
    <status_message>无效参数</status_message>
    <is_success>false</is_success>
</cainiao_yima_communication_task_list_response>

异常示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

API测试工具 错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问
返回
顶部