Kiosk

API for communication with ZBOS by Zora Robotics.

Channels

zbos/kiosk/resume/event

subscribe

event: Kiosk is active

Fired when kiosk is active after being moved to the background

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/apps/home

publish

Open home screen

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/apps/start

publish

Start application remotely on Kiosk

Channel tags
  • Kiosk

Message ApplicationStartRequest
Payload

Name

Type

Description

Accepted values

appName

string

Any

extras

object

Any

Examples of payload
{}

zbos/remote/kiosk/apps/get

publish

Get installed applications on Kiosk

Request a list of all installed & listed applications from the Kiosksee zbos/remote/kiosk/apps/response/{key} for response

Channel tags
  • Kiosk

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/remote/kiosk/apps/response/{key}

subscribe

response: Get installed applications on Kiosk

Channel tags
  • Kiosk

Message Array<SimpleApplicationNodeDto>
Payload

Name

Type

Description

Accepted values

Message Payload

array(object)

Any

Message Payload.app_name

string

Any

Message Payload.package_name

string

Any

Message Payload.image_base64

string

Any

Examples of payload
{
  "app_name": "string",
  "package_name": "string",
  "image_base64": "string"
}

zbos/remote/kiosk/apps/all/get

publish

Get installed applications on Kiosk

Request a list of all installed & listed applications from the Kiosksee zbos/remote/kiosk/apps/all/response/{key} for response

Channel tags
  • Kiosk

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/remote/kiosk/apps/all/response/{key}

subscribe

response: Get installed applications on Kiosk

Channel tags
  • Kiosk

Message Array<SimpleApplicationNodeDto>
Payload

Name

Type

Description

Accepted values

Message Payload

array(object)

Any

Message Payload.app_name

string

Any

Message Payload.package_name

string

Any

Message Payload.image_base64

string

Any

Examples of payload
{
  "app_name": "string",
  "package_name": "string",
  "image_base64": "string"
}

zbos/remote/kiosk/multimedia/{type}/show

publish

Show multimedia

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/multimedia/{type}/show/response/{key}

subscribe

response: Show multimedia

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/input/show

publish

Show input prompt

Channel tags
  • Kiosk

Message InputBlock
Payload

Name

Type

Description

Accepted values

question

string

Any

textType

string

Any

confirmText

string

Any

Examples of payload
{
  "question": "string"
}

zbos/remote/kiosk/input/show/response/{key}

subscribe

response: Show input prompt

Channel tags
  • Kiosk

Message InputResponse
Payload

Name

Type

Description

Accepted values

input

string

Any

Examples of payload
{
  "input": "input"
}

zbos/remote/kiosk/print/show

publish

Show print dialog

Channel tags
  • Kiosk

Message PrintOptions
Payload

Name

Type

Description

Accepted values

key

string

Any

file_path

string

Required. The path to a PDF file to print.

Any

media_size

string

Optional. The format of the paper to be printed, defaults to 'Letter'

Any

printer_name

string

Optional, only used when auto print is enabled. The name of or part of the name of a printer, defaults to first available printer

Any

auto_print

boolean

Optional. Whether to use the accessibility service to automatically print to the desired printer without user input

Any

Examples of payload
{
  "key": "some_key",
  "file_path": "/sdcard/zbos_media_library/dummy.pdf",
  "media_size": "ISO_A4",
  "printer_name": "HP LaserJet Pro",
  "auto_print": true
}

zbos/remote/kiosk/print/show/response/{key}

subscribe

response: Show print dialog

Channel tags
  • Kiosk

Message SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any

Examples of payload
{
  "success": true
}

zbos/remote/kiosk/text/overlay/show

publish

Show text overlay

Channel tags
  • Kiosk

Message TextOverlayOptions
Payload

Name

Type

Description

Accepted values

key

string

Any

text

string

Any

textColor

string

Any

backgroundColor

string

Any

Examples of payload
{
  "key": "some_key",
  "text": "Hello George, nice to meet you!",
  "textColor": "#00FF00",
  "backgroundColor": "#FF0000"
}

zbos/remote/kiosk/text/overlay/show/response/{key}

subscribe

response: Show text overlay

Channel tags
  • Kiosk

Message SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any

Examples of payload
{
  "success": true
}

