获取用户列表
用户可以使用我们的API获得订阅列表。
请求 URL
您可以选择在请求时使用XML(或)JSON格式。
XML/ JSON:
https://campaigns.zoho.com.cn/api/getlistsubscribers
请求类型: Get/ Post
参数列表
参数 | 数据类型 | 描述 |
authtoken* | 字符串 | API 身份验证令牌 |
listkey* | 字符串 | 将订阅邮件发送到联系人的列表键。 |
version | 字符串 | 这将基于当前API版本获取响应。 |
resfmt | 字符串 | XML (或) JSON |
sort | 字符串 | asc/desc |
fromindex | 数字 | 以数字表示的数值。 |
range | 数字 | 以数字表示的数值。 |
status | 字符串 | active/ recent/ most recent/ unsub/ bounce. |
* - 必填参数
示例请求:
XML/ JSON:
https://campaigns.zoho.com.cn/api/getlistsubscribers?authtoken=[API Authentication Token]&scope=CampaignsAPI&listkey=[listkey]&sort=[asc/desc]&fromindex=[number]&range=[number]&status=[active/recent/mostrecent/unsub/bounce]&resfmt=[XML/JSON]
示例响应:
我们的API响应将以XML或JSON格式让您了解以下内容。
XML 格式:
<response uri="/api/getlistsubscribers" version="1">
<status>success</status>
<code>0</code>
<sort>Ascending Order</sort>
<range>5</range>
<status>active</status>
<fromindex>1</fromindex>
<list_details>
<fl val="ispublic">true</fl>
<fl val="noofcontacts">960</fl>
<fl val="listname">100</fl>
</list_details>
<result_of_subscribers>
<contact>
<fl val="phone"/>
<fl val="firstname"/>
<fl val="zuid">4158867</fl>
<fl val="contact_email">user4800@thandora.com</fl>
<fl val="companyname"/>
<fl val="lastname"/>
</contact>
<contact>
<fl val="phone"/>
<fl val="firstname"/>
<fl val="zuid">4158867</fl>
<fl val="contact_email">user4449@thandora.com</fl>
<fl val="companyname"/>
<fl val="lastname"/>
</contact>
<contact>
<fl val="phone"/>
<fl val="firstname"/>
<fl val="zuid">4158867</fl>
<fl val="contact_email">user4448@thandora.com</fl>
<fl val="companyname"/>
<fl val="lastname"/>
</contact>
<contact>
<fl val="phone"/>
<fl val="firstname"/>
<fl val="zuid">4158867</fl>
<fl val="contact_email">user4447@thandora.com</fl>
<fl val="companyname"/>
<fl val="lastname"/>
</contact>
<contact>
<fl val="phone"/>
<fl val="firstname"/>
<fl val="zuid">4158867</fl>
<fl val="contact_email">user4445@thandora.com</fl>
<fl val="companyname"/>
<fl val="lastname"/>
</contact>
</result_of_subscribers>
</response>JSON 格式:
{"requestdetails":{"sort":"Ascending Order","range":5,"status":"active","fromindex":1},"status":"success","list_of_details":[{"phone":"","zuid":"4158867","contact_email":"user4800@thandora.com","lastname":"","firstname":"","companyname":""},{"phone":"","zuid":"4158867","contact_email":"user4449@thandora.com","lastname":"","firstname":"","companyname":""},{"phone":"","zuid":"4158867","contact_email":"user4448@thandora.com","lastname":"","firstname":"","companyname":""},{"phone":"","zuid":"4158867","contact_email":"user4447@thandora.com","lastname":"","firstname":"","companyname":""},{"phone":"","zuid":"4158867","contact_email":"user4445@thandora.com","lastname":"","firstname":"","companyname":""}],"code":"0","uri":"/api/getlistsubscribers","version":"1"}
可能出现的错误情况
错误代码 | 描述 |
1004 | 无法找到您正在寻找的资源。请重新检查文件并重试。 |
2704 | 没有足够的权限访问其他用户的邮件列表。 |
2701 | 没有足够的权限访问您的邮件列表。 |
2501 | Listkey为空或无效。 |
2203 | 此列表已被删除。 |
2502 | 显示订阅者详细信息时出错。请稍后再试。 |
如果上面没有列出您遇到的错误代码,请单击这里。