WA Lookup workflow illustration for 集成 WA Lookup:自动化 CRM 数据清洗与账户分类
本文所述流程的可视化概览。

了解如何集成同步 WA Lookup API,以验证 WhatsApp 账户的存在性、获取头像详情并对商业账户进行分类,从而实现 CRM 数据清洗。

WA Lookup API 使 CRM 系统能够同步验证 WhatsApp 账户的存在性。通过向 /api/v1/check 端点发送带有 E.164 格式电话号码的 POST 请求,开发人员可以在同一个 HTTP 响应中获取注册状态、头像可用性或商业账户分类。这些数据有助于通过识别有效的 WhatsApp 关联记录来维护 CRM 清洗,而无需异步处理、轮询或 Webhook。

了解 WA Lookup API 架构

将账户存在性信号集成到 CRM 中需要一种支持即时数据路由和决策的架构。WA Lookup API 围绕单个同步端点设计:POST /api/v1/check。 当 CRM 系统或数据操作平台提交请求时,API 会处理该检查并在同一个 HTTP 响应中交付结果。这种同步架构消除了与异步处理相关的工程开销,例如配置 Webhook、管理回调 URL 或实现轮询逻辑。开发人员可以将 API 直接集成到同步工作流中,例如潜在客户录入表单或实时数据清洗管道。 每个检查响应都包含一组标准字段,用于为内部决策提供信息:ididentifierregisteredtransaction_idstatusservice_typecharged_amount_micros。这些字段提供了立即更新 CRM 记录所需的上下文。需要注意的是,这些响应严格属于账户存在性信号。API 仅报告检查时可用的状态字段;它不会检查在线状态、最后上线活动、消息历史记录或联系人可达性。

分类 WhatsApp 账户类型

为了支持不同的 CRM 数据清洗需求,API 提供了三种不同的服务类型。这三种产品均使用相同的同步端点,其中 service_type 参数控制响应中返回的具体字段以及适用于该交易的余额成本。

服务类型对比

服务类型 主要功能 返回字段
ws 平台注册信号 registered
ws_avatar 个人资料丰富化与头像可用性 registered, avatar (布尔值), avatar_url (字符串,若可用)
ws_business 商业资料信号 registered, business (布尔值)

WhatsApp 检查器 (ws) 是基础服务类型。它仅用于确认提交的电话号码是否在 WhatsApp 上注册,仅返回 registered 字段。这通常用于基础列表清理,并识别哪些 CRM 联系人在该平台上有账户存在。 WhatsApp 头像检查器 (ws_avatar) 通过增加个人资料丰富化功能扩展了基础检查。除了注册状态外,它还会返回一个 avatar 布尔值(指示是否设置了头像)以及一个 avatar_url 字符串。该 URL 仅在上游服务提供时才会出现。此信号可帮助团队审查联系人资料的完整性。 WhatsApp 商业检查器 (ws_business) 专为 B2B CRM 分段设计。它检查 WhatsApp 注册情况,并返回一个 business 布尔值,指示该账户是否使用 WhatsApp Business。这允许数据操作经理在数据库中将个人账户与商业账户进行分段。

技术实现与数据清洗

将 API 集成到 CRM 或数据管道中需要遵守已记录的请求契约。API 需要 JSON 有效负载和特定的标头来成功验证并处理请求。 已记录的请求契约要求向 /api/v1/check 发送 POST 请求。请求必须包含两个标头:包含您的身份验证密钥的 X-API-Key,以及 Content-Type: application/json。 JSON 正文必须包含两个字段:

  1. service_type:字符串值,为 wsws_avatarws_business
  2. identifier:要检查的电话号码。 至关重要的是,所有提交的电话号码必须按照 E.164 国际电话编号计划进行格式化。例如,美国号码必须提交为 +1234567890。未能使用 E.164 格式可能会导致解析错误或检查结果不确定。 标准的 JSON 正文如下所示: {"service_type": "ws_business", "identifier": "+1234567890"} 通过将 CRM 输入标准化为 E.164 并通过此同步检查进行路由,开发人员可以自动标记无效号码、对商业用户进行分段并保持高标准的数据清洗。由于响应是即时的,这些检查可以直接集成到数据录入表单中,确保只有经过验证的账户存在性信号才会被提交到数据库。

仪表板报告与账户管理

API 使用管理和数据清洗操作监控通过平台仪表板进行处理。仪表板为 CRM 管理员和开发人员提供了全面的工具,用于跟踪集成的性能并管理身份验证。 仪表板支持完整的 API 密钥管理,允许团队安全地轮换密钥。为了进行操作监督,它提供了当前账户余额、详细检查历史记录和产品级报告的可见性。管理员可以查看最近的检查、监控余额支出并分析 7 天趋势,以了解 API 在不同 CRM 工作流中的使用情况。 该服务采用严格的按次计费模式。API 响应中的 charged_amount_micros 字段指示应用于该特定交易的成本,该成本根据所选的 service_type 而有所不同。为确保团队仅为可操作的数据付费,任何失败或不确定的检查都会自动退还到账户余额中。对于希望在部署到生产环境之前测试集成并验证 E.164 格式逻辑的开发人员,新账户可以领取 0.10 美元的试用余额,适用于注册、头像和商业账户检查。

常见问题解答

WA Lookup API 是同步还是异步的?

WA Lookup API 严格同步。当向 POST /api/v1/check 端点提交请求时,结果会在与请求相同的 HTTP 响应中返回。

该 API 能验证用户当前是否在线吗?

不能。注册结果仅报告检查时可用的 WhatsApp 状态字段。它仅作为账户存在性信号,不会检查在线状态、最后上线时间戳、消息历史记录、联系人许可或该号码当前是否可被联系。

ws、ws_avatar 和 ws_business 服务类型之间有什么区别?

这三种服务类型使用相同的同步端点,但返回不同的字段。ws 服务类型确认基本的 WhatsApp 注册情况。ws_avatar 服务类型返回注册状态以及头像布尔值和头像 URL(如果上游服务提供)。ws_business 服务类型返回注册状态和一个布尔值,指示该账户是否使用 WhatsApp Business。

参考来源