POST
Start Session

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
botId
string
bot
object
previewToken
string
sessionId
string
isPreview
boolean
channel
enum<string>
Standard:web
Verfügbare Optionen:
web,
api,
whatsapp,
instagram,
facebook,
telegram,
gmail,
tiktok
prefilledVariables
object
resultId
string
isStreamEnabled
boolean
isOnlyRegistering
boolean
textBubbleContentFormat
enum<string>
Standard:richText
Verfügbare Optionen:
richText,
markdown
startFrom
object
message
object
origin
string
iframeReferrerOrigin
string

Antwort

Default Response

sessionId
string
erforderlich

To save and use for /continueChat requests.

bot
object
erforderlich
messages
object[]
erforderlich
result
object | null
erforderlich
resultId
string
sessionRestoreToken
string
sessionStatus
enum<string>
Verfügbare Optionen:
OPEN,
PAUSED,
CLOSED
lastMessageNewFormat
string

The sent message is validated and formatted on the backend. For example, if for a date input you replied something like tomorrow, the backend will convert it to a date string. This field returns the formatted message.

input
object
clientSideActions
object[]

Actions to execute on the client side

logs
object[]

Logs that were saved during the last execution

dynamicTheme
object

If the bot contains dynamic avatars, dynamicTheme returns the new avatar URLs whenever their variables are updated.

progress
number

If progress bar is enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the flow.