Skip to main content

Respond to Status with GIF

Method#

/reply-status-gif#

POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/reply-status-gif

Header#

KeyValue
Client-TokenACCOUNT SECURITY TOKEN

Concept#

Method responsible for sending a gif response to a status.


Attributes#

Required#

AttributeTypeDescription
phoneStringPhone number of the person who sent the status
gifStringLink to your GIF file (The file needs to be an mp4)
statusMessageIdStringStatus message ID. It can be obtained from the received message webhook -> webhook

Request Body#

URL#

Method

POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/reply-status-gif

Body#

{
"phone": "5544999999999",
"gif": "https://file-examples.com/storage/fe88505b6162b2538a045ce/2017/04/file_example_MP4_480_1_5MG.mp4",
"statusMessageId": "1F606398F2ECAA4846269F659B6003A9"
}

Response#

200#

AttributeTypeDescription
zaapIdstringid in z-api
messageIdstringid in WhatsApp
idstringAdded for compatibility with Zapier, it has the same value as messageId

Example

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

405#

In this case, ensure you are sending the method specification correctly. Check if you sent POST or GET as specified at the beginning of this topic.

415#


Code#