diff --git a/_data/getMeetingSummary.yml b/_data/getMeetingSummary.yml new file mode 100644 index 00000000..7d1db860 --- /dev/null +++ b/_data/getMeetingSummary.yml @@ -0,0 +1,4 @@ +- name: "recordID" + required: true + type: "String" + description: "A single recording ID to retrieve the events for. (Unlike other recording APIs, you cannot provide a comma-separated list of recordings.)" diff --git a/_data/getRecordingTextTracks.yml b/_data/getRecordingTextTracks.yml index 3c51da5f..a025b5c9 100644 --- a/_data/getRecordingTextTracks.yml +++ b/_data/getRecordingTextTracks.yml @@ -1,4 +1,14 @@ - name: "recordID" required: true type: "String" - description: "A single recording ID to retrieve the available captions for. (Unlike other recording APIs, you cannot provide a comma-separated list of recordings.)" \ No newline at end of file + description: "A single recording ID to retrieve the available captions for. (Unlike other recording APIs, you cannot provide a comma-separated list of recordings.)" + +- name: "page" + required: false + type: "Integer" + description: "The page number that you wish to retrieve. By default the first page (page 0) is returned." + +- name: "size" + required: false + type: "Integer" + description: "The maximum number of recording text tracks that should be returned per page. By default at most 25 recording text tracks are included in each page." diff --git a/_data/getRecordings.yml b/_data/getRecordings.yml index 6707a128..6643ec3d 100644 --- a/_data/getRecordings.yml +++ b/_data/getRecordings.yml @@ -16,4 +16,14 @@ - name: "meta" required: false type: "String" - description: "You can pass one or more metadata values to filter the recordings returned. The format of these parameters is the same as the metadata passed to the create call. For more information see the docs for the create call." \ No newline at end of file + description: "You can pass one or more metadata values to filter the recordings returned. The format of these parameters is the same as the metadata passed to the create call. For more information see the docs for the create call." + +- name: "page" + required: false + type: "Integer" + description: "The page number that you wish to retrieve. By default the first page (page 0) is returned." + +- name: "size" + required: false + type: "Integer" + description: "The maximum number of recordings that should be returned per page. By default at most 25 recordings are included in each page." diff --git a/_posts/dev/2015-04-05-api.md b/_posts/dev/2015-04-05-api.md index c4f7718e..29e3e132 100755 --- a/_posts/dev/2015-04-05-api.md +++ b/_posts/dev/2015-04-05-api.md @@ -666,7 +666,7 @@ Retrieves the recordings that are available for playback for a given meetingID ( **Resource URL:** -http://yourserver.com/bigbluebutton/api/getRecordings?[parameters]&checksum=[checksum] +http://yourserver.com/bigbluebutton/api/v1/getRecordings?[parameters]&checksum=[checksum] **Parameters:** @@ -674,13 +674,14 @@ http://yourserver.com/bigbluebutton/api/getRecordings?[parameters]&checksum= **Example Requests:** -- http://yourserver.com/bigbluebutton/api/getRecordings?checksum=1234 -- http://yourserver.com/bigbluebutton/api/getRecordings?meetingID=CS101&checksum=abcd -- http://yourserver.com/bigbluebutton/api/getRecordings?meetingID=CS101,CS102&checksum=wxyz -- http://yourserver.com/bigbluebutton/api/getRecordings?recordID=652c9eb4c07ad49283554c76301d68770326bd93-1462283509434&checksum=wxyz -- http://yourserver.com/bigbluebutton/api/getRecordings?recordID=652c9eb4c07ad49283554c76301d68770326bd93-1462283509434,9e359d17635e163c4388281567601d7fecf29df8-1461882579628&checksum=wxyz -- http://yourserver.com/bigbluebutton/api/getRecordings?recordID=652c9eb4c07ad49283554c76301d68770326bd93&checksum=wxyz -- http://yourserver.com/bigbluebutton/api/getRecordings?recordID=652c9eb4c07ad49283554c76301d68770326bd93,9e359d17635e163c4388281567601d7fecf29df8&checksum=wxyz +- http://yourserver.com/bigbluebutton/api/v1/getRecordings?checksum=1234 +- http://yourserver.com/bigbluebutton/api/v1/getRecordings?meetingID=CS101&checksum=abcd +- http://yourserver.com/bigbluebutton/api/v1/getRecordings?meetingID=CS101,CS102&checksum=wxyz +- http://yourserver.com/bigbluebutton/api/v1/getRecordings?recordID=652c9eb4c07ad49283554c76301d68770326bd93-1462283509434&checksum=wxyz +- http://yourserver.com/bigbluebutton/api/v1/getRecordings?recordID=652c9eb4c07ad49283554c76301d68770326bd93-1462283509434,9e359d17635e163c4388281567601d7fecf29df8-1461882579628&checksum=wxyz +- http://yourserver.com/bigbluebutton/api/v1/getRecordings?recordID=652c9eb4c07ad49283554c76301d68770326bd93&checksum=wxyz +- http://yourserver.com/bigbluebutton/api/v1/getRecordings?recordID=652c9eb4c07ad49283554c76301d68770326bd93,9e359d17635e163c4388281567601d7fecf29df8&checksum=wxyz +- http://yourserver.com/bigbluebutton/api/v1/getRecordings?recordID=652c9eb4c07ad49283554c76301d68770326bd93,9e359d17635e163c4388281567601d7fecf29df8&page=0&size=5&checksum=wxyz **Example Response:** @@ -769,6 +770,25 @@ Here the `getRecordings` API call returned back two recordings for the meetingID + + + + true + false + true + + 0 + 25 + 0 + true + false + + 2 + true + 1 + true + false + ``` @@ -778,7 +798,7 @@ Publish and unpublish recordings for a given recordID (or set of record IDs). **Resource URL:** -- http://yourserver.com/bigbluebutton/api/publishRecordings?[parameters]&checksum=[checksum] +- http://yourserver.com/bigbluebutton/api/v1/publishRecordings?[parameters]&checksum=[checksum] **Parameters:** @@ -786,8 +806,8 @@ Publish and unpublish recordings for a given recordID (or set of record IDs). **Example Requests:** -- http://yourserver.com/bigbluebutton/api/publishRecordings?recordID=record123&publish=true&checksum=1234 -- http://yourserver.com/bigbluebutton/api/publishRecordings?recordID=record123,recordABC&publish=true&checksum=wxyz +- http://yourserver.com/bigbluebutton/api/v1/publishRecordings?recordID=record123&publish=true&checksum=1234 +- http://yourserver.com/bigbluebutton/api/v1/publishRecordings?recordID=record123,recordABC&publish=true&checksum=wxyz **Example Response:** @@ -804,7 +824,7 @@ Delete one or more recordings for a given recordID (or set of record IDs). **Resource URL:** -http://yourserver.com/bigbluebutton/api/deleteRecordings?[parameters]&checksum=[checksum] +http://yourserver.com/bigbluebutton/api/v1/deleteRecordings?[parameters]&checksum=[checksum] **Parameters:** @@ -812,8 +832,8 @@ http://yourserver.com/bigbluebutton/api/deleteRecordings?[parameters]&checks **Example Requests:** -- http://yourserver.com/bigbluebutton/api/deleteRecordings?recordID=record123&checksum=1234 -- http://yourserver.com/bigbluebutton/api/deleteRecordings?recordID=record123,recordABC&checksum=wxyz +- http://yourserver.com/bigbluebutton/api/v1/deleteRecordings?recordID=record123&checksum=1234 +- http://yourserver.com/bigbluebutton/api/v1/deleteRecordings?recordID=record123,recordABC&checksum=wxyz **Example Response:** @@ -830,7 +850,7 @@ Update metadata for a given recordID (or set of record IDs). Available since ver **Resource URL:** -- http://yourserver.com/bigbluebutton/api/updateRecordings?[parameters]&checksum=[checksum] +- http://yourserver.com/bigbluebutton/api/v1/updateRecordings?[parameters]&checksum=[checksum] **Parameters:** @@ -838,7 +858,7 @@ Update metadata for a given recordID (or set of record IDs). Available since ver **Example Requests:** -- http://yourserver.com/bigbluebutton/api/updateRecordings?recordID=record123&meta_Presenter=Jane%20Doe,meta_category=FINANCE,meta_TERM=Fall2016&checksum=1234 +- http://yourserver.com/bigbluebutton/api/v1/updateRecordings?recordID=record123&meta_Presenter=Jane%20Doe,meta_category=FINANCE,meta_TERM=Fall2016&checksum=1234 **Example Response:** @@ -855,7 +875,7 @@ Get a list of the caption/subtitle files currently available for a recording. It **Resource URL:** -`GET http://yourserver.com/bigbluebutton/api/getRecordingTextTracks?[parameters]&checksum=[checksum]` +`GET http://yourserver.com/bigbluebutton/api/v1/getRecordingTextTracks?[parameters]&checksum=[checksum]` **Parameters:** @@ -867,24 +887,49 @@ An example response looks like the following: ```json { - "response": { - "returncode": "SUCCESS", - "tracks": [ - { - "href": "https://captions.example.com/textTrack/0ab39e419c9bcb63233168daefe390f232c71343/183f0bf3a0982a127bdb8161e0c44eb696b3e75c-1554230749920/subtitles_en-US.vtt", - "kind": "subtitles", - "label": "English", - "lang": "en-US", - "source": "upload" - }, - { - "href": "https://captions.example.com/textTrack/95b62d1b762700b9d5366a9e71d5fcc5086f2723/183f0bf3a0982a127bdb8161e0c44eb696b3e75c-1554230749920/subtitles_pt-BR.vtt", - "kind": "subtitles", - "label": "Brazil", - "lang": "pt-BR", - "source": "upload" - } + "returncode": "SUCCESS", + "tracks": { + "content": [ + { + "href": "https://captions.example.com/textTrack/0ab39e419c9bcb63233168daefe390f232c71343/183f0bf3a0982a127bdb8161e0c44eb696b3e75c-1554230749920/subtitles_en-US.vtt", + "kind": "subtitles", + "label": "English", + "lang": "en-US", + "source": "upload" + }, + { + "href": "https://captions.example.com/textTrack/95b62d1b762700b9d5366a9e71d5fcc5086f2723/183f0bf3a0982a127bdb8161e0c44eb696b3e75c-1554230749920/subtitles_pt-BR.vtt", + "kind": "subtitles", + "label": "Brazil", + "lang": "pt-BR", + "source": "upload" + } ] + "pageable": { + "sort": { + "empty": true, + "unsorted": true, + "sorted": false + }, + "offset": 0, + "pageSize": 25, + "pageNumber": 0, + "paged": true, + "unpaged": false + }, + "totalElements": 2, + "totalPages": 1, + "last": true, + "number": 0, + "sort": { + "empty": true, + "unsorted": true, + "sorted": false + }, + "size": 25, + "first": true, + "numberOfElements": 2, + "empty": false } } ``` @@ -941,7 +986,7 @@ This API is asynchronous. It can take several minutes for the uploaded file to b **Resource URL:** -`POST http://yourserver.com/bigbluebutton/api/putRecordingTextTrack` +`POST http://yourserver.com/bigbluebutton/api/v1/putRecordingTextTrack` **Parameters:** @@ -1035,6 +1080,34 @@ Missing parameter error } ``` +## getMeetingSummary + +Get a summary of events that occurred during a meeting. + +**Resource URL:** + +- http://yourserver.com/bigbluebutton/api/v1/getMeetingSummary?[parameters]&checksum=[checksum] + +**Parameters:** + +{% include api_table.html endpoint="getMeetingSummary" %} + +**Example Requests:** + +- http://yourserver.com/bigbluebutton/api/v1/getMeetingSummary?recordID=record123&checksum=1234 + +**Example Response:** + +```xml + + SUCCESS + + contents of events.xml + + +``` + + # API Sample Code BigBlueButton provides API Sample Codes so you can integrated easily with your application. Feel free to contribute and post your implementation of the API in other language code in the bigbluebutton-dev mailing list.