API: AddressBook/Mail/Unsubscribe - 郵件退訂
概覽
addressbook/mail/unsubscribe 是 SUBMAIL 的郵件退訂 API ，使用 addressbook/mail/unsubscribe API 管理你的郵件退訂用戶。
URL
<主> https://api.mysubmail.com/addressbook/mail/unsubscribe
<備> https://api.submail.cn/addressbook/mail/unsubscribe
支持格式
| 格式 | URL |
|---|---|
json | https://api.mysubmail.com/addressbook/mail/unsubscribe.json（默認(rèn)） |
xml | https://api.mysubmail.com/addressbook/mail/unsubscribe.xml |
http 請(qǐng)求方式
POST
是否需要授權(quán)
是
參閱 API 授權(quán)和驗(yàn)證機(jī)制
請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的郵件應(yīng)用ID |
address | string | 必需 | 無 | 聯(lián)系人郵件地址 e.g. leo 或 或 leo@submail.cnSUBMAIL 支持完整的 RFC 822 收件人標(biāo)準(zhǔn)，請(qǐng)確保您的郵件地址的有效性。 請(qǐng)參見 維基百科 EMAIL ADDRESS RFC822 文檔 |
target | string | 可選 | unsubscribe | 地址簿標(biāo)識(shí)，將聯(lián)系人從目標(biāo)地址簿移除 忽略此參數(shù)，SUBMAIL 默認(rèn)將聯(lián)系人添加到退訂地址簿。 請(qǐng)參見 獲取項(xiàng)目或地址簿的開發(fā)者標(biāo)識(shí) |
timestamp | UNIX 時(shí)間戳 | 必需 | 無 | 參閱 API 授權(quán)與驗(yàn)證機(jī)制 > Timestamp UNIX 時(shí)間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式（ md5 or sha1 or normal ）參閱 API 授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
signature | string | 必需 | 無 | 應(yīng)用密匙 或 數(shù)字簽名 參閱 API 授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
代碼示例
添加一個(gè)郵件聯(lián)系人到退訂地址簿
POST
https://api.mysubmail.com/addressbook/mail/unsubscribe.jsonPOST Data
appid=your_app_id
&address=leo@submail.cn
&signature=your_app_key返回
{
"status":"success"
}從目標(biāo)地址簿移除一個(gè)郵件聯(lián)系人
POST
https://api.mysubmail.com/addressbook/mail/unsubscribe.jsonPOST Data
appid=your_app_id
&address=leo@submail.cn
?=ThJBE4
&signature=your_app_key返回
{
"status":"success"
}使用 CURL 添加一個(gè)郵件聯(lián)系人到退訂地址簿
發(fā)送 CURL
curl -d 'appid=your_app_id&address=leo@submail.cn&signature=your_app_key' https://api.mysubmail.com/addressbook/mail/unsubscribe.json返回
{
"status":"success"
}使用 CURL 從目標(biāo)地址簿移除一個(gè)郵件聯(lián)系人
發(fā)送 CURL
curl -d 'appid=your_app_id&address=leo@submail.cn?=ThJBE4&signature=your_app_key' https://api.mysubmail.com/addressbook/mail/unsubscribe.json返回
{
"status":"success"
}返回值
請(qǐng)求成功
{
"status":"success"
}請(qǐng)求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}