Data Types

Discover the date types in nandbox app builder.

๐Ÿ“˜

FieldTypeRequiredDescription
styleStringYes01: 02: 03: 04: 05: 06: 07: 08:
spanIntegerOptionalcell Span
bg_colorStringOptionalcell background color. The color should be in hexadecimal format (Hex triplet) or according to its common English name. Example: Red color can be set as "RED" or "#FF0000"
labelstringOptionalTitle - when it is available
lable_colorStringOptionalLableโ€™s text color of the button Title The color should be in hexadecimal format (Hex triplet ) or according to its common English name. Example : Red color can be set as "RED" or "#FF0000"
hintstringcell hint
keyboardStringOptionalit is recommended to set the type of keyboard when the cell is type in or inout. Otherwise, the default keyboard will be set.
next_screenStringOptionalscreen unique identifier that references the next screen to navigate to it, when the button is pressed.
urlStringOptionalButton URL. When the button is pressed, an external URL link will be opened.

Capitalized types are data structures represented as JSON objects. The different types in incoming messages are listed below.

File identifiers in the Photo, Sticker, GIF, Video, Audio, Voice, Document and Text_File document can be used to download the actual file.

It is safe to use 32-bit signed integers for storing all Integer fields unless otherwise noted.

Long fields are sent as Strings to avoid problems with JavaScript based clients.

Optional fields may be not returned when not relevant.

User

This object represents a nandbox user or bot account.

