Simpler Smarter Communications

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>
  <extension>{extension}</extension>
  <phone-number-location>{phone_number_location}</phone-number-location>
  <email>{email}</email>
  <name>{name}</name>
  <dial-in type="boolean">{dial_in}</dial-in>
  <moderator type="boolean">{moderator}</moderator>
</attendee>

Below is a description of these elements:

dial-in (Optional)

Attribute is set by default to false. If this attribute is set to true the attendee will no be called when the conference begins but will still receive the Lypp email notifications if the parent conference has its send-notification-emails set to true.

email (Optional)

Used to email conference notifications to the attendee if the parent conference has its send-notification-emails set to true.

extension (Optional)

Used to dial extensions and navigate IVR systems while calling attendees.

moderator (Optional)

Attribute is set by default to false. The moderator has access to more advanced control of the conference through DTMF tones and is also the trigger for many conference events such as stopping hold music on entry the conference and ending the conference on disconnect. There can only be a single moderator in a conference.

name (Optional)

Used for identifying the attendee in outgoing emails and for display purposes in areas such as the Lypp moderator console.

phone-number (Optional if dial-in is true)

Currently limited to North American phone numbers. The attendee will be called at this number when the conference starts or immediately if the conference is already in progress.

phone-number-location (Optional)

Used for display purposes in areas such as the Lypp moderator console.

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-subscriber-number>{phone_number_subscriber_number}</phone-number-subscriber-number>
  <moderator type="boolean">{moderator}</moderator>
  <phone-number-extension>{phone_number_extension}</phone-number-extension>
  <muted type="boolean" nil="true"></muted>
  <hand-up type="boolean" nil="true"></hand-up>
  <dial-in type="boolean">{dial_in}</dial-in>
  <phone-number-location>{phone_number_location}</phone-number-location>
  <phone-number-country-code>{phone_number_country_code}</phone-number-country-code>
  <name nil="true"></name>
  <email nil="true"></email>
  <duration type="integer" nil="true"></duration>
</attendee>

Example:

curl \
  -X POST \
  -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>
        <extension>123</extension>
        <phone-number-location>home</phone-number-location>
        <dial-in type="boolean">false</dial-in>
        <moderator type="boolean">true</moderator>
      </attendee>' \
  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-subscriber-number>{phone_number_subscriber_number}</phone-number-subscriber-number>
    <moderator type="boolean">{moderator}</moderator>
    <phone-number-extension>{phone_number_extension}</phone-number-extension>
    <muted type="boolean">{muted}</muted>
    <hand-up type="boolean">{hand_up}</hand-up>
    <dial-in type="boolean">{dial_in}</dial-in>
    <phone-number-location>{phone_number_location}</phone-number-location>
    <phone-number-country-code>{phone_number_country_code}</phone-number-country-code>
    <name>{name}</name>
    <email>{email}</email>
    <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-subscriber-number>{phone_number_subscriber_number}</phone-number-subscriber-number>
  <moderator type="boolean">{moderator}</moderator>
  <phone-number-extension>{phone_number_extension}</phone-number-extension>
  <muted type="boolean">{muted}</muted>
  <hand-up type="boolean">{hand_up}</hand-up>
  <dial-in type="boolean">{dial_in}</dial-in>
  <phone-number-location>{phone_number_location}</phone-number-location>
  <phone-number-country-code>{phone_number_country_code}</phone-number-country-code>
  <name>{name}</name>
  <email>{email}</email>
  <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>
  <extension>{extension}</extension>
  <phone-number-location>{phone_number_location}</phone-number-location>
  <dial-in type="boolean">{dial_in}</dial-in>
  <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-subscriber-number>{phone_number_subscriber_number}</phone-number-subscriber-number>
  <moderator type="boolean">{moderator}</moderator>
  <phone-number-extension>{phone_number_extension}</phone-number-extension>
  <muted type="boolean">{muted}</muted>
  <hand-up type="boolean">{hand_up}</hand-up>
  <dial-in type="boolean">{dial_in}</dial-in>
  <phone-number-location>{phone_number_location}</phone-number-location>
  <phone-number-country-code>{phone_number_country_code}</phone-number-country-code>
  <name>{name}</name>
  <email>{email}</email>
  <duration type="integer">{duration}</duration>
</attendee>

Example:

curl \
  -X PUT \
  -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>
        <extension>123</extension>
        <phone-number-location>home</phone-number-location>
        <dial-in type="boolean">false</dial-in>
        <moderator type="boolean">true</moderator>
      </attendee>' \
  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 \
  -X DELETE \
  -u username:password \
  -H 'Accept: application/xml' \
  http://lypp.com/users/1/conferences/1/attendees/1