Session Resource
Proxy Public Beta is not available to new customers
Proxy Public Beta is currently closed for new customers. Please consider using Twilio Conversations and Programmable Voice directly if you are building your masking application.
Public Beta for customers already using Proxy
Twilio's Proxy API is currently available as a Public Beta product. Some features are not yet implemented and others may be changed before the product is declared as Generally Available.
Public Beta products are not covered by a Twilio SLA.
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
The unique string that we created to identify the Session resource.
^KC[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Service the session is associated with.
^KS[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Account that created the Session resource.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The ISO 8601 date when the Session last had an interaction.
The ISO 8601 date when the Session should expire. If this is value is present, it overrides the ttl value.
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.
The status of the Session. Can be: open, in-progress, closed, failed, or unknown.
openin-progressclosedfailedunknownThe time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.
0The Mode of the Session. Can be: message-only, voice-only, or voice-and-message.
message-onlyvoice-onlyvoice-and-messageThe ISO 8601 date and time in GMT when the resource was created.
The ISO 8601 date and time in GMT when the resource was last updated.
The URLs of resources related to the Session.
POST https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions
Create a new Session.
application/x-www-form-urlencodedAn 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.
The ISO 8601 date when the Session should expire. If this is value is present, it overrides the ttl value.
The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.
The Mode of the Session. Can be: message-only, voice-only, or voice-and-message.
message-onlyvoice-onlyvoice-and-messageThe status of the Session. Can be: open, in-progress, closed, failed, or unknown.
openin-progressclosedfailedunknownThe Participant objects to include in the new session.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function createSession() {11const session = await client.proxy.v112.services("KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.sessions.create();1415console.log(session.sid);16}1718createSession();
Response
1{2"service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"status": "open",4"unique_name": "Order #1234",5"date_started": "2015-07-30T20:00:00Z",6"date_ended": "2015-07-30T20:00:00Z",7"date_last_interaction": "2015-07-30T20:00:00Z",8"date_expiry": "2015-07-30T20:00:00Z",9"ttl": 3600,10"mode": "voice-and-message",11"closed_reason": "",12"sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",13"date_updated": "2015-07-30T20:00:00Z",14"date_created": "2015-07-30T20:00:00Z",15"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",16"url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",17"links": {18"interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions",19"participants": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"20}21}
GET https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{Sid}
Retrieve a single Session.
The SID of the parent Service of the resource to fetch.
^KS[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the Session resource to fetch.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function fetchSession() {11const session = await client.proxy.v112.services("KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.sessions("Sid")14.fetch();1516console.log(session.sid);17}1819fetchSession();
Response
1{2"service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"status": "open",4"unique_name": "Order #1234",5"date_started": "2015-07-30T20:00:00Z",6"date_ended": "2015-07-30T20:00:00Z",7"date_last_interaction": "2015-07-30T20:00:00Z",8"date_expiry": "2015-07-30T20:00:00Z",9"ttl": 3600,10"mode": "voice-and-message",11"closed_reason": "",12"sid": "Sid",13"date_updated": "2015-07-30T20:00:00Z",14"date_created": "2015-07-30T20:00:00Z",15"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",16"url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",17"links": {18"interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions",19"participants": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"20}21}
GET https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions
Retrieve a list of all Sessions for a given Service.
How many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listSession() {11const sessions = await client.proxy.v112.services("KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.sessions.list({ limit: 20 });1415sessions.forEach((s) => console.log(s.sid));16}1718listSession();
Response
1{2"sessions": [],3"meta": {4"previous_page_url": null,5"next_page_url": null,6"url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0",7"page": 0,8"first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0",9"page_size": 50,10"key": "sessions"11}12}
POST https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{Sid}
Post updates to a given Session.
The SID of the parent Service of the resource to update.
^KS[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the Session resource to update.
^KC[0-9a-fA-F]{32}$Min length: 34Max length: 34application/x-www-form-urlencodedThe ISO 8601 date when the Session should expire. If this is value is present, it overrides the ttl value.
The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.
The status of the Session. Can be: open, in-progress, closed, failed, or unknown.
openin-progressclosedfailedunknown1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function updateSession() {11const session = await client.proxy.v112.services("KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")13.sessions("KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")14.update({15dateExpiry: new Date("2009-07-06 20:30:00"),16status: "in-progress",17});1819console.log(session.sid);20}2122updateSession();
Response
1{2"service_sid": "KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",3"status": "in-progress",4"unique_name": "Order #1234",5"date_started": "2015-07-30T20:00:00Z",6"date_ended": "2015-07-30T20:00:00Z",7"date_last_interaction": "2015-07-30T20:00:00Z",8"date_expiry": "2009-07-06T20:30:00Z",9"ttl": 3600,10"mode": "voice-and-message",11"closed_reason": "",12"sid": "KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",13"date_updated": "2015-07-30T20:00:00Z",14"date_created": "2015-07-30T20:00:00Z",15"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",16"url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",17"links": {18"interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions",19"participants": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants"20}21}
DELETE https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{Sid}
Deleting a Session removes it permanently. Related Participants and Interactions will also be deleted.
Danger
Any Message or Call logs created during interactions for this Session will be deleted automatically after 90 days of the Session being closed, as per our Session retention policy. If you want to delete these resources before then, you must issue 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.
The SID of the parent Service of the resource to delete.
^KS[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the Session resource to delete.
^KC[0-9a-fA-F]{32}$Min length: 34Max length: 341// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function deleteSession() {11await client.proxy.v112.services("KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.sessions("KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")14.remove();15}1617deleteSession();