FieldTypeRequiredDescription
idStringYesUnique identifier for this user or bot
nameStringYesUser or bot name.
versionStringYesLast updated user profile version.
terminalStringOptionalMobile if it is sent from mobile, API if it is sent from API. It will returned only if the user object come inside incoming message
typeStringOptionalContact if it is sent from normal user, Bot if it is sent from Bot. It will returned only if the user object come inside incoming message
is_botBooleanOptionalTrue if this user is a bot. Returned only in GetUser
statusStringOptionalUser status. Returned only in GetUser
photoPhotoOptionalPublic user's Photo. Returned only in GetUser
profileStringOptionalProfile type "Other" , "Friend" , "Work" or "Family"
{
    "method": "user",
    "user": {
        "image": "\/9j\/4AAQSkZJRgABAQAAAQABAAD\/2wBDABsSFBcUERsXFhceHBsgKEIrKCUlKFE6PTBCYFVlZF9V\nXVtqeJmBanGQc1tdhbWGkJ6jq62rZ4C8ybqmx5moq6T\/2wBDARweHigjKE4rK06kbl1upKSkpKSk\npKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKT\/wAARCABpAGkDASIA\nAhEBAxEB\/8QAGQAAAwEBAQAAAAAAAAAAAAAAAgMEBQEA\/8QANBAAAgIBAwIEAwYFBQAAAAAAAQIA\nAxEEITESQSJRYXETFIEFMjNSkaEjJDRysTVCYpLR\/8QAGAEBAQEBAQAAAAAAAAAAAAAAAgEAAwT\/\nxAAdEQEBAQEAAgMBAAAAAAAAAAAAARECEjEDIUFR\/9oADAMBAAIRAxEAPwCnuYi2+tNhuYWqYrUc\ncnaZh6snbM48z9dqpa+wnYDE91ty3HrJlsIGCM+kMEN6enadBUqosGFYZ8oLK42KmK8SnIl9bGyo\nE8jvFOqliF1PkYvBzxLjAMWhieDKSBEWDxfWc7DlPTvKK+JPX3lNfEc9BfZWt\/A+omdtNHUrZYOh\nVyvnJvlLPy\/vOk6kTxtWarHwxmQ7SzW\/hD3kgX0+s83Pp2rgUeUalWCDDrqxuYWQp3MrKNPpksHi\ng69Pk9IGrO\/Vg5jNPdWD0538sRP2zaraPpDZPUJY1Z665icOB7iPVw4yrAiZTbTqWsh6lMTm1cmK\nsBzmcou+KmcbjmO+E7jKiaxpaKvvKK+IpanHIjkBAwZYlEFJ4BPtPdJ8jHVjwrkDmHkeQ\/SbWxDq\n16qGx23kqkNhwRtyJoYzJKqDVbZ3U8ThzXamg7T1dCWthp3IgLb0sW5AjZ41JRql6ePKSfaKCu7o\nBJGOrc95RWBfaXLkb5kGuuFuodgcrnAPoIoNTsIPTCG5Al2mpU0MWUHeUYn0Jw7L5iaI6yB0nG0S\nlSV\/dUCUJz9Jak9p7NRbW\/SRv7wPm38v3nbgTqWxjjvPCtz+X9JMbWppmJorJ7rmNyYuoYrQeSiM\nmUsCJPJlIRsZ3GfOC1RYcKwg5+P9K95We1pUnuJxXDHY7HmVNpVJ3Vl\/cT1mmGn01jICWxsRF42J\n5SotVctNHQhw7nB37TMYzZ1f2dZqFS1ehLCPECefWQP9l6oDIQN\/awlwbU9JzYAZqacH4BwM53mZ\nTWwswQR2M19M9agL1jPkZKUKzGqf8QdSFFmV4InU4HtLRzKi1R\/mG+kWCSRC1RxqGg1DqsUeZE0Z\nvLtt5ACFAB8RhZlY7rY+UWwUnqCjPfbeHBLYYH9Y4ALKrlwarMg\/7X3\/AHhI9qKPiBR4sHHaGXDd\nJHEF8MXU8ESo4KmQkDLKTkf8T\/5PWIUrLA8HM7VZlME5I2PrGHDoV8xiZkL0pazEDx4zt3Ekt03i\nVg2MS+vCHqOxCkRep07Ei1e43ENhSpNQ2Co9IyvdQfSIZC5xyRKaqQ1akkjbicz9\/aDVIxvJCkic\n0qP8zXlTjqE0\/l1\/MZ1KArg5OxmY5RyfWHODidiQefSJssGM9vPiMsOQF7E7yUOtjFuR29orcSTT\nK7BsM8RnX\/FT1k7V+UFSyuCcnEk7W8fw8nosz5bH2jwcbiSvYrHIjFfw88RaGO34VHftOUXCzYmJ\ne8FSB0nfcGJNyjxJsfKTyLxN1FHQ5deDz6TivlfC2MQ67www0VqakC5DBQfOGxoLrf8AOP0hVOzW\nYJB+kzQy1ucP1Z2lehI6ue0Br14E7BGw84UYkam8DTNYp5Xw+5mbp9QawFbcdo0\/6VX7j\/MjMWSw\ndxopqeoZ3xGrcp7iZ1X3RCE53l0nWtDKGASC3Qm7YzzxJRxD039Sf7JJFteOnOfGWHtGfKZ4fH0l\nBnRxHPoKmGnur32YehnEsF3Uj4CkdzKbPvp7GZVf4495dRQdHpc5wP8AsYwLUg8JH6z0B+JMjSjp\n1I8Sk7A7GO+MPzCZlPDe8bMr\/9k=\n",
        "name": "Shawmi dev",
        "photo": {
            "thumbnail": {
                "width": 120,
                "id": "V_0rbN_90089584980037358_0_Fcs3Z4qxaq.jpg.thumb.jpg",
                "height": 120
            },
            "width": 256,
            "id": "V_0rbN_90089584980037358_0_Fcs3Z4qxaq.jpg",
            "height": 256
        },
        "id": "90089584980037358",
        "is_bot": false,
        "version": "0rbN",
        "status": ""
    }
}

Chat

This object represents a nandbox group or channel information

