订阅
用户可以在不使用注册表单或由其他用户添加的情况下订阅列表。他们可以使用我们的API身份验证令牌订阅,添加的用户将得到通知。
对于公开列表,您不能使用API更新已经存在的订阅者。
但是,您可以使用此API更新私有列表中现有订阅者的订阅者详细信息。
请求 URL
您可以选择在请求时使用XML(或)JSON格式。
XML: https://campaigns.zoho.com.cn/api/xml/listsubscribe
JSON: https://campaigns.zoho.com.cn/api/json/listsubscribe
请求类型: Post
参数列表
参数 | 数据类型 | 描述 |
authtoken* | 字符串 | API 身份验证令牌 |
listkey* | 字符串 | 向列表的订阅者发送订阅邮件的列表键。 |
version | 字符串 | 这将基于当前API版本获取响应 |
resfmt | 字符串 | XML (或) JSON |
contactinfo* | XML (或) JSON | 订阅者邮件与其它字段。该值的格式取决于请求URL。 |
sources | 字符串 | 可以添加订阅源。 |
* - 必填参数
示例请求:
XML:
https://campaigns.zoho.com.cn/api/xml/listsubscribe?authtoken=[API Authentication Token]&scope=CampaignsAPI&version=1&resfmt=[XML]&listkey=[listkey ]&contactinfo=<xml><fl val="First Name">mac</fl><fl val="Contact Email">jai@zoho.com</fl></xml>&sources=[sourceName]
JSON:
https://campaigns.zoho.com.cn/api/json/listsubscribe?authtoken=[API Authentication Token]&scope=CampaignsAPI&version=1&resfmt=[JSON]&listkey=[listkey ]&contactinfo={First Name:mac,Last Name:Last Name,Contact Email:jai@zoho.com}&sources=[sourceName]
示例响应:
我们的API响应将以XML或JSON格式让您了解以下内容。
XML 格式:
<response uri="/api/xml/listsubscribe" version="1">
<code>0</code>
<status>success</status>
<message>A confirmation email is sent to the user. User needs to confirm to successfully subscribe.</message>
</response>
JSON 格式:
{"message":"A confirmation email is sent to the user. User needs to confirm to successfully subscribe.","status":"success","code":"0","uri":"/api/json/listsubscribe","version":"1"}
可能出现的错误情况
错误代码 | 描述 |
2501 | Listkey is empty or invalid.. |
2004 | 用户电子邮件地址无效。 |
2005 | 群组电子邮件地址已添加。 |
2001 | 请输入正确的 XML(或)JSON 格式。 |
如果上面没有列出您遇到的错误代码,请单击这里。