Session

A Session is a single instance of two individuals communicating. It belongs to a Service and maps two Participants for a Proxy application. Sessions allow you to:

Specify a unique identifier relevant to your use case, such as a job ID
See whether a given Session is closed or not and the reason it has been closed
Control the length of time the Session should be active

Session properties

Names in PHP format
`sid`	sid<KC> Not PII A 34 character string that uniquely identifies this Session.
`serviceSid`	sid<KS> Not PII The unique SID identifier of the Service.
`accountSid`	sid<AC> Not PII The unique SID identifier of the Account.
`dateStarted`	date_time<iso8601> Not PII The date that this Session was started, given in ISO 8601 format.
`dateEnded`	date_time<iso8601> Not PII The date that this Session was ended, given in ISO 8601 format.
`dateLastInteraction`	date_time<iso8601> Not PII The date that this Session last had an interaction, given in ISO 8601 format.
`dateExpiry`	date_time<iso8601> Not PII The date that this Session should expire, given in ISO 8601 format. If this is populated, it takes precedence over TTL values.
`uniqueName`	string Not PII An optional unique name or identifier for this Session, assigned by the developer, up to 255 characters. Should not contain PII.
`status`	enum:status Not PII The Status of this Session. One of `in-progress`, `closed`, `failed`, `unknown`.
`closedReason`	string Not PII The reason this Session ended.
`ttl`	integer Not PII The time, in seconds, after the latest of Session create time or the Session's last Interaction time at which the session will expire.
`mode`	enum:mode Not PII The Mode of this Session. One of `message-only`, `voice-only` or `voice-and-message`.
`dateCreated`	date_time<iso8601> Not PII The date that this Session was created, given in ISO 8601 format.
`dateUpdated`	date_time<iso8601> Not PII The date that this Session was last updated, given in ISO 8601 format.
`url`	url Not PII The URL of this resource.
`links`	uri_map Not PII Contains a dictionary of URL links to nested resources of this Session.

Create a Session resource

post

https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions

Create a new Session.

Parameters

Names in None format
`service_sid` Required	post sid<KS> Not PII The unique SID identifier of the parent Service.
`unique_name` Optional	post string Not PII Your unique identifier for this Session such as a Job ID or conversation ID. Should not contain PII.
`date_expiry` Optional	post date_time<iso8601> Not PII An absolute time (ISO 8601) in the future at which this Session should close. If this is populated, it takes precedence over TTL values.
`ttl` Optional	post integer Not PII The time, in seconds, after the latest of Session create time or the Session's last Interaction time at which the session will expire.
`mode` Optional	post enum:mode Not PII The type of communications mediums allowed on a Session. Defaults to `voice-and-message`. Other options are `voice-only` or `message-only`.
`status` Optional	post enum:status Not PII Set this value to `closed` to close the session. A Session can be re-opened by posting to a closed session with the value `in-progress`. This will be `open` by default on create.

Example

Loading Code Sample...

Output

Create Session

Fetch a Session resource

get

https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{Sid}

Retrieve a single Session.

Parameters

Names in None format

service_sid

Required

get sid<KS> Not PII

The unique SID identifier of the parent Service.

sid

Required

get sid_like<KC> Not PII

A 34 character string that uniquely identifies this Session.

Example

Loading Code Sample...

Output

Fetch Session

Read multiple Session resources

get

https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions

Retrieve a list of all Sessions for a given Service.

Parameters

Names in None format

service_sid

Required

get sid<KS> Not PII

The unique SID identifier of the parent Service.

Example

Loading Code Sample...

Output

Read Session

Update a Session resource

post

https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{Sid}

Post updates to a given Session.

Parameters

Names in None format
`service_sid` Required	post sid<KS> Not PII The unique SID identifier of the parent Service.
`sid` Required	post sid<KC> Not PII A 34 character string that uniquely identifies this Session.
`date_expiry` Optional	post date_time<iso8601> Not PII The date that this Session should expire, given in ISO 8601 format.
`ttl` Optional	post integer Not PII The time, in seconds, after the latest of Session create time or the Session's last Interaction time at which the session will expire.
`status` Optional	post enum:status Not PII The Status of this Session. Set to `in-progress` to re-open a session or `closed` to close a session.

Example 1

Loading Code Sample...

Output

Update a Session

Delete a Session resource

delete

https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{Sid}

Deleting a Session removes it permanently. Related Participants and Interactions will also be deleted.

Any Message or Call records created during interactions for this Session will NOT be deleted automatically. If you want to delete all related Message/Call resources, you must issue direct DELETE requests for the inbound and outbound resources of all child Interactions directly. Once you have deleted a Session, those resource Sids will not be discoverable via Proxy.

Parameters

Names in None format

service_sid

Required

delete sid<KS> Not PII

The unique SID identifier of the parent Service.

sid

Required

delete sid<KC> Not PII

A 34 character string that uniquely identifies this Session.

Example

Loading Code Sample...

Output

Delete Session

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

Loading Code Sample...

Output