文档中心 > API类目 > 菜鸟无线API

cainiao.guoguo.im.task.list (查询消息发送任务列表)

查询消息发送任务列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
count Number 必须 10 返回条数
session_code String 必须 12321 sessionCode
start_index Number 必须 12321321 开始索引,以创建时间
user_id Number 必须 21321321 用户id

响应参数

名称 类型 示例值 描述
data TaskListResponse dd data
  • └ is_end
  • Boolean
  • true
  • end
  • └ next_index
  • Number
  • 12344
  • nextIndex
  • task_list
  • TaskResponse []
  • 1213
  • 任务列表
  • └ content
  • String
  • 内容
  • 内容
  • └ create_time
  • Number
  • 123321321
  • 创建时间
  • └ fail_count
  • Number
  • 失败条数
  • 失败条数
  • └ id
  • Number
  • 12321
  • id
  • └ status
  • Number
  • 1
  • 状态
  • └ success_count
  • Number
  • 10
  • 成功条数
  • └ total_count
  • Number
  • 100
  • 总条数
status_code String INVALID_PARAM 状态码
status_message String 无效参数 状态消息
is_success Boolean false 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoImTaskListRequest req = new CainiaoGuoguoImTaskListRequest();
req.setCount(10L);
req.setSessionCode("12321");
req.setStartIndex(12321321L);
req.setUserId(21321321L);
CainiaoGuoguoImTaskListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_guoguo_im_task_list_response>
    <data>
        <is_end>true</is_end>
        <next_index>12344</next_index>
        <task_list>
            <task_response>
                <content>内容</content>
                <create_time>123321321</create_time>
                <fail_count>失败条数</fail_count>
                <id>12321</id>
                <status>1</status>
                <success_count>10</success_count>
                <total_count>100</total_count>
            </task_response>
        </task_list>
    </data>
    <status_code>INVALID_PARAM</status_code>
    <status_message>无效参数</status_message>
    <is_success>false</is_success>
</cainiao_guoguo_im_task_list_response>

异常示例

  • XML示例
  • JSON示例
<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

FAQ

返回
顶部