FieldTypeRequiredDescription
idStringYesUnique identifier for Group or Channel.
titleStringYesOptional. title for Group or Channel
typeStringYes"Group" , "Channel" "Contact" Or "Bot"
versionStringYesLast updated Group or Channel profile version.
language_codeIntegerOptionalIETF language tag of the main Chat language. Returned only in getChat.
RegionsStringOptionalAllowed region, if it is null means "All". Returned only in getChat.
descriptionStringOptionalChat Description. Returned only in getChat.
photoPhotoOptionalChat Photo. Returned only in getChat.
categoryStringOptionalChat category. Returned only in getChat.
member_countIntegerOptionalTotal Chat members count. Response only in getChat.
invite_linkStringOptionalChat invite link. Returned only in getChat.
tagsDefinitionArray of TagDefinitionConditionalList of "tag definition"

Message

The main message method defines all parameters for all incoming messages to the bot.

FieldTypeRequiredDescription
message_idStringYesUnique identifier for this message.
referenceLongYesUnique local identifier
chatChatYesConversation the message belongs to.
fromUserYesSender User of this message
sent_toUserYesReceiver user, most of the case it is the bot ID except if channel has multiple administrators, it will be the specific admin who should receive the message.
typeStringYes"text": For text messages "text_file": Message is a text tile. Any message exceeds 1800 characters will be converted to text file. "photo":Message is a photo."gif": Message is a GIF"sticker": Message is a sticker."video": Message is a video"audio": Message is an audio"voice": Message is a voice note "location": Message is a location"contact": Message is a contact "document": Message is a document
dateLongYesDate the message was sent in Unix Epoch timestamp in milliseconds.
reply_to_message_idStringOptionalParent message Unique identifier.
from_adminIntegerOptional1 if from user is admin, otherwise it is 0
textStringConditionalOnly available when type is text
text_fileText_FileConditionalOnly available when type is text_file
photoPhotoConditionalOnly available when type is photo
gifGIFConditionalOnly available when type is gif
stickerStickerConditionalOnly available when type is sticker
videoVideoConditionalOnly available when type is video
audioAudioConditionalOnly available when type is audio
voiceVoiceConditionalOnly available when type is voice
documentDocumentConditionalOnly available when type is document
locationLocationConditionalOnly available when type is location
contactContactConditionalOnly available when type is contact
statusStringOptional"deleted" if messages is recalled and "updated" if it is updated.
chat_settingsIntegerOptional1 if from chat settings bot, otherwise it is 0
captionString
bg_colorString
articleArticle
urlString
white_list_userWhiteListUser
tagTagDefinition
schedule_dateLongOptionalLong time format like this example 1579102262

JSON Example:

{
    "method": "message",
    "message": {
        "date": 1512445910180,
        "gif": {
            "thumbnail": {
                "width": 256,
                "id": "cfdb3cc5.gif.thumb.jpg",
                "height": 191
            },
            "size": 4136640,
            "width": 443,
            "id": "02505e8f5e01aff254904853.gif",
            "height": 332
        },
        "chat": {
            "name": "chat 1",
            "id": "4522291356145774",
            "type": 0
        },
        "message_id": "d2_QhlW1MAH12617138",
        "from": {
            "name": "John Smith",
            "id": "4521191845180798",
            "type": 0,
            "version": "('0hn0','1YDA','2ViB','32Fg')"
        },
        "type": "gif"
    }
}

Text

This object represents Text entry.

FieldTypeRequiredDescription
TextStringYesThe actual UTF-8 text of the message, 0-1800 characters.
bg_colorStringOptionalText message Background color name in hexadecimal format (Hex triplet ) or according to its common English name. Example : Red color can be set as "RED" or "#FF0000"

Photo

This object represents one size of a photo and/or thumbnail.

FieldTypeRequiredDescription
idStringYesUnique identifier for this file
widthIntegerYesPhoto width
heightIntegerYesPhoto height
sizeIntegerOptionalPhoto size
thumbnailPhotoOptionalThumbnail of the photo

