Answer Messages
Method#
/send-text#
POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/send-text
Header#
| Key | Value |
|---|---|
| Client-Token | ACCOUNT SECURITY TOKEN |
Concept#
In this topic we will talk a little about how to respond to a text directly.
When you use the send-text method there is an optional attribute called messageId, this is an attribute that receives the Id of any message, when this attribute is passed, your message will be directly related to the message of the informed Id.
tip
If you have any questions about how to send a text message, you can read about it in our Send plain text thread
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 to be sent |
| messageId | 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 |
Optionals#
| Attributes | Type | Description |
|---|---|---|
| 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. |
| privateAnswer | boolean | In the case of a group message, define whether the response will be sent to the group or to the sender's private address (it cannot be yourself). If the sender is yourself, the "privateAnswer" attribute will be ignored, sending the response in the group itself. |
Request Body#
Response#
200#
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)