TWtwilio
ProxyV1Participant

Add a new Participant to the Session

Changed on

Add a new Participant to the Session

post/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants

Request

  • Base URL
    https://proxy.twilio.com
  • URL
    https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
  • Auth
    HTTP basic

Path parameters

ServiceSidstring required

The SID of the parent Service resource.

SessionSidstring required

The SID of the parent Session resource.

Request body application/x-www-form-urlencoded

Identifierstring required

The phone number of the Participant.

FriendlyNamestring

The string that you assigned to describe the participant. This value must be 255 characters or fewer. This value should not have PII.

ProxyIdentifierstring

The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool.

ProxyIdentifierSidstring

The SID of the Proxy Identifier to assign to the Participant.

Response

Created

sidstring nullable

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

session_sidstring nullable

The SID of the parent Session resource.

service_sidstring nullable

The SID of the resource's parent Service resource.

account_sidstring nullable

The SID of the Account that created the Participant resource.

friendly_namestring nullable

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.

identifierstring nullable

The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters.

proxy_identifierstring nullable

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_sidstring nullable

The SID of the Proxy Identifier assigned to the Participant.

date_deletedstring date-time nullable

The ISO 8601 date when the Participant was removed from the session.

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 Participant resource.

linksobject nullable

The URLs to resources related the participant.

Changes