confAudio.md

{% method %}

Conference Audio File Playback Event

Bandwidth API sends this message to the application when audio playback has started or is done (stopped) in a conference. Note: For playback event in conference member, use the call playback event.

Properties

Property	Description
eventType	The event type, value is conference-playback.
conferenceId	The conference id associated with the event.
conferenceUri	The full URL of the conference resource for this event.
status	Values are started or done.
time	Date/time of event. Timestamp follows the ISO8601 format (UTC).

{% common %}

Example JSON

{
    "eventType":"string",
    "conferenceId":"string",
    "conferenceUri":"string",
    "status":"string",
    "time":"date"
}

Example: Audio file playback in conference has started

POST http://[External server URL]

{
    "eventType":"conference-playback",
    "conferenceId":"{conferenceId}",
    "conferenceUri": "https://api.catapult.inetwork.com/v1/users/{userId}/conferences/{conferenceId}",
    "status":"started",
    "time":"2013-07-12T21:18:19.966Z"
}

Example: Audio file playback in conference is done

POST http://[External server URL]

{
    "eventType":"conference-playback",
    "conferenceId":"{conferenceId}",
    "conferenceUri": "https://api.catapult.inetwork.com/v1/users/{userId}/conferences/{conferenceId}",
    "status":"done",
    "time":"2013-07-12T21:18:19.966Z"
}

{% endmethod %}