Sign in
ProxyV1Session

Create a new Session

Create a new Session

post/v1/Services/{ServiceSid}/Sessions

Path parameters

ServiceSidstring required

The SID of the parent Service resource.

Response

Created

sidstring nullable

The unique string that we created to identify the Session resource.

service_sidstring nullable

The SID of the Service the session is associated with.

account_sidstring nullable

The SID of the Account that created the Session resource.

date_startedstring date-time nullable

The ISO 8601 date when the Session started.

date_endedstring date-time nullable

The ISO 8601 date when the Session ended.

date_last_interactionstring date-time nullable

The ISO 8601 date when the Session last had an interaction.

date_expirystring date-time nullable

The ISO 8601 date when the Session should expire. If this is value is present, it overrides the ttl value.

unique_namestring nullable

An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. This value should not have PII.

status'open' | 'in-progress' | 'closed' | 'failed' | 'unknown'

The status of the Session. Can be: open, in-progress, closed, failed, or unknown.

closed_reasonstring nullable

The reason the Session ended.

ttlinteger

The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.

mode'message-only' | 'voice-only' | 'voice-and-message'

The Mode of the Session. Can be: message-only, voice-only, or voice-and-message.

date_createdstring date-time nullable

The ISO 8601 date and time in GMT when the resource was created.

date_updatedstring date-time nullable

The ISO 8601 date and time in GMT when the resource was last updated.

urlstring uri nullable

The absolute URL of the Session resource.

linksobject nullable

The URLs of resources related to the Session.

Changes

Changed in 4 of the 50 revisions of this API.13