淘宝开放平台

请求地址：

环境	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输入参数签名结果，签名算法介绍请点击这里。

名称	类型	是否必须	示例值	更多限制	描述
account_id	Number	必须	123		账号
company_id	Number	必须	123		公司id
list	Data []	必须		最大列表长度：100	数据列表
└ subject String [] 必须邮件主题 └ content String 必须 xxxx 邮件内容 └ sender String 可选 ww 发送人 └ sender_name String 可选 www 发送人名字 └ sign_id String 可选 123 签名id └ attachment_list String [] 可选附件列表 └ inline_image_list String [] 可选图片列表 └ draft Number 可选 0 是否是草稿 └ template_id Number 可选 1 okki edm模板id └ template_config_json String 可选模板配置字符串模板配置字符串 └ template_data_json String 可选模板数据字符串模板数据字符串 └ template_html_json String 可选模板html字符串模板html字符串 └ template_img_url String 可选 http:xxxx 模版图片链接
receivers	Receivers []	必须		最大列表长度：1000	收件人
└ nickname String 可选 xxx 名称 └ account String 必须 xxx@okki.com 邮箱 └ company_name String 可选公司名公司名 └ source Number 必须 1 来源
plan_name	String	必须	planxxxx		计划名
start_time	String	必须	2020-01-01 00:00:00		计划开始时间
end_time	String	可选	2020-01-01 00:00:00		计划结束时间
campaign	Campaign	可选			计划对象
└ customer_group_id String 可选 xxx 客群id └ channel_id String 可选 xxx 渠道id └ channel_type String 可选 xxx 渠道type └ 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 计划结束时间

名称	类型	示例值	描述
data	Data		数据对象
└ status Number 1 状态 └ company_count Number 123 公司总数 └ total_count Number 123 总数 └ plan_id Number 13 计划id └ is_async Number 0 是否异步 └ filter_count Number 1 过滤数 └ plan_name String xxx 计划名称
error_desc	String	2024-06-17 17:57:47.527	错误描述
success	Boolean	true	是否成功
now	String	2024-06-17 17:57:47	时间
resp_code	Number	0	响应编码

{"start_time":"2020-01-01 00:00:00","account_id":123,"company_id":123,"receivers":[{"company_name":"公司名","nickname":"xxx","source":1,"account":"xxx@okki.com"}],"end_time":"2020-01-01 00:00:00","campaign":{"start_time":"2020-01-01 00:00:00","extra_info":"xxx","end_time":"2020-01-01 00:00:00","template_id":"xxx","channel_type":"xxx","customer_group_id":"xxx","channel_id":"xxx","post_time":"2020-01-01 00:00:00"},"list":[{"template_data_json":"模板数据字符串","sign_id":"123","attachment_list":[""],"subject":[""],"inline_image_list":[""],"template_html_json":"模板html字符串","sender_name":"www","template_img_url":"http:xxxx","template_config_json":"模板配置字符串","content":"xxxx","sender":"ww","draft":0,"template_id":1}],"plan_name":"planxxxx"}

{
    "data":{
        "status":1,
        "company_count":123,
        "total_count":123,
        "plan_id":13,
        "is_async":0,
        "filter_count":1,
        "plan_name":"xxx"
    },
    "error_desc":"2024-06-17 17:57:47.527",
    "success":true,
    "now":"2024-06-17 17:57:47",
    "resp_code":0
}

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

错误码	错误描述	解决方案

错误码查询工具 SDK下载

OKKI&TM

qimen.alibaba.okki.marketing.campaign.add (新增营销活动)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