zbos/remote/kiosk/text/overlay/hide

publish

Hide text overlay

Channel tags
  • Kiosk

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/remote/kiosk/text/overlay/hide/response/{key}

subscribe

response: Hide text overlay

Channel tags
  • Kiosk

Message SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any

Examples of payload
{
  "success": true
}

zbos/remote/kiosk/microphone/show

publish

Show microphone in composition

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/multimedia/image/show

publish

Show image

Channel tags
  • Kiosk

Message Image
Payload

Name

Type

Description

Accepted values

id

string

Any

path

string

Any

extension

string

Any

fileName

string

Any

style

object

Any

style.backgroundColor

string

Any

url

string

Any

Examples of payload
{
  "id": "string",
  "style": {
    "backgroundColor": "string"
  },
  "url": "string"
}

zbos/remote/kiosk/multimedia/image/show/response/{key}

subscribe

response: Show image

Channel tags
  • Kiosk

Message Image
Payload

Name

Type

Description

Accepted values

id

string

Any

path

string

Any

extension

string

Any

fileName

string

Any

style

object

Any

style.backgroundColor

string

Any

url

string

Any

Examples of payload
{
  "id": "string",
  "style": {
    "backgroundColor": "string"
  },
  "url": "string"
}

zbos/remote/kiosk/multimedia/image/stop

publish

Stop showing image

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/multimedia/image/{filename}/end

subscribe

event: Image ended

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/multimedia/video/show

publish

Show video

Channel tags
  • Kiosk

Message Video
Payload

Name

Type

Description

Accepted values

id

string

Any

url

string

Any

repeat

boolean

Any

audioUrl

string

Any

videoOnly

boolean

Any

showControls

boolean

Any

Examples of payload
{
  "id": "string",
  "url": "string",
  "repeat": true,
  "audioUrl": "string",
  "videoOnly": false,
  "showControls": true,
  "remoteVideo": false
}

zbos/remote/kiosk/multimedia/video/show/response/{key}

subscribe

response: Show video

Channel tags
  • Kiosk

Message Video
Payload

Name

Type

Description

Accepted values

id

string

Any

url

string

Any

repeat

boolean

Any

audioUrl

string

Any

videoOnly

boolean

Any

showControls

boolean

Any

Examples of payload
{
  "id": "string",
  "url": "string",
  "repeat": true,
  "audioUrl": "string",
  "videoOnly": false,
  "showControls": true,
  "remoteVideo": false
}

zbos/remote/kiosk/multimedia/video/stop

publish

Stop video

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/multimedia/video/{filename}/end

subscribe

event: Video ended

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/multimedia/page/show

publish

Show page in kiosk

Channel tags
  • Kiosk

Message OpenBrowserBlock
Payload

Name

Type

Description

Accepted values

blocking

boolean

Any

id

string

Any

index

integer

Any

url

string

Any

Examples of payload
{}

zbos/remote/kiosk/multimedia/page/show/response/{key}

subscribe

response: Show page in kiosk

Channel tags
  • Kiosk

Message OpenBrowserBlock
Payload

Name

Type

Description

Accepted values

blocking

boolean

Any

id

string

Any

index

integer

Any

url

string

Any

Examples of payload
{}

zbos/remote/kiosk/action/start

publish

Start action

Channel tags
  • Kiosk

Message Action
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/settings/lock/state/get

publish

Get current lockstate

Channel tags
  • Kiosk

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/remote/kiosk/settings/lock/state/response

subscribe

response: Get current lockstate

Channel tags
  • Kiosk

Message LockStatus
Payload

Name

Type

Description

Accepted values

isLocked

boolean

Any

isPincodeSet

boolean

Any

Examples of payload
{
  "locked": true,
  "pincodeSet": false
}

zbos/remote/kiosk/settings/unlock

publish

Unlock settings page

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/settings/lock

publish

Lock settings page

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/settings/lock/event

subscribe

response: Lock settings page

Channel tags
  • Kiosk

Message LockResponse
Payload

Name

Type

Description

Accepted values

response

string

Any

success

boolean

Any

Examples of payload
{}

zbos/remote/kiosk/settings/unlock/event

subscribe

response: Unlock settings page

Channel tags
  • Kiosk

Message LockResponse
Payload

Name

Type

Description

