Each service-scoped Participant in a Conversation represents one real (probably human) participant in a non-default, service-scoped Conversation.
All URLs in the reference documentation use the following base URL:
_10https://conversations.twilio.com/v1
For Conversations applications that build on more than one Conversation Service instance, you will need to specify the Conversation Service SID (ISxx
) and the Conversation SID (CHxx
) in the REST API call:
_10GET /v1/Services/ISxx/Conversations/CHxx/Messages
The SID of the Conversation Service the Participant resource is associated with.
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 Conversation SDK to communicate. Limited to 256 characters.
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.
Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.
Index of last “read” message in the Conversation for the Participant.
Timestamp of last “read” message in the Conversation for the Participant.
POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants
Creating a Participant joins them to the Conversation, and the connected person will receive all subsequent messages.
The X-Twilio-Webhook-Enabled HTTP request header
true
false
The unique ID of the Conversation for this participant.
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 Conversation SDK to communicate. Limited to 256 characters.
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).
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).
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.
The address of the Twilio phone number that is used in Group MMS.
GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}
A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's identity
rather than the SID.
Fetch a Service-Scoped Participant resource by SID
You can also fetch a Service-Scoped Conversation Participant by their identity
. Pass their identity
as the value for the sid
argument.
Fetch a Service-Scoped Participant resource by identity
GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants
How many resources to return in each list page. The default is 50, and the maximum is 1000.
POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}
The X-Twilio-Webhook-Enabled HTTP request header
true
false
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 Conversation SDK to communicate. Limited to 256 characters.
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.
The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it.
The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it.
Index of last “read” message in the Conversation for the Participant.
Timestamp of last “read” message in the Conversation for the Participant.
DELETE https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}
Deleting a participant removes them from the Conversation; they will receive no new messages after that point.
The X-Twilio-Webhook-Enabled HTTP request header
true
false