任务相关

群发任务列表

URL

http://www.bestedm.net/mm-ms/apinew/task.php?do=task-list

HTTP请求方式 

GET

GET参数说明

参数 类型 必须 说明
id int 否 任务 id,如存在该参数,则只返回该任务的信息,否则返回所有任务信息
date date
(YYYY-MM-DD)		 否 指定发送日期
send_status string 否 任务发送状态，默认为‘all’,表示所有群发任务, 其他状态说明： ‘0’为等待发送 ‘1’为等待启动发送 ‘2’为正在发送 ‘3’为发送完成 ‘4’任务停止 ‘-1’为暂不发送 ‘-2’为暂停发送 ‘-3’为取消发送 ‘-4’为发送出错 ‘-5’为等待入库启动
page int 否 分页ID,可不传，则为获取前 100 条
limit int 否 每页显示的任务数,默认为 10

备注：
page，limit 两个参数如果都没有指定，默认获取全部任务列表

API 返回的结果是 XML 格式, 示例如下: 

<?xml version="1.0" encoding="UTF-8"?>
<task_list>
    <task>
        <id>任务 id</id>
        <sn>任务号</sn>
        <acct_type>发件人类型(all,domain,address)</acct_type>
        <acct_domain>发件人域名,发件人类型为 domain 时存在</acct_domain>
        <acct_address>发件人,发件人类型为 address 时存在</acct_address>
        <sender>发件人</sender>
        <replyto>回复地址</replyto>
        <sender_name>发件人姓名</sender_name>
        <templates>
            <template>
                <tpl_id>模板 id</tpl_id>
                <tpl_name>模板名称</tpl_name>
            </template>
            <template>
                <tpl_id>模板 id</tpl_id>
                <tpl_name>模板名称</tpl_name>
            </template>
        </templates>
        <addr_type>地址类型</addr_type>
        <listes>
            <item>
                <list_id>联系人分类 id</list_id>
                <list_name>联系人分类名称</list_name>
            </item>
        </listes>
        <send_qty>预定发送数量(用户指定)</send_qty>
        <send_qty_remak>预定发送数量(实际发送)</send_qty_remak>
        <send_time>预定发送时间</send_time>
        <time_start>实际发送开始时间</time_start>
        <time_end>实际发送结束时间</time_end>
        <send_count>实际发送数量</send_count>
        <error_count>发送失败数量</error_count>
        <send_status>发送状态</send_status>
        <track_status>跟踪统计状态数字(0 不跟踪 1 跟踪邮件打开情况 2 跟踪邮件打开与链接点击情况)</track_status>
    </task>
    <task>...</task>
    ...
</task_list>

添加任务

URL

http://www.bestedm.net/mm-ms/apinew/task.php?do=add-task

HTTP请求方式 

POST

POST参数说明

参数 类型 必须 说明
tpl_id string 是 模板ID,如果是多模板,则传多个模板ID,并用逗号分隔,举例1,2,3,78
send_domain string 是 发件人域名
send_account string 是 发件人帐号
send_fullname string 否 发件人名称
maillist_id string 是 联系人分类 id
send_qty_start int 否 发送起始数字，取值>=1,默认为1
send_qty string 否 发送结束数字，默认为0,当为0时,表示全部地址,且不在考虑上面(send_qty_start)的设置，
当>=1时,发送范围为 send_qty_start - send_qty,
如: send_qty_start=10, send_qty=100表示到从第 10-100 个地址开始发送
send_replyto string 否 指定回复地址
is_need_receipt int 否 是否开启阅读回执，默认为0表示不开启，1表示开启
status string 否 发送状态,默认为 2，立即发送，
-1, 暂不发送
1, 定时发送
time date 否 定时发送时间,举例：2017-07-04 16:08:56
subs_link int 否 是否在邮件中加入退订订阅链接。默认为 1,加入
track_status int 否 是否开启邮件跟踪。默认为 0,不开启; 1表示只开启打开 2表示开启打开和点击
track_domain string 否 自定义跟踪统计链接域名
hour_speed int 否 指定发送速率;取值 100 至 75000(单位:每小时最大发送量设置)

发件人域名说明:

  1. 如果发件人是某个域名下的所有发件人,参数send_domain为指定的域名,send_account为all。如:&send_domain=comingchina.com&send_account=all
  2. 如果发件人是所有域名下的所有发件人,参数 send_domain,send_account 两个都为all。
  3. 如果发件人只是某个域名下的一个发件人。 send_domain可以不需要。 如:&send_account=test@comingchina.com

修改群发任务

URL

http://www.bestedm.net/mm-ms/apinew/task.php?do=edit-task

HTTP请求方式 

POST

POST参数说明

参数 类型 必须 说明
id int 是 任务ID
tpl_id string 是 模板ID,如果是多模板,则传多个模板ID,并用逗号分隔,举例1,2,3,78
send_domain string 是 发件人域名
send_account string 是 发件人帐号
send_fullname string 否 发件人名称
maillist_id string 是 联系人分类 id
send_qty_start int 否 发送起始数字，取值>=1,默认为1
send_qty string 否 发送结束数字，默认为0,当为0时,表示全部地址,且不在考虑上面(send_qty_start)的设置，
当>=1时,发送范围为 send_qty_start - send_qty,
如: send_qty_start=10, send_qty=100表示到从第 10-100 个地址开始发送
send_replyto string 否 指定回复地址
is_need_receipt int 否 是否开启阅读回执，默认为0表示不开启，1表示开启
status string 否 发送状态,默认为 2，立即发送，
-1, 暂不发送
1, 定时发送
send_time date 否 定时发送时间,举例：2017-07-04 16:08:56
subs_link int 否 是否在邮件中加入退订订阅链接。默认为 1,加入
track_status int 否 是否开启邮件跟踪。默认为 0,不开启; 1表示只开启打开 2表示开启打开和点击
track_domain string 否 自定义跟踪统计链接域名
hour_speed int 否 指定发送速率;取值 100 至 75000(单位:每小时最大发送量设置)

备注：
1. 除参数 username，password，do 之外，其它参数均可通过 get 或者 post 方式发送
2. 如果发件人是某个域名下的所有发件人，参数 send_domain 为域名，send_account 为 all。如：&send_domain=comingchina.com&send_account=all
3. 如果发件人是所有域名下的所有发件人，参数 send_domain，send_account 两个都为 all。
如：&send_domain=all&send_account=all 4. 如 果 发 件 人 只 是 某 个 域 名 下 的 一 个 发 件 人 。 Send_domain 可 以 不 需 要 。 如 ： &send_account=test@comingchina.com

删除任务

URL

http://www.bestedm.net/mm-ms/apinew/task.php?do=del-task

HTTP请求方式 

POST

POST参数说明

参数 类型 必须 说明
id int 是 任务ID