Sending options list
Method#
/send-option-list#
POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/send-option-list
Header#
| Key | Value |
|---|---|
| Client-Token | ACCOUNT SECURITY TOKEN |
ATTENTION
The list of options functionality no longer works in groups. This limitation occurs because the feature was discontinued by WhatsApp itself for group chats. In individual conversations, the list of buttons continues to function normally.
Concept#
In this method you will be able to send text messages with a list of options where the user will be able to choose one of the options sent.
Atributes#
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 |
| optionList | optionList | List’s configuration |
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. |
Option List#
| Attributes | Type | Description |
|---|---|---|
| title | string | Listing title |
| options | option | Options list |
| buttonLabel | string | Button text that opens the list |
Option#
| Attributes | Type | Description |
|---|---|---|
| description | string | Option’s description |
| title | string | Options title |
Opcionais Button#
| Attributes | Type | Description |
|---|---|---|
| id | string | Identificador da opção |
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)