API Reference

Request recipient contact information

post
https://live-mt-server.wati.io//api/v1/sendInteractiveRequestContactInfoMessage

Retained legacy exception: Request WhatsApp contact information, currently absent from V3 interactive sends.

Request WhatsApp contact information, currently absent from V3 interactive sends.

Provide target or whatsappNumber. This asks the recipient to share information; it does not silently retrieve a phone number. Availability depends on WhatsApp/Meta eligibility and account support. Delivery is asynchronous; use message-status webhooks. Do not automatically resend after an unknown outcome.

Permissions

For API access tokens and OIDC tokens, satisfy at least one of: api, wati_integration:write, conversations:write. Legacy JWTs do not use this scope check. Allowed roles: DEVELOPER, ADMINISTRATOR, EXTERNAL_ADMINISTRATOR, PARTNER_ADMINISTRATOR, AI_OPERATOR or API_TOKEN or TRIAL. FLEXI_TRIAL and FLEXI_PAID are denied even with another listed role. Workspace and billing restrictions also apply. WhatsApp and Meta/account eligibility, a valid customer-service session, and channel access are required.

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

Workspace ID; use the regional API host and matching workspace credential.

Query Params
string

Recipient phone number with country code; required unless target is provided.

string

Recipient phone, contact ID or supported BSUID; takes precedence over whatsappNumber.

string

Sending WhatsApp channel number, not the recipient phone or channel ID.

Body Params
string
required
length between 1 and 1024

Prompt displayed in the contact-sharing request.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized; a JSON body is not guaranteed.

403

Access denied by scopes, roles, workspace or billing; a JSON body is not guaranteed.

429

Rate or usage limit exceeded.

Updated about 1 hour ago

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

Updated about 1 hour ago