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

Overview

In this topic we’ll talk about how to reply to a message directly! When you use the send-text method there is an optional attribute called messageId, this attribute receives the Id of any message. When this attribute is provided, your message will be directly related to the message of the informed Id.

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
message
string
required
Text to be sent
messageId
string
required
Original message ID you want to reply to

Optional

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
privateAnswer
boolean
For group messages, defines whether the reply will be sent to the group or privately to the sender (cannot be yourself)

Request Body

{
  "phone": "5511999999999",
  "message": "Welcome to *Z-API*",
  "messageId": "3999984263738042930CD6ECDE9VDWSA"
}

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”.