联系人

查询联系人状态

查询联系人是否存在于渠道账号的联系人列表。WhatsApp 必须传入联系人接口在 conversation_id 中返回的 LID；is_in_contacts=false 仍是成功的 200 结果，不是未找到错误。

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/contacts/membership

调用前准备

在服务端使用资源所属工作区的 X-Api-Key。运行示例前替换所有占位符。

参数从哪里取得

account_id: 从创建或查询账号的响应取得 data.id。账号标识属于 X-Api-Key 对应的工作区。获取账号
contact_id: 要查询联系人状态的标识。WhatsApp 必须传入联系人接口在 conversation_id 中返回的 LID，并对 query string 中的 @ 做 URL 编码。

请求参数

请求头

X-Api-Key

string必填

工作区 API Key，工作区由该请求头解析得到。

路径参数

account_id

string必填

用于该 contacts 路由的标识符。

查询参数

contact_id

string必填

要查询联系人状态的标识。WhatsApp 必须传入联系人接口在 conversation_id 中返回的 LID，并对 query string 中的 @ 做 URL 编码。

请求体

该接口无需 JSON 请求体。

如何理解结果

按文档解释响应字段和 HTTP 状态。204 成功响应没有响应体，排查时使用 X-Request-Id。下一步操作见相关链接。

响应 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "contact_id": "123456789012345@lid",
    "is_in_contacts": true
  }
}

响应体

contact_id

string

本次联系人状态查询使用的标识。

is_in_contacts

boolean

是否存在于目标账号的渠道联系人列表；false 是成功的否定结果。

响应

200

200 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 是否正确、工作区是否有效。