联系人相关

获取联系人分类列表

URL

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

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

<?xml version="1.0" encoding="UTF-8"?>
<maillist>
    <item>
        <id>联系人分类 ID</id>
        <subject>联系人分类名称</subject>
        <descrīption>分类说明</descrīption>
        <count>地址数量统计</count>
        <input_status>导入状态. 1表示正在导入,0表示没有导入 </input_status>
        <status>联系人分类状态</status>
    </item>
...
</maillist>

说明：

1. "status"：当前联系人分类的状态，"enabled"为正常使用，"disabled"为禁止使用。

添加联系人分类

URL

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

HTTP请求方式 

POST

参数说明

参数 类型 必须 说明
subject string 是 联系人分类名称
status string 是 分类状态, 取值enabled/disabled, enabled表示正常, disabled表示禁用
description string 否 联系人分类说明

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

 <?xml version="1.0" encoding="UTF-8"?>
<result>
<status>执行结果标识符</status>
<data>添加成功返回的分类ID</data>
</result>

执行结果标识符说明:

  1. "add_maillist_error":添加联系人分类时发生错误
  2. "add_describe_error":添加联系人分类描述信息时发生错误
  3. "success":添加联系人分类成功

修改联系人分类

URL

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

HTTP请求方式 

GET + POST

GET参数说明

参数 类型 必须 说明
id int 是 联系人分类ID

POST参数说明

参数 类型 必须 说明
subject string 是 联系人分类名称
status string 是 分类状态, 取值enabled/disabled, enabled表示正常, disabled表示禁用
description string 否 联系人分类说明

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

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>执行结果标识符</status>
    <data>执行结果说明</data>
</result>

执行结果标识符说明:

  1. "update_maillist_error":修改联系人分类时发生错误
  2. "update_describe_error":修改联系人分类描述信息时发生错误
  3. "success":修改联系人分类成功

删除联系人分类

URL

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

HTTP请求方式 

GET

参数说明

参数 类型 必须 说明
id int 是 联系人分类ID

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

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>执行结果标识符</status>
    <data>执行结果说明</data>
</result>

执行结果标识符说明:

  1. "delete_address_error":删除联系人分类出错
  2. "delete_describe_error":删除联系人分类描述信息时发生错误
  3. "delete_maillist_error":删除联系人分类出错
  4. "success":删除联系人分类成功

获取分类地址列表

URL

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

HTTP请求方式 

GET

参数说明

参数 类型 必须 说明
list_id int 是 联系人分类ID
address_id int 否 不传此参数，代表获取当前分类，当 address_id>0,表示只获取此单个地址 的信息返回
keyword string 否 关键字查询，在address,fullname 两项中模糊查找
page int 否 分页数,如果存在该参数,则为分页查找,否则为查找全部
limit int 否 分页查找时每页显示的数据记录数目,默认为 50

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

<?xml version="1.0" encoding="UTF-8"?>
<data>
    <total_num>地址总数目</total_num >
    <addr>
        <id>地址 id</id>
        <list_id>分类ID</list_id>
        <address>邮件地址</address>
        <brithday>生日</brithday >
        <phone>手机</phone>
        <area> 地区 </area>
        <fullname>姓名</fullname >
        <time>添加时间</time>
        <var1>变量 1</var1>
        <var2>变量 2</var2>
        <var3>变量 3</var3>
        <var4>变量 4</var4>
        <var5>变量 5</var5>
        <var6>变量 6</var6>
        <var7>变量 7</var7>
        <var8>变量 8</var8>
        <var9>变量 9</var9>
        <var10>变量 10</var10>
    </addr>
    ...
</data>

添加分类地址(单个)

URL

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

HTTP请求方式 

POST

参数说明

参数 类型 必须 说明
list_id int 是 联系人分类ID
address string 是 邮箱地址
fullname string 是 姓名
var1,var2,...,Var10 string 否 变量1 - 变量10
sex string 否 性别：M/F, M表示男， F表示女
birthday date
(YYYY-MM-DD)		 否 生日，格式:0000-00-00
phone string 否 电话
area string 否 地区
return_id int 否 成功是否返回地址主键 id,0 不返回,1 返回

