Add a Participant to a Channel

POST /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants

TODO: Resource-level docs

Add a Participant to a Channel.

Path parameters

InteractionSid string Required

The Interaction Sid for the new Channel Participant.
ChannelSid string Required

The Channel Sid for the new Channel Participant.

Body

MediaProperties Required

JSON representing the Media Properties for the new Participant.
Type string Required

Participant type. Can be: agent, customer, supervisor, external or unknown.

Values are supervisor, customer, external, agent, or unknown.

Responses

201

Created
Hide response attributes Show response attributes object
- channel_sid string | null
  
  The Channel Sid for this Participant.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UO[0-9a-fA-F]{32}$.
- interaction_sid string | null
  
  The Interaction Sid for this channel.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KD[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: ^UT[0-9a-fA-F]{32}$.
- type string | null
  
  Participant type.
  
  Values are supervisor, customer, external, agent, or unknown.
- url string(uri) | null

POST /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants

curl \
 -X POST https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Type=supervisor'

Request example

{
  "Type": "supervisor"
}

Request examples

{
  "Type": "supervisor"
}

Response examples (201)

{
  "channel_sid": "string",
  "interaction_sid": "string",
  "sid": "string",
  "type": "supervisor",
  "url": "https://example.com"
}

Response examples (201)

{
  "channel_sid": "string",
  "interaction_sid": "string",
  "sid": "string",
  "type": "supervisor",
  "url": "https://example.com"
}