Start a new session

This API is used to start a new session for your users

Request Body — REQUIRED
askribeKey Askribe Key — REQUIRED Obtain the API key required to connect with Askribe servers from the Settings section in your Askribe flow dashboard.
configId Config Id — REQUIRED This is the config Id of the the distribution you want to trigger. You can get this from the Distribution List panel of the flow you want to trigger
context object Pass a list of Key-Value pairs to be substituted in the flow
contactId Contact Id for which the flow should be run Pass your user's id. This can be obtained by using our CDP APIs
language Language Use this parameter to set the language of the flow

Responses

200 Successfully triggered Schema — OPTIONAL customChannelResponseDTOType Response Type — OPTIONAL Possible values: [START_FLOW_RESPONSE, START_FLOW_LINK, NEXT_BLOCK, END_FLOW, TRANSITIONED_FROM_CHANNEL, TRANSITIONED_IN_CHANNEL, FLOW_SCHEDULED, ERROR, LIST_LANGUAGES, SET_LANUAGE] The type of response is based on request type. See developer docs for more details errorMessage Error message — OPTIONAL Human readable error description, if any sessionId Session Id — OPTIONAL Id of the session nodeId Block Id — OPTIONAL Id of the block newEditNodeType string — OPTIONAL Possible values: [STATEMENT, TEXT_INPUT, NUMERIC_INPUT, URL_INPUT, EMAIL_INPUT, PHONE_NUMBER_INPUT, DATE_TIME, UPLOAD, LISTEN, OPTIONS] isMultiple Are multiple responses allowed — OPTIONAL Sent when newEditNodeType = OPTIONS. Indicates whether the user is allowed to select multiple options content Text Content — OPTIONAL This is the main content of the block options object[] — OPTIONAL Sent when newEditNodeType = OPTIONS. This contains the data to display interactive buttons / options to your user buttonId string — OPTIONAL content string — OPTIONAL languages object[] — OPTIONAL Contains the name and id of all the languages present in the flow buttonId string — OPTIONAL content string — OPTIONAL currentLanguage object — OPTIONAL Name and id of the current language of the session buttonId string — OPTIONAL content string — OPTIONAL