Request Contact Info

Within an active session window the button can only be sent as an interactive message of type request_contact_info.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sample Request:

curl --location 'https://qa-partner-api.smsgupshup.dev/partner/app/{{APP_ID}}/v3/message' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'content-type: application/json' \
--data '{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    
    "recipient": "{recipientId}",
    "type": "interactive",
    "interactive": {
        "type": "request_contact_info",
        "body": {
            "text": "Please share your phone number so we can reach you."
        },
        "action": {
            "name": "request_contact_info"
        }
    }
}'

Sample Response:

{
    "messages": [
        {
            "id": "6c786aad-b4e1-4351-92f6-bd4f1e832783"
        }
    ],
    "messaging_product": "whatsapp",
    "contacts": [
        {
            "input": "{recipientId}",
            "user_id": "{recipientId}"
        }
    ]
}


Path Params
uuid
required

Partner app id (UUID).

Body Params

Cloud API interactive message body. Forwarded to Meta byte-for-byte, so unlisted keys are
carried through and ignored rather than rejected.

string
enum
required

Always whatsapp.

Allowed:
string
enum
Defaults to individual

Recipient addressing mode.

Allowed:
string

Recipient phone in E.164 without +. Use this or recipient, not both. A BSUID
placed here is not resolved.

string

Recipient BSUID, for WABAs enabled for BSUID addressing. Use this or to. An
MSISDN placed here leaves the message with no addressee — accepted, then code: 100
with an empty recipient_id.

string
enum
required

Message type. Always interactive for this flow.

Allowed:
interactive
object
required

The interactive object. header and footer are optional; body and action are not.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json