Quick Reliable Conferencing

Attendee

Add a new attendee

Request:

POST /users/{user_id}/conferences/{conference_id}/attendees
Accept: application/xml
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<attendee>
  <phone-number>{phone_number}</phone-number>
  <moderator type="boolean">{moderator}</moderator>
</attendee>

*NOTE: Once you have completed adding attendees to the conference, the conference's state must be changed to pending for the phone calls to the attendees to occur.

Response:

201 Created
Content-Type: application/xml
Location: /users/{user_id}/conferences/{conference_id}/attendees/{attendee_id}

<?xml version="1.0" encoding="UTF-8"?>
<attendee>
  <id type="integer">{attendee_id}</id>
  <created-at type="datetime">{created_at}</created-at>
  <updated-at type="datetime">{updated_at}</updated-at>
  <lock-version type="integer">{lock_version}</lock-version>
  <state>{state}</state>
  <phone-number>{phone_number}</phone-number>
  <moderator type="boolean">{moderator}</moderator>
  <duration type="integer">{duration}</duration>
</attendee>

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  -H 'Content-Type: application/xml' \
  -d '<?xml version="1.0" encoding="UTF-8"?>
      <attendee>
        <phone-number>6045555555</phone-number>
        <moderator type="boolean">true</moderator>
      </attendee>' \
  -X POST \
  http://lypp.com/users/1/conferences/1/attendees

List all attendees

Request:

GET /users/{user_id}/conferences/{conference_id}/attendees
Accept: application/xml

Response:

200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<attendees type="array">
  <attendee>
    <id type="integer">{attendee_id}</id>
    <created-at type="datetime">{created_at}</created-at>
    <updated-at type="datetime">{updated_at}</updated-at>
    <lock-version type="integer">{lock_version}</lock-version>
    <state>{state}</state>
    <phone-number>{phone_number}</phone-number>
    <moderator type="boolean">{moderator}</moderator>
    <duration type="integer">{duration}</duration>
  </attendee>
  ...
</attendees>

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  http://lypp.com/users/1/conferences/1/attendees

Show an attendee

Request:

GET /users/{user_id}/conferences/{conference_id}/attendees/{attendee_id}
Accept: application/xml

Response:

200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<attendee>
  <id type="integer">{attendee_id}</id>
  <created-at type="datetime">{created_at}</created-at>
  <updated-at type="datetime">{updated_at}</updated-at>
  <lock-version type="integer">{lock_version}</lock-version>
  <state>{state}</state>
  <phone-number>{phone_number}</phone-number>
  <moderator type="boolean">{moderator}</moderator>
  <duration type="integer">{duration}</duration>
</attendee>

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  http://lypp.com/users/1/conferences/1/attendees/1

Update an attendee

Request:

PUT /users/{user_id}/conferences/{conference_id}/attendees/{attendee_id}
Accept: application/xml
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<attendee>
  <phone-number>{phone_number}</phone-number>
  <moderator type="boolean">{moderator}</moderator>
</attendee>

Response:

200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<attendee>
  <id type="integer">{attendee_id}</id>
  <created-at type="datetime">{created_at}</created-at>
  <updated-at type="datetime">{updated_at}</updated-at>
  <lock-version type="integer">{lock_version}</lock-version>
  <state>{state}</state>
  <phone-number>{phone_number}</phone-number>
  <moderator type="boolean">{moderator}</moderator>
  <duration type="integer">{duration}</duration>
</attendee>

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  -H 'Content-Type: application/xml' \
  -d '<?xml version="1.0" encoding="UTF-8"?>
      <attendee>
        <phone-number>6045555555</phone-number>
        <moderator type="boolean">true</moderator>
      </attendee>' \
  -X PUT \
  http://lypp.com/users/1/conferences/1/attendees/1

Delete an attendee

Request:

DELETE /users/{user_id}/conferences/{conference_id}/attendees/{attendee_id}
Accept: application/xml

Response:

204 No Content

Example:

curl \
  -u username:password \
  -H 'Accept: application/xml' \
  -X DELETE \
  http://lypp.com/users/1/conferences/1/attendees/1