Accepted values

response

string

Any

success

boolean

Any

Examples of payload
{}

zbos/remote/kiosk/settings/pincode/change/event

subscribe

response: Change current pincode

Channel tags
  • Kiosk

Message LockResponse
Payload

Name

Type

Description

Accepted values

response

string

Any

success

boolean

Any

Examples of payload
{}

zbos/remote/kiosk/settings/pincode/remove

publish

Remove current pincode

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/remote/kiosk/settings/pincode/remove/event

subscribe

response: Remove current pincode

Channel tags
  • Kiosk

Message LockResponse
Payload

Name

Type

Description

Accepted values

response

string

Any

success

boolean

Any

Examples of payload
{}

zbos/kiosk/datasource/get/all

publish

Get all datasources

Channel tags
  • Kiosk

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/kiosk/datasource/get/all/response/{key}

subscribe

response: Get all datasources

Channel tags
  • Kiosk

Message Array<SimpleDataSource>
Payload

Name

Type

Description

Accepted values

Message Payload

array(object)

Any

Message Payload.id

string

Any

Message Payload.name

string

Any

Examples of payload
{
  "id": "string",
  "name": "string"
}

zbos/kiosk/datasource/get

publish

Get specific datasources

Channel tags
  • Kiosk

Message SimpleDataSource
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

Examples of payload
{
  "id": "string",
  "name": "string"
}

zbos/kiosk/datasource/get/response/{key}

subscribe

response: Get specific datasources

Channel tags
  • Kiosk

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/kiosk/datasource/current/get

publish

Get active datasources

Channel tags
  • Kiosk

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/kiosk/datasource/current/get/response/{key}

subscribe

response: Get active datasources

Channel tags
  • Kiosk

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/kiosk/datasource/set

publish

Set current Kiosk datasources

Channel tags
  • Kiosk

Message ChangeDatasourceRequest
Payload

Name

Type

Description

Accepted values

id

string

Any

Examples of payload
{
  "id": "string"
}

zbos/kiosk/datasource/save

publish

Save or add a datasource

Channel tags
  • Kiosk

Message SimpleDataSource
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

Examples of payload
{
  "id": "string",
  "name": "String"
}

zbos/kiosk/datasource/save/event/{kiosk_id}

subscribe

response: Get active datasources

Channel tags
  • Kiosk

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/kiosk/datasource/delete

publish

Delete a datasource

Channel tags
  • Kiosk

Message SimpleDataSource
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

Examples of payload
{
  "id": "string"
}

zbos/kiosk/datasource/delete/event/{kiosk_id}

subscribe

response: Delete a datasource

Channel tags
  • Kiosk

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/kiosk/composition/pin/lock

publish

Pin a composition

Channel tags
  • Kiosk

Message PinnedComposition
Payload

Name

Type

Description

Accepted values

id

string

Any

Examples of payload
{
  "id": "string"
}

zbos/kiosk/composition/pin/unlock

publish

Unpin a composition

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/kiosk/composition/pin/get

publish

Request the current pin status & pinned composition.

Channel tags
  • Kiosk

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/kiosk/composition/pin/get/response/{key}

subscribe

response: pin status & pinned composition

Channel tags
  • Kiosk

Message PinnedCompositionState
Payload

Name

Type

Description

Accepted values

isPinned

boolean

Any

id

string

Any

Examples of payload
{
  "id": "string",
  "pinned": true
}

zbos/kiosk/app/pin/lock

publish

Pin an app, if installed

A locked app will be launched immediately when the kiosk opens.

Channel tags
  • Kiosk

Message PinnedApplication
Payload

Name

Type

Description

Accepted values

packageName

string

Any

Examples of payload
{
  "packageName": "string"
}

zbos/kiosk/app/pin/unlock

publish

Unpin an app.

Channel tags
  • Kiosk

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/kiosk/app/pin/get

publish

Request the current pin status & pinned app.

Channel tags
  • Kiosk

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/kiosk/app/pin/get/response/{key}

subscribe

response: pin status & pinned app

Channel tags
  • Kiosk

Message PinnedApplicationState
Payload

Name

Type

Description

Accepted values

isPinned

boolean

Any

packageName

string

Any

Examples of payload
{
  "packageName": "string",
  "pinned": true
}