Send link
Method#
/send-link#
POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/send-link
Header#
| Key | Value |
|---|---|
| Client-Token | ACCOUNT SECURITY TOKEN |
Concept#
Method responsible for sending links to your contacts, it is used to share links so that the user can be redirected to a website.
About links
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.
Attributes#
Required#
| Attributes | Type | Description |
|---|---|---|
| phone | string | Recipient (or group ID in case you want to send it to a group) telephone number in the format DDI DDD NUMERS Ex: 551199999999. IMPORTANT only send numbers without formatting or a mask |
| message | string | Text about your link. Don’t forget to inform the same value of the linkURL at the end of this text. |
| image | string | Images link |
| linkUrl | string | Links URL |
| title | string | Title for your link |
| linkDescription | string | Links description |
Opcionais#
| Attributes | Type | Description |
|---|---|---|
| messageId | String | Attribute used to answer a chat message. All you have to do is add the messageID of the message that you want to respond to this attribute |
| delayMessage | number | In this attribute a delay is added to the message. You can decide between a range of 1 - 15 secs (this is for how many seconds it will wait to send the next message EX: “delayMessage”:5,). The default delay is between 1 - 3 secs. |
Request Body#
Response#
200#
| Attributes | Type | Description |
|---|---|---|
| zaapId | string | id on z-api |
| messageId | string | id on whatsapp |
Example
405#
In this case certify that you are sending the correct specification of the method. This means, verify if you sent a POST or GET as specified at the beginning of this topic.
415#
In case you receive 415 error, make sure to add the “Content-Type” of the object you are sending in the request headers, mostly “application/json”
Webhook Response#
Link for webhooks response (upon receiving)