GIF

This object represents GIF image.

FieldTypeRequiredDescription
idStringYesUnique identifier for this file
widthIntegerYesGIF width
heightIntegerYesGIF height
sizeIntegerOptionalGIF size
thumbnailPhotoOptionalThumbnail of the photo

Sticker

This object represents Sticker Photo.

FieldTypeRequiredDescription
idStringYesUnique identifier for this sticker
widthIntegerOptionalSticker width
heightIntegerOptionalSticker height
sizeIntegerOptionalSticker size
thumbnailPhotoOptionalThumbnail of the photo

Video

This object represents a video file.

FieldTypeRequiredDescription
idStringYesUnique identifier for this file
widthIntegerYesVideo width
heightIntegerYesVideo height
durationIntegerYesDuration of the video in seconds.
sizeIntegerYesVideo size
thumbnailPhotoOptionalVideo thumbnail

Audio

This object represents a audio file.

FieldTypeRequiredDescription
idStringYesUnique identifier for this file
durationIntegerYesDuration of the audio file
performerStringOptionalPerformer of the audio as defined by sender or by audio tags.
titleStringOptionalTitle of the audio of the audio as defined by sender or by audio tags
sizeIntegerYesAudio file size

Voice

This object represents a voice note.

FieldTypeRequiredDescription
idStringYesUnique identifier for this file
durationIntegerYesDuration of the voice note.
sizeIntegerYesVoice file size.

Document

This object represents a general file (as opposed to photos, voice messages and audio files).

FieldTypeRequiredDescription
idStringYesUnique identifier for this file
nameIntegerOptionalDocument name as defined by Sender.
sizeIntegerYesDocument file size.

Text_File

This object represents a text file.

FieldTypeRequiredDescription
IdStringYesUnique identifier for this file
sizeIntegerYesFile size.

Location

This object represents a point on the map.

FieldTypeRequiredDescription
longitudeStringYeslongitude
LatitudeStringYeslatitude
nameStringOptionalLocation name
detailsStringOptionalLocation details

Contact

This object represents a phone contact.

FieldTypeRequiredDescription
phone_numberStringYesContact's phone number
nameStringYesContact full name

ChatMenuCallback

This object represents an incoming callback query from a callback button associated with a normal keypad menu.

FieldTypeRequiredDescription
button_callbackStringYesUnique identifier for button as defined by bot.
menu_refStringYesMenu Unique identifier defined by bot where button belongs to.
fromUserYesSender User who pressed the button.
chatChatYesConversation the message belongs to.
dateLongYesLong date format in milliseconds
next_menuIntegerStringOptionalThe menu to navigate to it when the button pressed.
button_query_resultButtonQueryResultOptionalReturned inquiry information from app. The field either will return "Location" in form of longitude and latitude respectively as comma separated. "Phone number" depends on the buttonQuery.

InlineMessageCallback

This object represents an incoming callback query from a callback button within an inline keypad menu associated with a specific message. If the button that originated the query was attached to a message sent by the bot, the field message_id will be present.

FieldTypeRequiredDescription
button_callbackStringYesCallback Unique identifier as defined by bot.
menu_refStringYesMenu reference
fromUserYesSender User of the message
chatChatYesConversation the message belongs to.
message_idStringYesAssociated message Global Unique identifier where the menu belong to.
referenceLongYesAssociated message Unique local identifier as defined by the bot.
dateLongYesLong date format in milliseconds
next_menuIntegerOptionalThe menu to navigate to it when the button pressed.
button_query_resultButtonQueryResultOptionalReturned inquiry information from app. The field either will return "Location" in form of longitude and latitude respectively as comma separated. "Phone number" depends on the buttonQuery.
button_labelStringOptionalButton label

InlineSearch

This object represents InlineSearch

