Skip to content

docs: add phone-number pairing example#343

Closed
hsnyvsh wants to merge 2 commits into
rmyndharis:mainfrom
hsnyvsh:docs-phone-number-pairing
Closed

docs: add phone-number pairing example#343
hsnyvsh wants to merge 2 commits into
rmyndharis:mainfrom
hsnyvsh:docs-phone-number-pairing

Conversation

@hsnyvsh

@hsnyvsh hsnyvsh commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a dedicated phone-number pairing example for linking an existing WhatsApp account to an OpenWA session.
  • Document the create → start → pairing-code flow with curl examples.
  • Clarify the required phoneNumber format and that this flow does not create/register a new WhatsApp account.
  • Link the example from the documentation index.

Context

Related to #282.

The project already supports POST /api/sessions/{sessionId}/pairing-code, but the flow is not easy to discover from the documentation. This PR documents the supported “link by phone number” flow and separates it from out-of-scope WhatsApp account registration.

Testing

Not run. Documentation-only change.

rmyndharis added a commit that referenced this pull request Jun 19, 2026
* fix(webhook): deliver session lifecycle events and key webhook hardening (#335)

* fix(security): pin outbound webhook and media fetches to validated IP (#338)

* fix(plugins): persist plugin enable/config and restore (#339)

* fix(message): persist bulk-sent messages, sanitize SSRF (#340)

* fix(engine): return the real id for forwarded messages (#341)

* fix(security): harden outbound requests, IPv6 SSRF (#344)

* fix(security): secret-file perms, key pepper, allowedIps (#345)

* fix(storage): bound tar imports, contain storage keys (#346)

* fix(session): reconcile late acks, serialize reactions (#348)

* fix(contract): webhook timeout, bounded shutdown, 501 (#350)

* feat(session): force-kill a stuck session (#352)

* merge #343

* merge #351

* chore(release): v0.4.3 — CHANGELOG, version bump (package.json/dashboard/swagger), README + docs
@rmyndharis

Copy link
Copy Markdown
Owner

Shipped in v0.4.3 (integrated via the release PR #354 and tagged v0.4.3). Thanks! 🎉

@rmyndharis rmyndharis closed this Jun 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants