Action Objects

An action object defines an action of the bot when a button in a message or menu is pressed.

Action types {#actions}

The available action types are as follows:

• Postback action
• Message action
• URI action
• Camera action
• Camera roll action
• Location action
• Copy action

The available positions for each action type are as follows:

Postback action {#postback}

When an element associated with this action is pressed, a Postback Event containing the text string specified in the data parameter is returned through the callback.

Note

• The available positions are limited for each action type. For more information, see the table in Action types .

common {#postback-common}

multi language {#postback-multilang}

Request example {#postback-example}

{  "type": "postback",  "label": "Buy",  "data": "action=buy&itemid=111",  "displayText": "Buy"

Message action {#message}

When an element associated with this action is pressed, a text string is sent as a message and a Message Event is returned through the callback.

Note

• The available positions are limited for each action type. For more information, see the table in Action types .

common {#message-common}

multi language {#message-multilang}

Request example {#message-example}

{  "type": "message",  "label": "Yes",  "text": "Yes"}

URI action {#uri}

When an element associated with this action is pressed, the URI set in the uri property opens.

Note

• The available positions are limited for each action type. For more information, see the table in Action types .

common {#uri-common}

multi language {#uri-multilang}

Request example {#uri-example}

{  "type": "uri",  "label": "View details",  "uri": "http://example.com"}

Camera action {#camera}

When a button associated with this action is pressed, the camera screen opens.

Note

• The available positions are limited for each action type. For more information, see the table in Action types .
• It is available only on mobile.

common {#camera-common}

multi language {#camera-multilang}

Request example {#camera-example}

{  "type": "camera",  "label": "Camera"}

Camera roll action {#cameraroll}

When a button associated with this action is pressed, the camera roll opens.

Note

• The available positions are limited for each action type. For more information, see the table in Action types .
• It is available only on mobile.

common {#cameraroll-common}

multi language {#cameraroll-multilang}

Request example {#cameraroll-example}

{  "type": "cameraRoll",  "label": "Camera roll"}

Location action {#location}

When a button associated with this action is pressed, the location information screen opens.

Note

• The available positions are limited for each action type. For more information, see the table in Action types .
• It is available only on mobile.

common {#location-common}

multi language {#location-multilang}

Request example {#location-example}

{  "type": "location",  "label": "Location"}

Copy action {#copy}

When a button associated with this action is pressed, the text specified in the copyText parameter is copied to the clipboard.

Note

• The available positions are limited for each action type. For more information, see the table in Action types .

Caution

• This action is available in v3.6 or later.

common {#copy-common}

multi language {#copy-multilang}

Request example {#copy-example}

{"type": "copy","label": "Copy This","copyText": "This is a copied text."}