Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
send-option-list
curl --request POST \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/send-option-list \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "{{PHONE}}",
  "message": "Selecione e melhor opção:",
  "optionList": {
    "title": "Opções disponíveis",
    "buttonLabel": "Abrir lista de opções",
    "options": [
      {
        "id": "1",
        "description": "WA Gateway Asas para sua imaginação",
        "title": "WA Gateway"
      },
      {
        "id": "2",
        "description": "Não funcionam",
        "title": "Outros"
      }
    ]
  }
}
'
{
  "messageId": "3EB047ED70306656281B34",
  "id": "3EB047ED70306656281B34"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ezapi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Envia uma lista interativa com seções e opções selecionáveis.

Authorizations

​
Client-Token
string
header
required

Path Parameters

​
instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

​
instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

Body

application/json
​
phone
string
required

Número com código do país (ex: 554499999999) ou JID de grupo (ex: 120363123456789@g.us)

Example:

"{{PHONE}}"

​
message
string
required
Example:

"Selecione e melhor opção:"

​
optionList
object
required
Example:
{
  "title": "Opções disponíveis",
  "buttonLabel": "Abrir lista de opções",
  "options": [
    {
      "id": "1",
      "description": "WA Gateway Asas para sua imaginação",
      "title": "WA Gateway"
    },
    {
      "id": "2",
      "description": "Não funcionam",
      "title": "Outros"
    }
  ]
}
​
mentioned
string[]

Lista de números para mencionar em grupos

Example:
["554499999999"]
​
mentionsEveryOne
boolean
default:false

Mencionar todos os participantes do grupo

Response

Resposta de sucesso.

​
messageId
string
required
Example:

"3EB047ED70306656281B34"

​
id
string
required
Example:

"3EB047ED70306656281B34"