Zorya APIZorya API
  • Go to the Portal
  • Sign Up
  • Documentation
  • API Reference
  • Tables
  • WhatsApp Webhooks
  • Copyright © 2026 Zorya Telecom, S.A. de C.V.

Contacts

Contacts

This MO event type represents a contact message received from an end user. It is triggered when the user shares their contact information. The event is delivered to the client’s webhook endpoint and includes structured contact details, which are described in the following parameters and example.

Common Parameters

ParameterData TypeDescriptionRequired?
txIdStringTransaction identifier of the messageYes
eventIdStringEvent identifierYes
platformStringOrigin platform (e.g., CLU, SMS, META or RCS)Yes
eventTypeStringEvent category (e.g., MT, MO or NOTIFICATION)Yes
subtypeStringEvent subtype (e.g., text, reaction, interactive, multimedia, location, contact, unsupported)Yes
sourceEventTSDateTimeEvent timestampYes
contentStringBase64-encoded representation of the structured event contentYes

Event parameters with content base 64.

Code
{ "txId": "6ce710c5-b52b-4380-aed1-23d6a8f75c6c", "eventId": "evt-abc-20250516", "platform": "META", "eventType": "MO", "sourceEventTS": "2024-04-28T00:00:00.0000000", "subType": "contact", "content": "IlNlbmRlciI6ICJzdHJpbmciLAogICAgIk1zaXNkbiI6ICJzdHJpbmciLAogICAgIkNvbnRhY3ROYW1lIjogInN0cmluZyIsCiAgICAiTWVzc2FnZUNvbnRlbnQiOiB7CiAgICAgICJDb250YWN0IjogWwogICAgICAgIHsKICAgICAgICAgICJmaXJzdE5hbWUiOiAiSnVhbiIsCiAgICAgICAgICAibWlkZGxlTmFtZSI6ICJDYXJsb3MiLAogICAgICAgICAgImxhc3ROYW1lIjogIlDDqXJleiIsCiAgICAgICAgICAiZm9ybWF0dGVkTmFtZSI6ICJKdWFuIENhcmxvcyBQw6lyZXoiLAogICAgICAgICAgInN1ZmZpeCI6ICJKci4iLAogICAgICAgICAgInByZWZpeCI6ICJTci4iLAogICAgICAgICAgImNvbXBhbnkiOiAiRW1wcmVzYSBTLkEuIiwKICAgICAgICAgICJkZXBhcnRtZW50IjogIlZlbnRhcyIsCiAgICAgICAgICAidGl0bGUiOiAiR2VyZW50ZSIsCiAgICAgICAgICAiYmlydGhkYXkiOiAiMTk5MC0wNS0xNSIsCiAgICAgICAgICAiYWRkcmVzc2VzIjogWwogICAgICAgICAgICB7CiAgICAgICAgICAgICAgInN0cmVldCI6ICJBdi4gU2llbXByZSBWaXZhIiwKICAgICAgICAgICAgICAiY2l0eSI6ICJDRE1YIiwKICAgICAgICAgICAgICAic3RhdGUiOiAiQ0RNWCIsCiAgICAgICAgICAgICAgInppcCI6ICIxMjM0NSIsCiAgICAgICAgICAgICAgImNvdW50cnkiOiAiTcOpeGljbyIsCiAgICAgICAgICAgICAgInR5cGUiOiAiaG9tZSIKICAgICAgICAgICAgfQogICAgICAgICAgXSwKICAgICAgICAgICJlbWFpbHMiOiBbCiAgICAgICAgICAgIHsKICAgICAgICAgICAgICAiZW1haWwiOiAianVhbkBlbXByZXNhLmNvbSIsCiAgICAgICAgICAgICAgInR5cGUiOiAid29yayIKICAgICAgICAgICAgfQogICAgICAgICAgXSwKICAgICAgICAgICJwaG9uZXMiOiBbCiAgICAgICAgICAgIHsKICAgICAgICAgICAgICAicGhvbmUiOiAiKzUyMTIzNDU2Nzg5MCIsCiAgICAgICAgICAgICAgInR5cGUiOiAibW9iaWxlIiwKICAgICAgICAgICAgICAid2FJZCI6ICI1MjEyMzQ1Njc4OTAiCiAgICAgICAgICAgIH0KICAgICAgICAgIF0sCiAgICAgICAgICAidXJscyI6IFsKICAgICAgICAgICAgewogICAgICAgICAgICAgICJ1cmwiOiAiaHR0cHM6Ly9lbXByZXNhLmNvbSIsCiAgICAgICAgICAgICAgInR5cGUiOiAid2Vic2l0ZSIKICAgICAgICAgICAgfQogICAgICAgICAgXQogICAgICAgIH0KICAgICAgXQogICAgfQ==" }

