participant
Applies to: Skype for Business 2015
Represents a remote participant in a conversation.
For more on web links, see Web links.
Name | Description |
---|---|
rel | The resource that this link points to. In JSON, this is the outer container. |
href | The location of this resource on the server, and the target of an HTTP operation. |
title | The display name or normalized phone number of the participant, if available. |
A participant resource is the transient representation of a contact that captures attributes such as role and capabilities (e.g. promoting to leader or admitting from lobby).A participant's lifetime is controlled by the server and starts when the participant is present upon joining an onlineMeeting or added later on to a conversation.This resource is removed when the participant leaves the conversation.
Name | Description |
---|---|
anonymous | Whether the participant is anonymous. |
inLobby | Whether the participant is in the lobby. |
local | Whether the participant is local.The local participant is the same as the user. |
name | The participant's display name. |
organizer | Whether the participant is an organizer.An organizer can never be locked out of her own meeting. |
otherPhoneNumber | The participant's Other Phone. |
role | The participant's role (Role), such as Attendee or Leader. |
sourceNetwork | The participant's source network (SourceNetwork), such as SameEnterprise or PublicCloud (for example, a Skype contact). |
uri | The participant's URI. |
workPhoneNumber | The participant's Phone URI. |
This resource can have the following relationships.
Link | Description |
---|---|
self | The link to the current resource. |
admit | Admits the corresponding participant into the onlineMeeting. |
contact | Represents a person or service that the user can communicate and collaborate with. |
contactPhoto | The photo of a contact. |
contactPresence | Represents a contact's availability and activity. |
conversation | Represents the local participants perspective on a multi-modal, multi-party communication. |
demote | Demotes the corresponding participant from the leader role to the attendee role. |
eject | Ejects the corresponding participant from the onlineMeeting. |
me | Represents the user. |
participantApplicationSharing | Represents whether a participant is using the application sharing modality in a conversation. |
participantAudio | Represents whether a participant is using the audio modality in a conversation. |
participantDataCollaboration | Represents whether a participant is using the data collaboration modality in a conversation. |
participantMessaging | Used to determine whether a participant is using the instant messaging modality in a conversation. |
participantPanoramicVideo | Represents whether a participant is using the panoramic video modality in a conversation. |
participantVideo | Represents whether a participant is using the main video modality in a conversation. |
promote | Promotes the corresponding participant from the attendee role to the leader role. |
reject | Denies the corresponding participant access to the onlineMeeting. |
The user must have at least one of these scopes for operations on the resource to be allowed.
Scope | Permission | Description |
---|---|---|
Conversations.Initiate | Initiate conversations and join meetings | Allows the app to initiate instant messages, audio, video, and desktop sharing conversations; and join meetings on-behalf of the signed-in user |
Conversations.Receive | Receive conversation invites | Allows the app to receive instant messages, audio, video, and desktop sharing invitations on-behalf of the signed-in user |
Resource | Priority | Sender | Reason |
---|---|---|---|
participant | High | conversation | Indicates that the participant has joined the conversation. The application can choose to retrieve the updated information. If an application caches conversation data, the application should rely on this event to decide whether to update the conversation cache.The application will receive this event when the participant is first added to the conversation.Other added events for the same participant indicate that the participant has been admitted to the conference, promoted, demoted, or is typing a message. |
Sample of returned event data. This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.
{
"_links" : {
"self" : {
"href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=1"
},
"next" : {
"href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2"
}
},
"sender" : [
{
"rel" : "conversation",
"href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137",
"events" : [
{
"link" : {
"rel" : "participant",
"href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/participants/196"
},
"type" : "added"
}
]
}
]
}
Resource | Priority | Sender | Reason |
---|---|---|---|
participant | High | conversation | Indicates that the participant has been updated. The application can choose to retrieve the updated information. The application will receive this event when the user's capabilities to admit, promote, or demote a participant have changed. Note that this is the only updated event for a participant.For example, when the user is a leader, the user will lose the capability to admit the participant after the participant is movedfrom being in the lobby to being an attendee. |
Sample of returned event data. This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.
{
"_links" : {
"self" : {
"href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=1"
},
"next" : {
"href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2"
}
},
"sender" : [
{
"rel" : "conversation",
"href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137",
"events" : [
{
"link" : {
"rel" : "participant",
"href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/participants/196"
},
"type" : "updated"
}
]
}
]
}
Resource | Priority | Sender | Reason |
---|---|---|---|
participant | High | conversation | Indicates that the participant has left a conversation. If an application caches conversation data, the application should remove this participant from its conversation cache. |
Sample of returned event data. This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.
{
"_links" : {
"self" : {
"href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=1"
},
"next" : {
"href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2"
}
},
"sender" : [
{
"rel" : "conversation",
"href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137",
"events" : [
{
"link" : {
"rel" : "participant",
"href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/participants/196"
},
"type" : "deleted"
}
]
}
]
}
Returns a representation of the participant resource.
None
The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.
The errors below (if any) are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.
Error | Code | Subcode | Description |
---|---|---|---|
ServiceFailure | 500 | InvalidExchangeServerVersion | Invalid exchange server version.The exchange mailbox of the server might have moved to an unsupported version for the required feature. |
Conflict | 409 | AlreadyExists | The already exists error. |
Conflict | 409 | TooManyGroups | The too many groups error. |
Conflict | 409 | None | Un-supported Service/Resource/API error. |
Gone | 410 | CannotRedirect | Cannot redirect since there is no back up pool configured. |
Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/participants/196 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json
This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2022
{
"rel" : "participant",
"anonymous" : true,
"inLobby" : true,
"local" : true,
"name" : "Joe Smith",
"organizer" : true,
"otherPhoneNumber" : "tel:+14251111111",
"role" : "Attendee",
"sourceNetwork" : "SameEnterprise",
"uri" : "sip:john@contoso.com",
"workPhoneNumber" : "tel:+14251111111",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196"
},
"admit" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/admit"
},
"contact" : {
"href" : "/ucwa/v1/applications/192/people/282"
},
"contactPhoto" : {
"href" : "/ucwa/v1/applications/192/people/282/contactPhoto"
},
"contactPresence" : {
"href" : "/ucwa/v1/applications/192/people/282/contactPresence"
},
"conversation" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137"
},
"demote" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/demote"
},
"eject" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/eject"
},
"me" : {
"href" : "/ucwa/v1/applications/192/me"
},
"participantApplicationSharing" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantApplicationSharing"
},
"participantAudio" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantAudio"
},
"participantDataCollaboration" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantDataCollaboration"
},
"participantMessaging" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantMessaging"
},
"participantPanoramicVideo" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantPanoramicVideo"
},
"participantVideo" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantVideo"
},
"promote" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/promote"
},
"reject" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/reject"
}
}
}
Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/participants/196 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml
This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 2519
<?xml version="1.0" encoding="utf-8"?>
<resource rel="participant" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<link rel="admit" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/admit" />
<link rel="contact" href="/ucwa/v1/applications/192/people/282" />
<link rel="contactPhoto" href="/ucwa/v1/applications/192/people/282/contactPhoto" />
<link rel="contactPresence" href="/ucwa/v1/applications/192/people/282/contactPresence" />
<link rel="conversation" href="/ucwa/v1/applications/192/communication/conversations/137" />
<link rel="demote" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/demote" />
<link rel="eject" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/eject" />
<link rel="me" href="/ucwa/v1/applications/192/me" />
<link rel="participantApplicationSharing" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantApplicationSharing" />
<link rel="participantAudio" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantAudio" />
<link rel="participantDataCollaboration" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantDataCollaboration" />
<link rel="participantMessaging" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantMessaging" />
<link rel="participantPanoramicVideo" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantPanoramicVideo" />
<link rel="participantVideo" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantVideo" />
<link rel="promote" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/promote" />
<link rel="reject" href="/ucwa/v1/applications/192/communication/conversations/137/participants/196/reject" />
<property name="rel">participant</property>
<property name="anonymous">True</property>
<property name="inLobby">True</property>
<property name="local">True</property>
<property name="name">Joe Smith</property>
<property name="organizer">True</property>
<property name="otherPhoneNumber">tel:+14251111111</property>
<property name="role">Attendee</property>
<property name="sourceNetwork">SameEnterprise</property>
<property name="uri">sip:john@contoso.com</property>
<property name="workPhoneNumber">tel:+14251111111</property>
</resource>