Contact information request

Last update: 6 hours ago by Irais Aguirre

Integration summary
Endpoint: POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging
Token: messaging token, in the Authorization: Bearer {{wa-msg-api-token}} header (how to generate it)
Common fields: from, to (phone number or BSUID) and type (details)
type values on this page: "interactive"
Response: the same for every message (see response)

Messages with a button that lets users share their contact information with the business. They are sent with POST /v1/messaging; headers, common fields and the response are in HTTP connection.

Contact information request

The type field must be "interactive" and the message content is sent in the request_contact_info object. See the general structure of interactive messages.

Body

Fields for Contact information request:

Name	Description	Type	Requirements
request_contact_info	Object for asking the user to share their contact information.	Object	Required if you're sending a contact information request.

Request contact info object

Name	Description	Type	Requirements
body	Message text that accompanies the request for the user to share their contact information.	String	Required.

Example

Complete Contact information request example (HTTP request and JSON body):

Contact information request HTTP request

curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "interactive",
    "request_contact_info": {
        "body": "To follow up on your request, please share your contact information with us."
    }
}'

Contact information request body

{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "interactive",
    "request_contact_info": {
        "body": "To follow up on your request, please share your contact information with us."
    }
}

Call to action (URL)

WhatsApp Flows