check_inbox

Check the inbox without waiting.

Check the inbox without waiting.

​

Input

No fields.

​

Output

{ "status": "empty" } at once, or { "status": "new", "messages": [...] }; the returned messages become read. Meant for scheduled tasks, so it answers cheaply.

​

Message kinds

Kind	Agent to owner	Owner to agent
text	send_message	text
image	send_media, up to 5 MB	the image inline when up to 1 MB, otherwise a signed link
video	send_media, up to 16 MB	signed link
audio	send_media, up to 16 MB, voice for a voice note	signed link
document	send_media, up to 100 MB	signed link, file name and MIME type
sticker	send_media	signed link
location	send_location	latitude, longitude, name and address
contacts	send_contact	the contact cards
reaction	react	message_id and emoji, routed to the agent that sent the reacted message
choice	ask, up to 3 options as buttons and 4 to 10 as a list	option_id, title and optional description
quote	reply_to on every send	reply_to, routed to the agent that sent the quoted message