FieldTypeRequiredDescription
dateLongYesLong date format in milliseconds
keywordsStringyesSearch keyword
chatChatYesConversation the message belongs to.
fromUserYesSender User of the message
search_idIntegerYesUnique search id for this message
offsetStringOptionalOffset of the results to be returned
{
    "method": "inlineSearch",
    "inlineSearch": {
        "date": 1600589339535,
        "keywords": "ูุชุญ",
        "chat": {
            "id": "90089668723575679",
            "type": "Mobile"
        },
        "from": {
            "id": "90089668723575679",
            "type": "Mobile"
        },
        "search_id": 1589060
    }
}

Results

FieldTypeRequiredDescription
thumb_urlStringOptionalURL of Thumbnail of the media
captionStringOptionalCaption of the media
descriptionStringOptionalDescription of the media .
titleStringOptionalTitle of the media
typeStringYesType of media file like text, image , video , gif_image, gif_video etc.
urlStringYesDownload URL of media file
widthLongOptionalWidth of thumbnail image
heightLongOptionalHeight if thumbnail image

Tag Defination

FieldTypeRequiredDescription
nameStringYesThe name of tag
descriptionStringYesDescription of tag
idStringYesId of tag
isPrivateIntegerYes1= private 0= no private

Users

FieldTypeRequiredDescription
signup_userStringYesAdd signup user
tagsArray of StringOptionalAdd list of tags

Data

FieldTypeRequiredDescription
patternStringYesAdd pattern for black or white list
exampleStringYesAdd example of pattern

Signup User

FieldTypeRequiredDescription
idStringyesId of signup user
signup_userStringYesSignup user (mobile number or email)
tagsArray of StringOptionalOnly when you have tags in whitelist

ButtonQueryResult

This object represents an incoming button query results from a callback button

FieldTypeRequiredDescription
latitudeStringOptionalOnly sent in case of buttonQuery is location
longitudeStringOptionalOnly sent in case of buttonQuery is location
contactStringOptionOnly sent in case of buttonQuery is phone_number.

Chat Member

This object represents a chat member user returned in getChatMember banChatMember, unbanChatMember, removeChatMember and when user join or leaves the chat.

FieldTypeRequiredDescription
userUserYesMember User Unique identifier
chatChatYesChat Unique identifier where member belongs or used to belongs to.
typeStringYes"member" if user is a member, "admin" if user is an admin.
member_sinceTimestampOptionalUnix Epoch timestamp.
statusStringYes"active": where user is an active member in the Chat"deleted" : where user has been deleted from Chat."banned": when user has been banned from Chat."left" : when user left the Chat.
tagsArray of StringOptionalList of tags id if user have tags
account_typeStringOptionalMust have specific privilege from Web (Get User Login ID)Type for which user signup(email , msisdn)
msisdnStringOptionalGet email or msisdn
{
    "chatMember": {
        "member_since": 1590979113000,
        "privileges": ["1", "4611686018427387904"],
        "view": 0,
        "account_type": "msisdn",
        "chat": {
            "id": "90090691357982716"
        },
        "type": "Admin",
        "user": {
            "id": "90089668723575679"
        },
        "status": "Active",
        "tags": null
    },
    "method": "chatMember"
}

{
    "chatMember": {
        "view": 0,
        "chat": {
            "id": "90090684265189649",
            "type": "Channel"
        },
        "type": "Member",
        "user": {
            "id": "90089585281071029"
        },
        "tags": ["1", "2"],
        "status": "Active"
    },
    "method": "chatMember"
}

{
    "chatMember": {
        "user": {
            "id": "4521191845180798"
        },
        "chat": {
            "id": "4522291356145774"
        },
        "type": "Admin",
        "status": "Active",
        "member_since": 1512440093000
    },
    "method": "chatMember"
}

Chat Administrators

This object represents channel or group administrator users. Returned as a reply to getChatAdministrators

