联系人
列出联系人
实时列出账号通讯录。limit 范围 1..100，默认 50；cursor 不透明，失效或伪造值由各渠道分别处理。q 匹配 display_name / phone / username，updated_since（RFC3339）在渠道支持时用于增量同步。
https://api.unifyport.ai/v1/accounts/{account_id}/contacts调用前准备
在服务端使用资源所属工作区的 X-Api-Key。运行示例前替换所有占位符。
参数从哪里取得
- account_id
- 从创建或查询账号的响应取得 data.id。账号标识属于 X-Api-Key 对应的工作区。 获取账号
请求参数
请求头
X-Api-Key工作区 API Key，工作区由该请求头解析得到。
路径参数
account_id用于该 contacts 路由的标识符。
查询参数
cursor上一响应的 next_cursor。省略或留空从第一页开始；失效或伪造游标在不同渠道上的处理不统一。
limit单页数量范围 1..100；各列表接口的默认值见对应页面说明。
minimum: 1 · maximum: 100
q匹配 display_name、phone 或 username 的搜索过滤条件。
updated_sinceRFC3339 时间戳；仅返回此后有更新的联系人，在渠道支持时用于增量同步。
format: date-time
请求体
该接口无需 JSON 请求体。
如何理解结果
按文档解释响应字段和 HTTP 状态。204 成功响应没有响应体，排查时使用 X-Request-Id。下一步操作见相关链接。
响应 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"items": [
{
"id": "user_example",
"conversation_id": "peer_example",
"display_name": "Alice",
"avatar_url": "",
"provider_user_id": "user_example",
"extra": {
"phone": "8600000000000"
}
}
],
"next_cursor": "",
"has_more": false
}
}
响应体
id联系人标识。
conversation_id该联系人的会话标识，用于发送消息或定位聊天。
display_name联系人显示名，缺失时为空字符串。
avatar_url联系人头像 URL，缺失时为空字符串。
provider_user_id联系人在渠道侧的用户标识。
is_blocked该联系人是否已被当前账号屏蔽。
extraobject渠道专属的额外字段，例如 phone。
extra渠道专属的额外字段，例如 phone。
phoneWhatsApp phone JID 中解析出的纯手机号。
first_name当前账号通讯录中保存的联系人简称或名字部分。
full_name当前账号通讯录中保存的完整联系人名称。
push_name联系人自行在 WhatsApp 设置的个人名称。
business_nameWhatsApp Business 账号的商业或认证名称。
redacted_phoneProvider 仅返回部分号码时的遮蔽手机号。
next_cursor指向下一页的不透明游标，回传作为 cursor 使用；空字符串表示没有更多页。
has_more当本页之外还有更多结果时为 true。
响应
200200 OK
请求成功，响应体示例如上。
400请求错误
请求体、路径或参数不合法。
401未授权
X-Api-Key 请求头缺失或无效。
409冲突
当前操作与已有的渠道账号或资源冲突。
500服务端错误
服务端遇到了未预期的错误。
501渠道未实现
所选渠道尚未实现该操作。
502上游网关错误
渠道适配器或上游渠道未能完成该操作。
失败后怎么处理
检查 HTTP 状态和 error.code/numeric_code，保存 request_id 用于排查。按原因修正参数、继续授权或检查运行态。重试发送及其他写操作前先确认上一次结果，避免重复操作。 错误码参考
- invalid_request · 10000 · 400
- 检查必填字段、格式和渠道条件，修正请求后再调用。
- invalid_api_key · 11001 · 401
- 检查 X-Api-Key 是否正确、工作区是否有效。