Add a new Participant to the Session

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

Add a new Participant to the Session

Path parameters

  • ServiceSid string Required

    The SID of the parent Service resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KS[0-9a-fA-F]{32}$.

  • SessionSid string Required

    The SID of the parent Session resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KC[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

  • Identifier string Required

    The phone number of the Participant.

  • FriendlyName 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 string

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

  • ProxyIdentifierSid string

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PN[0-9a-fA-F]{32}$.

Responses

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KP[0-9a-fA-F]{32}$.

    • session_sid string | null

      The SID of the parent Session resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KC[0-9a-fA-F]{32}$.

    • service_sid string | null

      The SID of the resource's parent Service resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KS[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the Participant resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • friendly_name string | null

      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 string | null

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

    • proxy_identifier string | null

      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 string | null

      The SID of the Proxy Identifier assigned to the Participant.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PN[0-9a-fA-F]{32}$.

    • date_deleted string(date-time) | null

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

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created.

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated.

    • url string(uri) | null

      The absolute URL of the Participant resource.

POST /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
curl \
 --request POST 'https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Identifier=%2B14155551212&FriendlyName=friendly_name'
Request examples
{"Identifier"=>"+14155551212", "FriendlyName"=>"friendly_name"}
{"Identifier"=>"messenger:123456", "FriendlyName"=>"a facebook user", "ProxyIdentifier"=>"messenger:987654532"}
Response examples (201)
{
  "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions"
  },
  "identifier": "+14155551212",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_deleted": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "friendly_name": "friendly_name",
  "proxy_identifier": "+14155559999",
  "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
{
  "sid": "KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "message_interactions": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions"
  },
  "identifier": "messenger:123456",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "session_sid": "KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_deleted": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "friendly_name": "a facebook user",
  "proxy_identifier": "messenger:987654532",
  "proxy_identifier_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}