列出联系人

返回分页的联系人列表。

不传 pageAfter 时继续使用现有页码分页。使用向前游标分页时,第一页传 pageAfter=0,后续请求原样传入上一页响应的 cursor.after。游标模式按联系人 ID 升序返回结果。

pageAfter 不得与 pagepageBeforeoffsetsort 混用。沿游标翻页时必须保持所有过滤条件不变。并发新增、删除联系人或更新过滤字段时采用弱一致性;需要重新获取完整最新结果时,应从 pageAfter=0 开始新的遍历。

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
1 to 100
Defaults to 1

要返回结果的页号,从1开始。

int32
1 to 100
Defaults to 10

要返回的结果数量限制,或每页结果数,在1和100之间,默认为10。

boolean
Defaults to false

是否在包含总结果数的对象内返回结果。

string
^[0-9]+$

联系人向前分页的 Contact ID 游标。开始新的游标遍历时传 0;后续每一页原样传入上一页响应中的 cursor.after
该值必须是有符号 64 位整数范围内(09223372036854775807)的非负十进制整数,且不得与 pagepageBeforeoffsetsort 混用。

string

逗号分隔的标签名称列表。如果任一入参 tag 不存在,请求会抛出参数异常。

string

两位国家缩写。请参阅ISO 3166-1 alpha-2 country code

string

电话号码,需为E.164格式

string

联系人的电子邮件地址。

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json