Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Devices

Prompt Device for Yes/No Response

Prompt a cloud device to request a yes/no response from the user.

post/v5/devices/{device_id}/prompt/yes-no

Path parameters

device_idstring required

The device ID to prompt.

Request body

headerstring required

Header message to display on the device

messagestring required

Message to display on the device

Response

Success

object'request' required

Resource type identifier

idstring required

Prompt request ID (reference)

status'in_progress' | 'completed' | 'cancelled' | 'cancelledAtTerminal' | 'cancelledByApi' | 'cancelledByTimeout' | 'poiDeviceInUse' | 'poiDeviceDisconnected' | 'terminatedBadCardRead' required

Status of the prompt request

resultstring

The result of the prompt (e.g., 'yes', 'no', or selected menu option). Only present when status is 'completed'.

signaturestring

Base64-encoded signature image. Only present for sign prompts when status is 'completed'.

signature_formatstring

Format of the signature image (e.g., 'png'). Only present for sign prompts when status is 'completed'.