Add a new Participant to the Session

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

TODO: Resource-level docs

Add a new Participant to the Session

Path parameters

Body

  • FailOnParticipantConflict boolean

    [Experimental] For accounts with the ProxyAllowParticipantConflict account flag, setting to true enables per-request opt-in to allowing Proxy to reject a Participant create request that could cause the same Identifier/ProxyIdentifier pair to be active in multiple Sessions. Depending on the context, this could be a 409 error (Twilio error code 80623) or a 400 error (Twilio error code 80604). If not provided, requests will be allowed to succeed and a Debugger notification (80802) will be emitted. Having multiple, active Participants with the same Identifier/ProxyIdentifier pair causes calls and messages from affected Participants to be routed incorrectly. Please note, the default behavior for accounts without the ProxyAllowParticipantConflict flag is to reject the request as described. This will eventually be the default for all accounts.

  • 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.

  • Identifier string Required

    The phone number of the Participant.

  • 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

    Created

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

      The SID of the Account that created the resource

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

    • date_created string(date-time) | null

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

    • date_deleted string(date-time) | null

      The ISO 8601 date the Participant was removed

    • date_updated string(date-time) | null

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

    • friendly_name string | null

      The string that you assigned to describe the participant

    • identifier string | null

      The phone number or channel identifier of the Participant

    • links object(uri-map) | null

      The URLs to resources related the participant

    • proxy_identifier string | null

      The phone number or short code of the participant's partner

    • 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}$.

    • service_sid string | null

      The SID of the resource's parent Service

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

    • session_sid string | null

      The SID of the resource's parent Session

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

    • sid string | null

      The unique string that identifies the resource

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

    • url string(uri) | null

      The absolute URL of the Participant resource
POST /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants 
curl \
 -X POST https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'FailOnParticipantConflict=true&FriendlyName=string&Identifier=string&ProxyIdentifier=string&ProxyIdentifierSid=string'
Request example 
{
  "FailOnParticipantConflict": true,
  "FriendlyName": "string",
  "Identifier": "string",
  "ProxyIdentifier": "string",
  "ProxyIdentifierSid": "string"
}
Request examples 
{
  "FailOnParticipantConflict": true,
  "FriendlyName": "string",
  "Identifier": "string",
  "ProxyIdentifier": "string",
  "ProxyIdentifierSid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_deleted": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "identifier": "string",
  "links": {},
  "proxy_identifier": "string",
  "proxy_identifier_sid": "string",
  "service_sid": "string",
  "session_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_deleted": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "identifier": "string",
  "links": {},
  "proxy_identifier": "string",
  "proxy_identifier_sid": "string",
  "service_sid": "string",
  "session_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}