Start new chat session

post

https://temvox.com/api/v1/chats/{chatId}/sessions

Use this endpoint to start new dialog with a chat bot.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

chatId

string

required

Chat identifier. It determines the chat settings and bot scheme.

Body Params

name

string

required

the session name (optional)

botId

string

version 4

sessionId

string

version 4

clientId

string

version 4

clientPhone

string

clientEmail

string

clientName

string

clientFirstName

string

clientMiddleName

string

clientLastName

string

clientExternalId

string

Some user-defined identifier of a client that initiated the chat session.

clientDeviceId

string

The client device ID to send PUSH notifications.

clientTimezone

integer

The client timezone offset in minutes.

clientMetadata

object

Any user defined key/value pairs as bot variables.

clientNameForOperator

string

The name of the client that will be visible to the operator.

channel

string

enum

Allowed:

messengerType

string

enum

messengerUserId

string

sessionTtl

integer

returnAnswerAsync

boolean

recreateOnExists

boolean

referer

string

variables

array of strings

The bot context variables

variables

callbackUrl

string

callbackData

string

botNodeId

string

messageBody

string

messageAttachments

array of objects

messageAttachments

eventCallbackUrl

string

eventCallbackData

string

notifyOnEvents

array of strings

notifyOnEvents

replyToMessageId

string

version 4

Responses

400

Invalid input parameters

404

Entity not found

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful session creation

5XXUnexpected error