Create Session

Beta

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringOptional<=40 characters

This is a user-defined name for the session. Maximum length is 40 characters.

statusenumOptional

This is the current status of the session. Can be either ‘active’ or ‘completed’.

Allowed values:
assistantIdstringOptional

This is the ID of the assistant associated with this session. Use this when referencing an existing assistant.

assistantobjectOptional

This is the assistant configuration for this session. Use this when creating a new assistant configuration. If assistantId is provided, this will be ignored.

messageslist of objectsOptional

This is an array of chat messages in the session.

customerobjectOptional

This is the customer information associated with this session.

phoneNumberIdstringOptional

This is the ID of the phone number associated with this session.

phoneNumberobjectOptional

This is the phone number configuration for this session.

Response

idstring

This is the unique identifier for the session.

orgIdstring

This is the unique identifier for the organization that owns this session.

createdAtdatetime

This is the ISO 8601 timestamp indicating when the session was created.

updatedAtdatetime

This is the ISO 8601 timestamp indicating when the session was last updated.

namestringOptional<=40 characters

This is a user-defined name for the session. Maximum length is 40 characters.

statusenumOptional

This is the current status of the session. Can be either ‘active’ or ‘completed’.

Allowed values:
assistantIdstringOptional

This is the ID of the assistant associated with this session. Use this when referencing an existing assistant.

assistantobjectOptional

This is the assistant configuration for this session. Use this when creating a new assistant configuration. If assistantId is provided, this will be ignored.

messageslist of objectsOptional

This is an array of chat messages in the session.

customerobjectOptional

This is the customer information associated with this session.

phoneNumberIdstringOptional

This is the ID of the phone number associated with this session.

phoneNumberobjectOptional

This is the phone number configuration for this session.