POST /v1/Conversations/{ConversationSid}/Participants
Add a new participant to the conversation
Servers
- https://conversations.twilio.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
ConversationSid |
String | Yes |
The unique ID of the Conversation for this participant. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
X-Twilio-Webhook-Enabled |
String | No |
The X-Twilio-Webhook-Enabled HTTP request header Possible values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
Identity |
String | No |
A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. |
Attributes |
String | No |
An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned. |
MessagingBinding.ProjectedAddress |
String | No |
The address of the Twilio phone number that is used in Group MMS. Communication mask for the Conversation participant with Identity. |
MessagingBinding.Address |
String | No |
The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the 'identity' field). |
MessagingBinding.ProxyAddress |
String | No |
The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the 'identity' field). |
RoleSid |
String | No |
The SID of a conversation-level Role to assign to the participant. |
DateUpdated |
String | No |
The date that this resource was last updated. |
DateCreated |
String | No |
The date that this resource was created. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.