淘宝开放平台

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

名称	类型	是否必须	示例值	更多限制	描述
start_time	String	可选	2024-01-01 00:00:00		开始时间
sort_type	String	可选	desc		排序类型
time_field	String	可选	start_time		时间字段
account_id	Number	必须	123		账号id
company_id	Number	必须	123		店铺id
sort_field	String	可选	sent_count		排序字段
user_id	Number []	可选		最大列表长度：999999	小满用户列表
end_time	String	可选	2024-01-01 00:00:00		结束时间
page	Number	可选	1		页数
plan_id	Number []	可选		最大列表长度：999999	计划id列表
plan_status	Number []	可选		最大列表长度：999999	计划状态列表
page_size	Number	可选	20		页面大小
is_admin	Number	必须	0		是否是admin

名称	类型	示例值	描述
data	Data		数据对象
└ count Number 2 list count list PlanList [] 列表对象 exception Exp [] 异常 └ handler_id Number 3579592571 handler id data ExpData [] 数据对象 └ type Number 4 类型 └ account String we34223@qq.com 账号 └ recommend_type Number 0 推荐类型 └ whatsapp_unsent_count Number 0 whatsapp_unsent_count └ is_track Number 1 是否追踪 └ package_type Number 5 package_type └ delivery_count Number 0 投递数 └ client_id Number 351462 客户id └ company_hash_ids String [] 公司列表 └ update_time String 2024-07-03 11:38:11 更新时间 └ update_user Number 249521482 更新用户 └ pull_status Number 2 拉取状态 └ create_time String 2024-07-03 11:38:11 创建时间 └ contact_count Number 100 联系人数量 └ end_time String demo 结束时间 └ reply_count Number 0 回复数 version Version [] 版本信息 └ company_hash_ids String [] 公司id └ main_flag Number 1 主要类型 └ update_time String 2024-07-03 11:38:11 更新时间 └ create_time String 2024-07-03 11:38:11 创建时间 └ version_id Number 3579592568 版本id └ client_id Number 351462 客户id └ plan_id Number 3579592567 计划id └ plan_name String 快捷营销2024.07.03-9 计划名称 └ start_time String 2024-07-03 11:38:13 开始时间 └ user_id Number 249521482 用户id └ touch_type String [] 触达类型 └ sent_count Number 0 发送数 └ plan_id Number 3579592567 计划id └ view_count Number 0 已读数 └ plan_status Number 1 计划状态 campaign Campaign 活动对象 └ customer_group_id String xxx 客群id └ channel_id String xxx 渠道id └ channel_type String xxx 渠道类型 └ template_id String xxx 模板id └ extra_info String xxx 额外信息 └ start_time String 2020-01-01 00:00:00 开始时间 └ post_time String 2020-01-01 00:00:00 发送时间 └ end_time String 2020-01-01 00:00:00 结束时间 └ creator String xxx 活动创建人名称
success	Boolean	true	是否成功
now	String	2024-07-03 14:15:36	时间
resp_code	Number	0	响应编码
error_desc	String	错误描述	错误描述

{
    "data":{
        "count":2,
        "list":[
            {
                    "exception":[
                        {
                                "handler_id":3579592571,
                                "data":[
                                    {
                                            "type":4,
                                            "account":"we34223@qq.com"
                                    }
                                ]
                        }
                    ],
                    "recommend_type":0,
                    "whatsapp_unsent_count":0,
                    "is_track":1,
                    "package_type":5,
                    "delivery_count":0,
                    "client_id":351462,
                    "update_time":"2024-07-03 11:38:11",
                    "update_user":249521482,
                    "pull_status":2,
                    "create_time":"2024-07-03 11:38:11",
                    "contact_count":100,
                    "end_time":"demo",
                    "reply_count":0,
                    "version":[
                        {
                                "company_hash_ids":"[]",
                                "main_flag":1,
                                "update_time":"2024-07-03 11:38:11",
                                "create_time":"2024-07-03 11:38:11",
                                "version_id":3579592568,
                                "client_id":351462,
                                "plan_id":3579592567
                        }
                    ],
                    "plan_name":"快捷营销2024.07.03-9",
                    "start_time":"2024-07-03 11:38:13",
                    "user_id":249521482,
                    "sent_count":0,
                    "plan_id":3579592567,
                    "view_count":0,
                    "plan_status":1,
                    "campaign":{
                        "customer_group_id":"xxx",
                        "channel_id":"xxx",
                        "channel_type":"xxx",
                        "template_id":"xxx",
                        "extra_info":"xxx",
                        "start_time":"2020-01-01 00:00:00",
                        "post_time":"2020-01-01 00:00:00",
                        "end_time":"2020-01-01 00:00:00",
                        "creator":"xxx"
                    }
            }
        ]
    },
    "success":true,
    "now":"2024-07-03 14:15:36",
    "resp_code":0,
    "error_desc":"错误描述"
}

{"success":"false","error_desc":"Illegal request","resp_code":"sign-check-failure"}

错误码	错误描述	解决方案

错误码查询工具 SDK下载

OKKI&TM

qimen.alibaba.okki.marketing.campaign.get (获取小满营销活动列表)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