participant

  • JSON
  • XML

Represents a remote participant in a conversation.

Web link

For more on web links, see Web Links.

Name Description
relThe resource that this link points to. In JSON, this is the outer container.
hrefThe location of this resource on the server, and the target of an HTTP operation.
titleThe display name or normalized phone number of the participant, if available.

Resource description

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.

Properties

Name Description
anonymous Whether the participant is anonymous.
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.

Links

This resource can have the following relationships.

Link Description
selfThe 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 participant's 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.
promote Promotes the corresponding participant from the attendee role to the leader role.
reject Denies the corresponding participant access to the onlineMeeting.

Events

Resource Priority Sender Reason
participantHighconversation 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" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/events?ack=1"
    },
    "next" : {
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/communication/conversations/583",
      "events" : [
        {
          "link" : {
            "rel" : "participant",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/communication/conversations/583/participants/472"
          },
          "type" : "added"
        }
      ]
    }
  ]
}
Resource Priority Sender Reason
participantHighconversation Indicates that the participant has been updated. The application can choose to retrieve the updated information.

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" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/events?ack=1"
    },
    "next" : {
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/communication/conversations/583",
      "events" : [
        {
          "link" : {
            "rel" : "participant",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/communication/conversations/583/participants/472"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}
Resource Priority Sender Reason
participantHighconversation Indicates that the participant has left a conversation.

Sample of returned event data.

{
  "_links" : {
    "self" : {
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/events?ack=1"
    },
    "next" : {
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/communication/conversations/583",
      "events" : [
        {
          "link" : {
            "rel" : "participant",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/551/communication/conversations/583/participants/472"
          },
          "type" : "deleted"
        }
      ]
    }
  ]
}

Operations

Returns a representation of the participant resource.

Request body

None

Response body

The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.

Synchronous errors

The errors below (if any) are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.

Examples

Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/551/communication/conversations/583/participants/472 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json

  

JSON Response

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: 1186
{
  "rel" : "participant",
  "anonymous" : true,
  "name" : "JoeSmith",
  "organizer" : true,
  "otherPhoneNumber" : "tel : +14251111111",
  "role" : "Attendee",
  "sourceNetwork" : "SameEnterprise",
  "uri" : "sip : john@contoso.com",
  "workPhoneNumber" : "tel : +14251111111",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/551/communication/conversations/583/participants/472"
    },
    "admit" : {
      "href" : "/ucwa/v1/applications/551/communication/conversations/583/participants/472/admit"
    },
    "contact" : {
      "href" : "/ucwa/v1/applications/551/people/731"
    },
    "contactPhoto" : {
      "href" : "/ucwa/v1/applications/551/people/731/contactPhoto"
    },
    "contactPresence" : {
      "href" : "/ucwa/v1/applications/551/people/731/contactPresence"
    },
    "conversation" : {
      "href" : "/ucwa/v1/applications/551/communication/conversations/583"
    },
    "demote" : {
      "href" : "/ucwa/v1/applications/551/communication/conversations/583/participants/472/demote"
    },
    "eject" : {
      "href" : "/ucwa/v1/applications/551/communication/conversations/583/participants/472/eject"
    },
    "me" : {
      "href" : "/ucwa/v1/applications/551/me"
    },
    "promote" : {
      "href" : "/ucwa/v1/applications/551/communication/conversations/583/participants/472/promote"
    },
    "reject" : {
      "href" : "/ucwa/v1/applications/551/communication/conversations/583/participants/472/reject"
    }
  }
}
  

Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/551/communication/conversations/583/participants/472 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml

  

XML Response

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: 1585
<?xml version="1.0" encoding="utf-8"?>
<resource rel="participant" href="/ucwa/v1/applications/551/communication/conversations/583/participants/472" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="admit" href="/ucwa/v1/applications/551/communication/conversations/583/participants/472/admit" />
  <link rel="contact" href="/ucwa/v1/applications/551/people/731" />
  <link rel="contactPhoto" href="/ucwa/v1/applications/551/people/731/contactPhoto" />
  <link rel="contactPresence" href="/ucwa/v1/applications/551/people/731/contactPresence" />
  <link rel="conversation" href="/ucwa/v1/applications/551/communication/conversations/583" />
  <link rel="demote" href="/ucwa/v1/applications/551/communication/conversations/583/participants/472/demote" />
  <link rel="eject" href="/ucwa/v1/applications/551/communication/conversations/583/participants/472/eject" />
  <link rel="me" href="/ucwa/v1/applications/551/me" />
  <link rel="promote" href="/ucwa/v1/applications/551/communication/conversations/583/participants/472/promote" />
  <link rel="reject" href="/ucwa/v1/applications/551/communication/conversations/583/participants/472/reject" />
  <property name="rel">participant</property>
  <property name="anonymous">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>