注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 千牛接口

taobao.qianniu.tasks.get (获取指定的任务)

获取指定的任务,可用的参数组合: task_ids + need_meta + fields:精确查找 biz_type + sub_biz_type + biz_ids + need_meta + fields:按照业务ID查找 biz_type + sub_biz_type + sender_uid + need_meta + fields:按照发起者查找 biz_type + sub_biz_type + receiver_uid + need_meta + fields:按照执行者查找 biz_type+modify_start_time+modify_end_time+fields:能支持指定修改时间的查询,用于增量查询等

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
biz_type String 可选 task 业务类型
sub_biz_type String 可选 QTask 子任务类型
task_ids String 可选 1,2,3 任务的ID列表,用逗号分隔
biz_ids String 可选 1,2 业务ID列表,逗号分隔
receiver_uid Number 可选 213123213 任务执行者用户数字ID
sender_uid Number 可选 213123213 任务发起者用户数字ID
status String 可选 0,1 逗号分隔的任务状态:0-未执行,1-执行中,2-执行完成,3-超时,4-取消,5-忽略
sub_status String 可选 1,2,3 逗号分隔的子任务状态,由业务方自定义
metadata_ids String 可选 111,222 任务元id,多个以逗号分隔
need_meta Boolean 可选 true
  • 默认值:false
  • 是否需要meta信息,默认值为false
    fields String 必须 id,receiver_uid,receiver_nick,,gmt_finished,biz_type,biz_id 逗号分隔的字段列表,各个字段含义: id:任务ID receiver_uid:执行者用户数字ID receiver_nick:执行者用户昵称 status:任务状态:0-未执行,1-执行中,2-执行完成,3-超时,4-取消,5-忽略 sub_status:子任务状态,由业务方自定义 finish_strategy:任务完成策略:1-一个人完成,2-所有人完成 gmt_finished:任务完成时间,格式:时间毫秒数 biz_type:业务类型 sub_biz_type:子业务类型 biz_id:业务ID biz_param:业务参数 biz_entry:业务入口 tag:任务标签 memo:任务备注
    page_size Number 可选 1
  • 默认值:20
  • 每页条数
    current_page Number 可选 1 当前页数,从1开始
    order_by String 可选 id
  • 默认值:id
  • 排序字段,可以为id,gmt_create,gmt_finished,metadata_id等
    order_type String 可选 asc
  • 默认值:desc
  • asc为升,desc为降
    remind_flag Number 可选 1 0-不需要提醒,未设提醒时间 1-设置过提醒时间,需要提醒
    biz_nick String 可选 nick 业务相关的对象,当前主要表示买家nick
    start_date String 可选 2014-01-01 根据任务创建时间搜索的开始日期(含),不填则不限。例如只查询2014-01-01当天的任务,则将start_date和end_date都设置成2014-01-01
    end_date String 可选 2014-01-01 根据任务创建时间搜索的结束日期(含),不填则不限。例如只查询2014-01-01当天的任务,则将start_date和end_date都设置成2014-01-01
    modify_start_time_str String 可选 2014-01-01 00:00:10 根据任务修改时间搜索的开始时间(含),不填则不限。例如查询“2014-01-01 00:00:10”之后有修改的任务,则将modify_start_time_str设置成“2014-01-01 00:00:10”
    modify_end_time_str String 可选 2014-01-01 00:00:10 根据任务修改时间搜索的结束时间(含),不填则不限。例如查询“2014-01-01 00:00:10”之前有修改的任务,则将modify_end_time_str设置成“2014-01-01 00:00:10”
    priority Number 可选 1 优先级。即创建时的metadata中的优先级。0为低,1为中,2为高。
    exclude_biz_type String 可选 memo 需要排除的任务类型
    key_word String 可选 今天 关键词搜索。只对任务内容进行模糊匹配,以及bizid和biznick进行精准匹配
    client_info String 可选 platform=pc&v=1.01.00N 客户端的版本信息
    need_deleted Boolean 可选 false
  • 默认值:false
  • 是否需要删除的任务,默认为false

    响应参数

    名称 类型 示例值 描述
    tasks QTask [] 返回的任务列表
    • └ id
    • Number
    • 1
    • 任务ID
    • └ receiver_uid
    • Number
    • 213123213
    • 执行者用户数字ID
    • └ receiver_nick
    • String
    • tbtest1063
    • 执行者用户昵称
    • └ sender_uid
    • Number
    • 111
    • 发起人uid
    • └ sender_nick
    • String
    • aaaa
    • 发起人nick
    • └ finish_flag
    • Number
    • 1
    • 表示是否为本条记录接收人实际完成
    • └ status
    • Number
    • 1
    • 任务状态:0-未执行,1-执行中,2-执行完成,3-超时,4-取消,6-已转发
    • └ sub_status
    • Number
    • 1
    • 子任务状态,由业务方自定义
    • └ finish_strategy
    • Number
    • 1
    • 任务完成标识, 0-一个人完成整个任务, 1-所有人完成整个任务完成,冗余任务元数据字段
    • └ gmt_create
    • Date
    • 2013-12-01 00:00:00
    • 任务创建时间
    • └ gmt_modified
    • Date
    • 2000-01-01 00:00:00
    • 任务更新时间
    • └ gmt_finished
    • Date
    • 2013-12-01 00:00:00
    • 任务完成时间,格式:当前时间毫秒数
    • └ gmt_create_long
    • Number
    • 1386755420153
    • gmt_create的数字格式
    • └ gmt_modified_long
    • Number
    • 1386755420153
    • gmt_modified的数字格式
    • └ gmt_finished_long
    • Number
    • 1386755420153
    • gmt_finished的数字格式
    • └ biz_type
    • String
    • task
    • 业务类型
    • └ sub_biz_type
    • String
    • QTask
    • 子业务类型
    • └ biz_id
    • String
    • 1
    • 业务ID
    • └ biz_param
    • String
    • x=2&y=3
    • 业务参数
    • └ biz_entry
    • String
    • app:xs34yt777
    • 业务入口
    • └ tag
    • String
    • 客户服务
    • 任务标签
    • └ memo
    • String
    • 备注
    • 任务备注
    • └ remind_flag
    • Number
    • 1
    • 到期提醒的方式。0-不提醒 1-pc和移动提醒 2-仅pc提醒 3-仅移动提醒。在查询类接口中,只需要传2或3即可,为1的数据都会包含在其中。
    • └ remind_time
    • Date
    • 2013-12-01 00:00:00
    • 提醒时间
    • └ remind_time_long
    • Number
    • 1386755420153
    • remind_time的数字格式
    • └ biz_nick
    • String
    • abcd
    • 与业务相关的对象。当前主要用于保存买家nick
    • └ total_count
    • Number
    • 111
    • 同次操作相关的任务数
    • └ priority
    • Number
    • 1
    • 优先级,同任务元中的priority值,方便查询使用。
    • └ metadata_id
    • Number
    • 1
    • 任务元id
    • └ biz_type_str
    • String
    • 订单管理
    • biz_type的类型中文名
    • └ comment_count
    • Number
    • 1
    • 当前任务的评论数
    • └ action
    • String
    • {a:1,b:2}
    • json格式的字符串,包含跳转协议
    • └ biz_id_action
    • String
    • tbseller//?.....
    • 点击业务号时的动作
    • └ biz_id_name
    • String
    • 订单编号
    • 业务号的展示名称
    • └ read_status
    • Number
    • 0
    • 任务“已读”、“未读”状态,0:已读,1:未读
    • meta
    • QTaskMetadata
    • 关联的任务元数据
    • └ id
    • Number
    • 1234
    • 主键
    • └ title
    • String
    • XX向你申请了YY
    • 任务标题
    • └ content
    • String
    • 请在N天内处理
    • 任务摘要内容
    • └ biz_sys_id
    • Number
    • 12232
    • 来源系统ID
    • └ biz_sys_task_type
    • Number
    • 1212
    • 任务在来源系统的类型, 这个是业务系统的自定义类型
    • └ start_time
    • Date
    • 2013-12-01 00:00:00
    • 任务开始时间,格式:当前时间毫秒数
    • └ end_time
    • Date
    • 2013-12-01 00:00:00
    • 任务结束时间,格式:当前时间毫秒数
    • └ sender_uid
    • Number
    • 213123213
    • 发起者用户数字ID
    • └ sender_nick
    • String
    • tbtest1063
    • 发起者用户昵称
    • └ reminder_flag
    • Number
    • 4
    • 提醒标志位: 0表示不需要提醒,1表示需要状态变更提醒
    • └ biz_remind_time
    • Date
    • 2014-12-26 09:00:00
    • 我的安排的任务上的提醒时间
    • └ biz_remind_time_long
    • Number
    • 123214234
    • 是biz_remind_time的数字格式
    • └ finish_strategy
    • Number
    • 2
    • 任务完成标识: 0表示只要有一个人完成任务即可,1表示所有人需要各自都完成任务
    • └ memo
    • String
    • this is memo
    • 任务元备注
    • └ priority
    • Number
    • 1
    • 优先级,0低,1中,2高
    • └ gmt_create
    • Date
    • 2000-01-01 00:00:00
    • 创建时间
    • └ gmt_modified
    • Date
    • 2000-01-01 00:00:00
    • 任务更新时间
    • └ start_time_long
    • Number
    • 1386755420153
    • start_time的数字格式
    • └ end_time_long
    • Number
    • 1386755420153
    • end_time的数字格式
    • └ gmt_create_long
    • Number
    • 1386755420153
    • gmt_create的数字格式
    • └ gmt_modified_long
    • Number
    • 1386755420153
    • gmt_modified的数字格式
    • └ total_count
    • Number
    • 1
    • 同次操作的任务元数
    • └ biz_type_str
    • String
    • 订单管理
    • biztype的中文名
    • └ comment_count
    • Number
    • 1
    • 当前任务的评论数
    • └ attachments
    • String
    • 23434_1234458623_seresfto
    • 轻任务附件信息,userId_timestamp_随机字符串,例如:23434_1234458623_seresfto
    • └ status
    • Number
    • 0
    • 0为未完成,2为完成,4为取消
    • └ voice_file
    • String
    • demo
    • 语音备注的文件名
    • └ receiver
    • String
    • 任务接收者
    • 任务接收者
    • └ new_yunpan_attachments
    • String
    • 新附件字段
    • newYunpanAttachments
    • └ is_deleted
    • Number
    • 100
    • 是否删除
    • └ content
    • String
    • demo
    • 新任务的内容
    • └ attachments
    • String
    • demo
    • 附件的文件名
    • └ voice_file
    • String
    • demo
    • 语音附件的文件名
    • └ parent_task_id
    • Number
    • 123
    • 父任务的id
    • └ new_yunpan_attachments
    • String
    • 新附件字段
    • newYunpanAttachments
    • └ open_buyer_uid
    • String
    • 买家uid密文
    • 买家uid密文

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    QianniuTasksGetRequest req = new QianniuTasksGetRequest();
    req.setBizType("task");
    req.setSubBizType("QTask");
    req.setTaskIds("1,2,3");
    req.setBizIds("1,2");
    req.setReceiverUid(213123213L);
    req.setSenderUid(213123213L);
    req.setStatus("0,1");
    req.setSubStatus("1,2,3");
    req.setMetadataIds("111,222");
    req.setNeedMeta(true);
    req.setFields("id,receiver_uid,receiver_nick,,gmt_finished,biz_type,biz_id");
    req.setPageSize(1L);
    req.setCurrentPage(1L);
    req.setOrderBy("id");
    req.setOrderType("asc");
    req.setRemindFlag(1L);
    req.setBizNick("nick");
    req.setStartDate("2014-01-01");
    req.setEndDate("2014-01-01");
    req.setModifyStartTimeStr("2014-01-01 00:00:10");
    req.setModifyEndTimeStr("2014-01-01 00:00:10");
    req.setPriority(1L);
    req.setExcludeBizType("memo");
    req.setKeyWord("今天");
    req.setClientInfo("platform=pc&v=1.01.00N");
    req.setNeedDeleted(false);
    QianniuTasksGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <qianniu_tasks_get_response>
        <tasks>
            <q_task>
                <id>1</id>
                <receiver_uid>213123213</receiver_uid>
                <receiver_nick>tbtest1063</receiver_nick>
                <sender_uid>111</sender_uid>
                <sender_nick>aaaa</sender_nick>
                <finish_flag>1</finish_flag>
                <status>1</status>
                <sub_status>1</sub_status>
                <finish_strategy>1</finish_strategy>
                <gmt_create>2013-12-01 00:00:00</gmt_create>
                <gmt_modified>2000-01-01 00:00:00</gmt_modified>
                <gmt_finished>2013-12-01 00:00:00</gmt_finished>
                <gmt_create_long>1386755420153</gmt_create_long>
                <gmt_modified_long>1386755420153</gmt_modified_long>
                <gmt_finished_long>1386755420153</gmt_finished_long>
                <biz_type>task</biz_type>
                <sub_biz_type>QTask</sub_biz_type>
                <biz_id>1</biz_id>
                <biz_param>x=2&amp;y=3</biz_param>
                <biz_entry>app:xs34yt777</biz_entry>
                <tag>客户服务</tag>
                <memo>备注</memo>
                <remind_flag>1</remind_flag>
                <remind_time>2013-12-01 00:00:00</remind_time>
                <remind_time_long>1386755420153</remind_time_long>
                <biz_nick>abcd</biz_nick>
                <total_count>111</total_count>
                <priority>1</priority>
                <metadata_id>1</metadata_id>
                <biz_type_str>订单管理</biz_type_str>
                <comment_count>1</comment_count>
                <action>{a:1,b:2}</action>
                <biz_id_action>tbseller//?.....</biz_id_action>
                <biz_id_name>订单编号</biz_id_name>
                <read_status>0</read_status>
                <meta>
                    <id>1234</id>
                    <title>XX向你申请了YY</title>
                    <content>请在N天内处理</content>
                    <biz_sys_id>12232</biz_sys_id>
                    <biz_sys_task_type>1212</biz_sys_task_type>
                    <start_time>2013-12-01 00:00:00</start_time>
                    <end_time>2013-12-01 00:00:00</end_time>
                    <sender_uid>213123213</sender_uid>
                    <sender_nick>tbtest1063</sender_nick>
                    <reminder_flag>4</reminder_flag>
                    <biz_remind_time>2014-12-26 09:00:00</biz_remind_time>
                    <biz_remind_time_long>123214234</biz_remind_time_long>
                    <finish_strategy>2</finish_strategy>
                    <memo>this is memo</memo>
                    <priority>1</priority>
                    <gmt_create>2000-01-01 00:00:00</gmt_create>
                    <gmt_modified>2000-01-01 00:00:00</gmt_modified>
                    <start_time_long>1386755420153</start_time_long>
                    <end_time_long>1386755420153</end_time_long>
                    <gmt_create_long>1386755420153</gmt_create_long>
                    <gmt_modified_long>1386755420153</gmt_modified_long>
                    <total_count>1</total_count>
                    <biz_type_str>订单管理</biz_type_str>
                    <comment_count>1</comment_count>
                    <attachments>23434_1234458623_seresfto</attachments>
                    <status>0</status>
                    <voice_file>demo</voice_file>
                    <receiver>任务接收者</receiver>
                    <new_yunpan_attachments>新附件字段</new_yunpan_attachments>
                </meta>
                <is_deleted>100</is_deleted>
                <content>demo</content>
                <attachments>demo</attachments>
                <voice_file>demo</voice_file>
                <parent_task_id>123</parent_task_id>
                <new_yunpan_attachments>新附件字段</new_yunpan_attachments>
                <open_buyer_uid>买家uid密文</open_buyer_uid>
            </q_task>
        </tasks>
    </qianniu_tasks_get_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>

    错误码解释

    错误码 错误描述 解决方案
    isp.QTASK_SYSTEM_ERROR 轻任务的系统错误 重试

    API工具

    如何获得此API

    FAQ

    返回
    顶部