FieldTypeRequiredDescription
chatChatYeschannel or group Unique identifier object where administrators belongs to.
administratorsArray of UserYesList of All administrator users of this channel or group.
{
    "chatAdministrators": {
        "chat": {
            "id": "90090684268836495"
        },
        "administrators": [{
                "id": "90089584770196915"
            }, {
                "id": "90091783798510047"
            }, {
                "id": "90091783950702380"
            }, {
                "id": "90091783958740938"
            }
        ]
    },
    "method": "chatAdministrators"
}

Blacklist

This object represents blacklist. Returned as a reply to getBlacklist

FieldTypeRequiredDescription
chatChatYeschannel or group Unique identifier object where administrators belongs to.
eopStringYesNumber of page
usersArray of SignupUsersYesArray of users
{
    "method": "blacklist",
    "blacklist": {
        "chat": {
            "id": "90090684293612221"
        },
        "eop": "19",
        "users": [{
                "id": "2",
                "signup_user": "201116601107"
            }, {
                "id": "4",
                "signup_user": "201116601109"
            }, {
                "id": "5",
                "signup_user": "201116601111"
            }, {
                "id": "14",
                "signup_user": "1111111"
            }, {
                "id": "15",
                "signup_user": "222222"
            }, {
                "id": "19",
                "signup_user": "222223"
            }
        ]
    }
}

Whitelist

This object represents whitelist. Returned as a reply to getWhitelist

FieldTypeRequiredDescription
chatChatYeschannel or group Unique identifier object where administrators belongs to.
eopStringYesNumber of page
usersArray of SignupUsersYesArray of users
{
    "method": "whitelist",
    "whitelist": {
        "chat": {
            "id": "90090684293612221"
        },
        "eop": "13",
        "users": [{
                "id": "1",
                "signup_user": "11111",
                "tags": ["1", "2"]
            }, {
                "id": "2",
                "signup_user": "22222",
                "tags": ["1", "2", "4"]
            }, {
                "id": "8",
                "signup_user": "222223"
            }, {
                "id": "9",
                "signup_user": "9999999"
            }, {
                "id": "11",
                "signup_user": "6666666"
            }, {
                "id": "13",
                "signup_user": "3636526",
                "tags": ["1", "2"]
            }
        ]
    }
}

Message Acknowledge

Object represents outbound messages acknowledgment details.

FieldTypeRequiredDescription
referenceLongYesUnique local identifier for the original message.
message_idStringYesGlobal Unique identifier for the original message.
dateLongYesDate the message was sent in Unix Epoch timestamp in milliseconds
{
    "method": "messageAck",
    "ack": {
        "reference": 15459134560801,
        "date": 1545913595858,
        "message_id": "p1_Ua0ZWAyX13260293"
    }
}

Started Bot

This object represents a user, Returned when user started bot

FieldTypeRequiredDescription
userUserYesMember User Unique identifier
{
    "method": "userStartedBot",
    "user": {
        "id": "4521191845180798"
    }
}

User Joined Bot

This object represents a user, Returned when user joined bot

FieldTypeRequiredDescription
userUserYesMember User Unique identifier
{
    "method": "userJoinedBot",
    "user": {
        "id": "4521191845180798"
    }
}

User Stopped Bot

This object represents a user, Returned when user stopped bot

FieldTypeRequiredDescription
userUserYesMember User Unique identifier
{
    "method": "userStoppedBot",
    "user": {
        "id": "90089584801498185"
    }
}

User Left Bot

This object represents a user, Returned when user left bot

FieldTypeRequiredDescription
userUserYesMember User Unique identifier
{
    "method": "userLeftBot",
    "user": {
        "id": "90089584801498185"
    }
}

Inline Search

This object represents an inline search, Returned when user write search keyword in inline bot

FieldTypeRequiredDescription
methodStringYes"inlineSearch"
inineSearchInlineSearchYesMember User Unique identifier
{
    "method": "inlineSearch",
    "inlineSearch": {
        "date": 1559491192232,
        "keywords": "hi",
        "chat": {
            "id": "90089585282313728",
            "type": "Mobile"
        },
        "from": {
            "id": "90089585282313728",
            "type": "Mobile"
        },
        "search_id": 3329
    }
}