Content Parameters

ParameterData TypeDescriptionRequired?
senderStringThe identifier of the senderYes
msisdnStringThe recipient's phone number in international formatYes
FromBsuidString?BSUID of the customer who sent the message. Omitted when empty. See UsernamesNo
contactNameString?Optional display name associated with the contactNo
messageContentObjectThe actual content of the message (text, image, etc.)Yes

The phone number is not guaranteed. When the customer talks to you over a WhatsApp username, Meta omits it and the identifier arrives in the BSUID property instead. Do not use the phone number as the primary key of the contact — see BSUID in Webhooks.

Message Content Parameter

PropertyData TypeDescriptionRequired?
contactObjectThe actual content of the contactsYes

Contact

PropertyData TypeDescriptionRequired?
firstNameStringContact's first nameYes
middleNameString?Contact's middle nameNo
lastNameString?Contact's last nameNo
formattedNameStringFull formatted name (e.g., "First M. Last")Yes
suffixString?Name suffix (e.g., "Jr.")No
prefixString?Name prefix (e.g., "Dr.")No
companyString?Company or organizationNo
departmentString?Department within the organizationNo
titleString?Job titleNo
birthdayDateTime?Birth dateNo
addressesObject?Object addressNo
emailsObject?Object EmailNo
phonesObject?Object PhoneNumberNo
urlsObject?Object URLNo
OriginString?How the customer shared their information: contact_request (they tapped the button of a Share contact info template) or other (they shared a contact card in the chat on their own). Omitted when empty.No

What arrives depends on Origin. With contact_request Meta sends the customer's phone number only — no vCard. The full contact card (name, company, phones, emails, addresses and URLs) arrives only with other. Do not build your process around fields that will not be there; the phone number does arrive in both cases. See BSUID in Webhooks.

Address

PropertyData TypeDescriptionRequired?
streetString?Street name or address lineNo
cityString?City nameNo
stateString?State or provinceNo
zipString?ZIP or postal codeNo
countryString?Country nameNo
typeString?Type of address (e.g., HOME, WORK)No

Email

PropertyData TypeDescriptionRequired?
emailString?Email addressNo
typeString?Email type (e.g., "PERSONAL", "WORK")No

Phone Number

PropertyData TypeDescriptionRequired?
phoneString?Phone numberNo
typeString?Phone type (e.g., "MOBILE", "HOME")No
waIdString?WhatsApp ID associated with the phone numberNo

URL

PropertyData TypeDescriptionRequired?
urlString?URL stringNo
typeString?URL type (e.g., "WORK", "SOCIAL", "PERSONAL")No

Event parameters without content base 64.

Code
{ "txId": "6ce710c5-b52b-4380-aed1-23d6a8f75c6c", "eventId": "evt-abc-20250516", "platform": "META", "eventType": "MO", "subtype": "contact", "sourceEventTS": "2025-05-16T12:30:00.0000000", "content":{ "sender": "521111111111", "msisdn": "521222222222", "contactName": "John", "messageContent":{ "contact": [ { "firstName": "John", "middleName": "A.", "lastName": "Doe", "formattedName": "John A. Doe", "suffix": "Sr.", "prefix": "Mr.", "company": "Example Corp", "department": "Engineering", "title": "Software Engineer", "birthday": "1985-01-15T00:00:00Z", "addresses": [ { "street": "123 Main St", "city": "Mexico Ciy", "state": "CA", "zip": "12345", "country": "Mexico", "type": "HOME" } ], "emails": [ { "email": "john.doe@example.com", "type": "PERSONAL" } ], "phones": [ { "phone": "5559876543", "type": "MOBILE", "waId": "5215559876543" } ], "urls": [ { "url": "https://example.com", "type": "SOCIAL" } ] } ] } } }
Code
Last modified on October 7, 2026
On this page
  • Contacts
  • Common Parameters
  • Event parameters with content base 64.
  • Content Parameters
  • Message Content Parameter
  • Contact
    • Address
    • Email
    • Phone Number
    • URL
  • Event parameters without content base 64.
JSON
JSON