1MSG

Request the user's phone number

POST
/sendContactInfo

Send a service-window interactive message that asks the WhatsApp user to share their phone number (REQUEST_CONTACT_INFO).

Use this when you only know the user by BSUID and the 24-hour customer service window is open. body is the text above the button. This method has no separate button label — WhatsApp sets that.

Outside that window, create a UTILITY or MARKETING template with a REQUEST_CONTACT_INFO button via POST /addTemplate (do not send text on the button) and send it with POST /sendTemplate. That button has no send-time parameters.

When the user shares the number, the inbound webhook is a contacts message with origin: contact_request. The phone is stored on the same BSUID, and the message is written to history.

Authorization

JWT token
querytoken<token>

Request Body

application/json
  1. body
body*string

Text shown above the share-contact button.

Length1 <= length <= 1024
phone?string

Recipient phone with country code. Use phone, chatId, or bsuid.

chatId?string

Recipient chat ID ([email protected], BSUID @lid, or username @username).

bsuid?string

Business-scoped user id, for example US.13491208655302741918.

Response Body

Server response example

application/json
  1. response
sent?boolean
id?string

unique message id

message?string

Posting status message

description?string

Result description

curl -X POST 'https://api.1msg.io/123/sendContactInfo' \  -H 'Content-Type: application/json' \  -d '{  "bsuid": "US.13491208655302741918",  "body": "Please share your phone number so we can reach you."}'
{  "sent": true,  "id": "gBGGeRhGZTEfAgkJCh2wAz4ZH-8",  "message": "Sent to [email protected]",  "description": "Message has been sent to the provider"}