Get whatsapp link
well_get_whatsapp_linkRead the WhatsApp number linked to a Well login: the masked number, the workspace it was proven in, whether WhatsApp reaches that person in this workspace, and the link that opens the WhatsApp chat with Well. Call it when the user asks whether their WhatsApp is connected, which number is linked, or before well_delete_whatsapp_link when they want to check what would be unlinked.
Omit person_id for the user's own link. An owner or admin may pass a member's person_id to read the number that member proved in this workspace; anyone else is refused.
The result is linked false with link null when no number is linked; phone_on_file then says whether the person has a number on file to link. reached_from_another_workspace true means the member's number still reaches this workspace through a link they proved in another workspace: an unlink here does not stop it, so say so before an owner or admin unlinks.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| person_id | No | The person whose link to read, for an owner or admin asking about another member. Omit it for the user's own link. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| link | No | The linked number; null when none is linked. Absent on failure. | |
| error | No | ||
| linked | No | Whether a WhatsApp number is linked. Absent on failure. | |
| success | Yes | ||
| phone_on_file | No | Set only when no number is linked: whether the person has a phone number on file that a link would prove. Never write the number or say where it came from. Absent on failure. | |
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. | |
| reached_from_another_workspace | No | The member's number reaches this workspace through a link proven in another workspace; unlinking here leaves that reach. Absent on failure. |