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 REST API format | |
|---|---|
sid
|
The unique string that we created to identify the Session resource. |
service_sid
|
The SID of the Service the session is associated with. |
account_sid
|
The SID of the Account that created the Session resource. |
date_started
|
The ISO 8601 date when the Session started. |
date_ended
|
The ISO 8601 date when the Session ended. |
date_last_interaction
|
The ISO 8601 date when the Session last had an interaction. |
date_expiry
|
The ISO 8601 date when the Session should expire. If this is value is present, it overrides the |
unique_name
|
An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. This value should not have PII. |
status
|
The status of the Session. Can be: |
closed_reason
|
The reason the Session ended. |
ttl
|
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
|
The Mode of the Session. Can be: |
date_created
|
The ISO 8601 date and time in GMT when the resource was created. |
date_updated
|
The ISO 8601 date and time in GMT when the resource was last updated. |
url
|
The absolute URL of the Session resource. |
links
|
The URLs of resources related to the Session. |
Create a Session resource
https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions
Create a new Session.
Parameters
| Names in None format | |
|---|---|
service_sid
Required
|
The SID of the parent Service resource. |
unique_name
Optional
|
An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. This value should not have PII. |
date_expiry
Optional
|
The ISO 8601 date when the Session should expire. If this is value is present, it overrides the |
ttl
Optional
|
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
Optional
|
The Mode of the Session. Can be: |
status
Optional
|
The initial status of the Session. Can be: |
participants
Optional
|
The Participant objects to include in the new session. |
Example
Fetch a Session resource
https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{Sid}
Retrieve a single Session.
Parameters
| Names in None format | |
|---|---|
service_sid
Required
|
The SID of the parent Service of the resource to fetch. |
sid
Required
|
The Twilio-provided string that uniquely identifies the Session resource to fetch. |
Example
Read multiple Session resources
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
|
The SID of the parent Service of the resource to read. |
Example
Update a Session resource
https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{Sid}
Post updates to a given Session.
Parameters
| Names in None format | |
|---|---|
service_sid
Required
|
The SID of the parent Service of the resource to update. |
sid
Required
|
The Twilio-provided string that uniquely identifies the Session resource to update. |
date_expiry
Optional
|
The ISO 8601 date when the Session should expire. If this is value is present, it overrides the |
ttl
Optional
|
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
Optional
|
The Mode of the Session. Can be: |
status
Optional
|
The new status of the resource. Can be: |
participants
Optional
|
The Participant objects to include in the session. |
Example 1
Delete a Session resource
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
|
The SID of the parent Service of the resource to delete. |
sid
Required
|
The Twilio-provided string that uniquely identifies the Session resource to delete. |
Example
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.