Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-gif
Send GIF
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-gif \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "gif": "<string>"
}
'

​
Overview

Method responsible for sending GIFs to your chats through the API.
The file to be sent must be an MP4.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
phone
string
required
Recipient’s phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999
​
gif
string
required
GIF file link (the file must be an MP4)

​
Optional

​
caption
string
Message to send along with the GIF
​
messageId
string
Attribute used to reply to a chat message, just add the messageId of the message you want to reply to
​
delayMessage
number
Delay added to the message. You can choose between a range of 1 to 15 sec, meaning how many seconds it will wait before sending the next message. (E.g.: “delayMessage”: 5). The default delay if not provided is 1 to 3 sec

​
Request Body

By link: 
{
  "phone": "5511999999999",
  "gif": "https://example.com/file.mp4",
  "caption": ""
}
By Base64: 
{
  "phone": "5511999999999",
  "gif": "data:video/mp4;base64,AAYXJ0...",
  "caption": ""
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.