SetChatMenu_ack

This object represents acknowledgement of receipt new or updated normal keypad menu in returned for setChatMenu.

FieldTypeRequiredDescription
chatChatYesConversation Chat which menu send to.
{
    "method": "setChatMenu_ack",
    "chat": {
        "id": "4522291356145774"
    }
}

Menu

Each Menu composes of set of rows. At least one row should be defined.

FieldTypeRequiredDescription
menu_refStringYesUnique identifier of this Menu as defined by bot.
rowsArray of RowYesRows belong to this menu. Row which is an Array of buttons

Row

Each row belongs to one keypad menu that composes of set of buttons. At least one button should be defined.

FieldTypeRequiredDescription
buttonsArray of ButtonYesButton belongs to the row.
row_orderIntegerYesRow order in the menu.

Button

This object represents button of reply. Button must have a button_callback which is the unique identifier defined by bot.

FieldTypeRequiredDescription
button_callbackStringYesThis is unique identifier as defined by bot. The button_callback returned in inlineMessageCallback and ChatMenuCallback when button pressed.
next_menuMenuOptionalMenu unique identifier that reference the next menu to navigate to it when the button pressed.
button_spanIntegerOptionalButton Span
button_orderIntegerOptionalThe number of button order by ascending
button_text_colorStringOptionalText color of the button Title The color should be in hexadecimal format (Hex triplet ) or according to its common English name. Example : Red color can be set as "RED" or "#FF0000"
button_bg_colorStringOptionalButton background color. The color should be in hexadecimal format (Hex triplet ) or according to its common English name. Example : Red color can be set as "RED" or "#FF0000"
button_labelStringOptionalButton label or title.
button_urlStringOptionalButton URL. When button pressed, an external URL link will be opened.
button_queryStringOptionalField used to query information from app, this can take one of two values as follows Location: to ask user to get location or point of map information. Contact : to ask user to get his contact number.
chatChatOptionalChat is a unique identifier that references the specific channel or group to be opened when button is pressed. The user should be a member of the specified channel or group. If button_url and chat are both defined, both will be executed.
nav_typeStringOptional-Null is default to show navigation button for channel, group or contact-Type "admin" for show admin navigation button in chat setting.

Workflow Cell

This object represents workflow cell

FieldTypeRequiredDescription
cell_idStringConditionalThis is a unique identifier as defined by the platform. If it is provided, will be a higher priority than callback identification.
callbackStringYesThis is a unique identifier as defined by the user. The callback is the soft-name for the cell. It will be returned in Workflow Callback when cell/button is pressed.
api_idLongOptionalAPI unique identifier which can write and read from the cell.
cacheBooleanYesNull or zero is the default In case of true, all cell parameters will be cached permanently until it has been altered
next_screenStringOptionalscreen unique identifier that references the next screen to navigate to it, when the button is pressed.
urlStringOptionalButton URL. When the button is pressed, an external URL link will be opened.
bg_colorStringOptionalcell background color. The color should be in hexadecimal format (Hex triplet) or according to its common English name. Example: Red color can be set as "RED" or "#FF0000"
labelstringOptionalTitle - when it is available
label_colorStringOptionalLableโ€™s text color of the button Title The color should be in hexadecimal format (Hex triplet ) or according to its common English name. Example : Red color can be set as "RED" or "#FF0000"
sublabelstringOptionalSubtitle -when it is available
sublabel_colorStringOptionalSubtitleโ€™s text color of the button Title The color should be in hexadecimal format (Hex triplet ) or according to its common English name. Example : Red color can be set as "RED" or "#FF0000"
hintStringOptionalHint Text
valueArrayOptionalAn array of Numeric values with comma separated