Contact Info Request - ApifyCloud Docs

Sends a message with WhatsApp’s Share Contact Info button. When the user taps it, WhatsApp shares their phone number in the chat. This is useful for users who show a username instead of their phone number.

This message can only be sent within the 24-hour customer service window. Outside that window, use a template with the Share Contact Info button instead. It is not available for every WhatsApp connection: if your app’s connection doesn’t support it, the request returns 400.

Request

Use type as interactive and set interactive.type to request_contact_info.

Field types

to: string (required) — phone number or WhatsApp user ID
type: string = interactive (required)
interactive: object (required)
interactive.type: string = request_contact_info (required)
interactive.body: object (required)
interactive.body.text: string (required)

Field behavior and limits

interactive.body.text is required, max 1024 characters.
The button text can’t be customized: WhatsApp shows it in the user’s language.
interactive.action is set automatically; any value you send is ignored.

{
  "to": "+573001112233",
  "type": "interactive",
  "interactive": {
    "type": "request_contact_info",
    "body": {
      "text": "To keep helping you, please share your phone number."
    }
  }
}

The user’s reply

When the user taps the button, their reply arrives in the conversation as a contacts message with the shared phone number. If the user shares someone else’s contact card instead, it arrives as a regular contacts message.