添加分类地址(批量)

URL

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

HTTP请求方式 

GET + POST

GET参数说明

参数 类型 必须 说明
list_id int 是 联系人分类ID
addr_type string 否 地址信息数据类型，默认为‘string’
separate string 否 每个地址信息之间的分隔符，默认为“\n”换行符，可以自定义任意字符。特别注意只在 addr_type 为 string 时生效

POST参数说明

参数 类型 必须 说明
ml_addr string 是 地址信息

地址信息ml_addr说明:

  1. 行行之间用换行符\n 隔开,同一行不同变量值之间用分号;分割
  2. 变量顺序: 邮箱地址;名称;性别;生日;手机;地区;变量 1; 变量 2; 变量 3; 变量 4; 变量 5; 变量 6; 变量 7; 变量 8;变量 9;变量 10
  3. 批量导入建议一次不要超过500, 如果超过500个，请用下面的文件导入

ml_addr示例如下: 

test1@bestdem.org;test1;M;1986-08-10;13528775968;北京;var1;var2;....var10;
test2@bestdem.org;test2;F;1986-08-10;13528775968;area;var1;var2;....var10;
test3@bestdem.org;test3;F;1986-08-10;13528775968;area;var1;var2;....var10;

说明：
邮箱地址;名称;性别;生日;手机;地区;变量 1; 变量 2; 变量 3; 变量 4; 变量 5; 变量 6; 变量 7; 变量 8;变量 9;变量 10（换行） 格式（一行一个地址信息）：
Coming1@bestdem.org;coming1;M;1986-08-10;13528775968;北京;var1;var2;....var10; test@bestdem.org; test;F;1986-08-10;13528775968;area;var1;var2;....var10;
行行之间用换行符\n 隔开,同一行不同变量值之间用分号;分割。适合批量添加，但数目不 建议超过 500 以上，如果超过 500 以上；建议用文件导入方式效率高。特别注意 \n 如果是代码拼接记得写成%0A,也就是 urlencode 后的值

添加分类地址(文件导入)

URL

http://www.bestedm.net/mm-ms/apinew/mloperate.php?do=ml-addr-add-file

HTTP请求方式 

GET + POST

GET参数说明

参数 类型 必须 说明
list_id int 是 联系人分类ID

POST参数说明

参数 类型 必须 说明
file file 是 文件信息

file文件信息说明

  1. 系统定时检测导入地址任务，自动过滤无效地址和重复地址。
  2. file是表单中的file类型, 支持文件格式(*.txt;*.xls;*.xlsx;*.csv;*.zip;*.rar),其中rar,zip为其它四种格式文件组成的压缩文件;
  3. file参考模板格式:导出csv模板 导出xls模板 导出txt模板 导出xlsx模板

html 表单示例:

<form method="post" action="http://www.bestedm.net/mm-ms/apinew/mloperate.php?do=ml-addr-add-file&list_id=418804" enctype="multipart/form-data">
    <input type="file" name="file" />
    <input type="submit" value="submit" />
</form>

文件导入记录查询

URL

http://www.bestedm.net/mm-ms/apinew/mloperate.php?do=ml-addr-add-log

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

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>success</status>
    <data>
        <address_log>
            <filename>文件名称</filename>
            <time_import>上传时间</time_import>
            <count_all>导入地址总量</count_all>
            <count_err_1>无效地址数</count_err_1>
            <count_err_2>重复的地址数</count_err_2>
            <status>导入的状态 1 成功、-1/-2/-3 失败</status>
            <subject>导入列表</subject>
        </address_log>
    ......
    </data>
</result>

删除单个分类地址

URL

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

HTTP请求方式 

GET

参数说明

参数 类型 必须 说明
id int 是 地址ID

清空联系人分类

URL

http://www.bestedm.net/mm-ms/apinew/mloperate.php?do=ml-addr-empty

HTTP请求方式 

GET

参数说明

参数 类型 必须 说明
list_id int 是 联系人分类ID