Participant
A Participant is a single individual communicating in a Session. There is a limit of two Participants per Session.
You can create a Proxy Participant in two ways:
-
By specifying the private Phone Number of the Participant (Identifier) and relying on Proxy to select an appropriate Phone Number from the Proxy Number pool. The Proxy Number returned (Proxy Identifier) is the Phone Number that the Participant should call to reach the other party.
-
By specifying both the Identifier and the Proxy Identifier. In this case, Proxy will attempt to use the Twilio Phone Number provided.
Note:
The Twilio Phone Number specified must already be added to the Proxy Number pool in order to be accepted.
Resource properties
sid
type: SID<KP>
The unique string that we created to identify the Participant resource.
Pattern:
^KP[0-9a-fA-F]{32}$
friendly_name
type: string
The string that you assigned to describe the participant. This value must be 255 characters or fewer. Supports UTF-8 characters. This value should not have PII.
identifier
type: string
The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters.
proxy_identifier
type: string
The phone number or short code (masked number) of the participant's partner. The participant will call or message the partner participant at this number.
proxy_identifier_sid
type: SID<PN>
The SID of the Proxy Identifier assigned to the Participant.
Pattern:
^PN[0-9a-fA-F]{32}$
date_deleted
type: string<date-time>
date_created
type: string<date-time>
date_updated
type: string<date-time>
url
type: string<uri>
The absolute URL of the Participant resource.
links
type: object<uri-map>
The URLs to resources related the participant.
POST https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
URI parameters
Request body parameters
Identifier
type: stringRequired
The phone number of the Participant.
FriendlyName
type: string
The string that you assigned to describe the participant. This value must be 255 characters or fewer. This value should not have PII.
ProxyIdentifier
type: string
The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool.
ProxyIdentifierSid
type: SID<PN>
The SID of the Proxy Identifier to assign to the Participant.
Pattern:
^PN[0-9a-fA-F]{32}$
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.proxy.v1.services('KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .sessions('KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .create({friendlyName: 'Alice', identifier: '+15558675310'})
_12 .then(participant => console.log(participant.proxyIdentifier));
_17 "sid": "KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "session_sid": "KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "service_sid": "KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "identifier": "+15558675310",
_17 "proxy_identifier": "+14155559999",
_17 "proxy_identifier_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "friendly_name": "Alice",
_17 "date_deleted": "2015-07-30T20:00:00Z",
_17 "date_updated": "2015-07-30T20:00:00Z",
_17 "date_created": "2015-07-30T20:00:00Z",
_17 "url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Sessions/KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "message_interactions": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Sessions/KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/MessageInteractions"
GET https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}
URI parameters
Sid
type: SID<KP>
The Twilio-provided string that uniquely identifies the Participant resource to fetch.
Pattern:
^KP[0-9a-fA-F]{32}$
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.proxy.v1.services('KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .sessions('KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .participants('KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(participant => console.log(participant.friendlyName));
_17 "sid": "KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "session_sid": "KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "service_sid": "KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "identifier": "+14155551212",
_17 "proxy_identifier": "+14155559999",
_17 "proxy_identifier_sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "friendly_name": "friendly_name",
_17 "date_deleted": "2015-07-30T20:00:00Z",
_17 "date_updated": "2015-07-30T20:00:00Z",
_17 "date_created": "2015-07-30T20:00:00Z",
_17 "url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Sessions/KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17 "message_interactions": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Sessions/KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants/KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/MessageInteractions"
GET https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
URI parameters
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
In order to add a new Participant in a Session, you can DELETE
an existing Participant and then add a new one.
Danger
Adding a participant that was removed is not possible.
Proxy will return with error 80103 if the new participant's identifier matches the deleted participant's identifier.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.proxy.v1.services('KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .sessions('KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(participants => participants.forEach(p => console.log(p.sid)));
_12 "previous_page_url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Sessions/KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?PageSize=50&Page=0",
_12 "next_page_url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Sessions/KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?PageSize=50&Page=1",
_12 "url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Sessions/KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?PageSize=50&Page=0",
_12 "first_page_url": "https://proxy.twilio.com/v1/Services/KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Sessions/KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants?PageSize=50&Page=0",
_12 "key": "participants"
DELETE https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}
URI parameters
Sid
type: SID<KP>
The Twilio-provided string that uniquely identifies the Participant resource to delete.
Pattern:
^KP[0-9a-fA-F]{32}$
_11// Download the helper library from https://www.twilio.com/docs/node/install
_11// Find your Account SID and Auth Token at twilio.com/console
_11// and set the environment variables. See http://twil.io/secure
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.proxy.v1.services('KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .sessions('KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11 .participants('KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')