Create chat

post

https://chat-api.twin24.ai/api/v1/chats

Use this endpoint to create new chat room.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

botId

string

version 4

sessionTtl

integer

operatorsBusyMessage

string

allowableOperatorIdleTime

integer

Allowable operator idle time in seconds. After this time, the session will switch to another operator.

sessionReloadBotId

string

version 4

sessionRatingRequired

boolean

sessionRatingTriggerTime

integer

answerOnFirstClientMessage

boolean

eventCallbackUrl

string

It is necessary to fill in the field with a string or null value. You can't leave a line empty.

eventCallbackData

string

It is necessary to fill in the field with a string or null value. You can't leave a line empty.

notifyOnEvents

array of strings

notifyOnEvents

fcmServerKey

string

fcmServiceUrl

string

knowledgeBase

string

pushData

object

form

object

references

object

appearance

object

results

array of objects

results

operatorQueueLifetime

integer

operatorQueueNotifyInterval

integer

operatorQueueNotifyMessage

string

closeSessionAfterOperatorQueueExpired

boolean

Defaults to false

closeSessionAfterOperatorQueueExpiredMessage

string

timerFirstAnswer

integer

timerNextAnswers

integer

transferBotIdAfterBot

string

version 4

transferBotIdAfterOperator

string

version 4

transferBotIdAfterTtl

string

version 4

transferBotIdAfterMessageSentError

string

version 4

extLinkTitle

string

extLinkUrl

string

Responses

400

Invalid input parameters

401

User is not authenticated

403

Invalid user permissions

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

200Success

5XXUnexpected error