Skip to content

InboxWebhookMessageSender.md

Latest commit

 

History

History
36 lines (30 loc) · 2.56 KB

InboxWebhookMessageSender.md

File metadata and controls

36 lines (30 loc) · 2.56 KB
Raw

Zernio::InboxWebhookMessageSender

Properties

Name Type Description Notes
id String Sender's platform identifier. For WhatsApp this is the phone number (without leading `+`) when available, otherwise the `businessScopedUserId`. For other platforms, the platform's own user ID.
contact_id String Zernio CRM Contact id for this sender, when one exists (joined via the ContactChannel mapping). Lets integrators link a message straight to a Contact without a follow-up Contacts API call. Omitted when the sender isn't a tracked contact (e.g. outgoing messages where the sender is the business, or first-touch messages before the contact is created). [optional]
name String [optional]
username String [optional]
picture String [optional]
phone_number String WhatsApp only. Sender's phone number in E.164 format (with leading `+`). Nullable during the BSUID rollout (April 2026+). WhatsApp users who adopt a username can message businesses without exposing a phone number — this field is omitted for them. Match by `businessScopedUserId` instead. See `docs/whatsapp-bsuid-migration.md`. [optional]
business_scoped_user_id String WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical identifier for a WhatsApp user within your business. Present when Meta includes it in the inbound payload (rollout in progress since early April 2026). Recommended primary identity anchor going forward; fall back to `phoneNumber` only when this field is absent. [optional]
parent_business_scoped_user_id String WhatsApp only. Parent BSUID for businesses with linked business portfolios. Omitted for standalone portfolios. [optional]
whatsapp_username String WhatsApp only. User's WhatsApp username (e.g. `@jane`). Not a stable identifier — users can change it. Useful for display, not recommended as an identity anchor. [optional]
instagram_profile InboxWebhookMessageSenderInstagramProfile [optional]

Example

require 'zernio-sdk'

instance = Zernio::InboxWebhookMessageSender.new(
  id: null,
  contact_id: null,
  name: null,
  username: null,
  picture: null,
  phone_number: null,
  business_scoped_user_id: null,
  parent_business_scoped_user_id: null,
  whatsapp_username: null,
  instagram_profile: null
)