Send quiz message

post

https://gate.whapi.cloud/messages/quiz

Send a quiz message to a WhatsApp Channel.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Message quiz

string

required

^[\d-]{9,31}(@[\w\.]{1,})?$

Use the phone number or Chat ID of the contact/group/channel to which you want to send the message. Use Get groups to get the group ID.

quoted

string

^[A-Za-z0-9._]{4,30}-[A-Za-z0-9._]{4,30}(-[A-Za-z0-9._]{2,30})?(-[A-Za-z0-9._]{2,30})?$

Message ID of the message to be quoted

edit

string

^[A-Za-z0-9._]{4,30}-[A-Za-z0-9._]{4,30}(-[A-Za-z0-9._]{2,30})?(-[A-Za-z0-9._]{2,30})?$

Message ID of the message to be edited

title

string

required

Title of quiz

options

array of strings

required

length between 2 and 12

Options of quiz

options*

correct_option_index

integer

required

≥ 0

Zero-based index of the correct quiz option

end_time

integer

Quiz end timestamp

hide_participant_name

boolean

Hide participant names in quiz results

allow_add_option

boolean

Allow participants to add options

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Created

400Wrong request parameters

401Need channel authorization for send message

402Trial version limit exceeded

403It is forbidden to send to this group/recipient

429Too many requests

500Internal Error