API Reference

📎 Send link preview message

post
https://gate.whapi.cloud/messages/link_preview

Method responsible for sending links with customize preview to your contacts, it is used to share links so that the user can be redirected to a website. Your link must necessarily be in the Body parameter. It is important for you to know that the link is only clickable if the recipient already has your phone number in their contacts, or if they start a conversation with you

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

Message link preview send parameters

string
required

Use the phone number or Chat ID of the contact/group/channel to which you want to send the message. Use Get groups to get the group ID.

string

Message ID of the message to be quoted

string

Message ID of the message to be edited

string
required

Message text

string
required

Title of the link

string

Description of the link

string

Canonical URL of the link (for example, if the link is shortened)

string

Base64 encoded image for mini version link preview. In JPEG format

string

Mime type of media

boolean

Do not use our encoding

boolean

Do not use the cache in a request

mentions
array of strings

The numbers of the mentioned users

mentions
Responses

Updated about 2 years ago

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

Updated about 2 years ago