{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Features: Announcement Playlist API", "version": "1.0.0" }, "items": [ { "info": { "name": "Features: Announcement Playlist", "type": "folder" }, "items": [ { "info": { "name": "List Announcement Playlists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/announcements/playlists", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Get announcements playlist in this organization." } ] }, "docs": "Fetch a list of announcement playlist at an organization.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create Announcement Playlist", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/announcements/playlists", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Create an announcement playlist in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create announcement Playlist at an organization level. A maximum of 25 announcement files can be included in a single playlist.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Announcement Playlist", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId", "params": [ { "name": "playlistId", "value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jNzAwNmI4ZC1kYmQ3LTQ3YjctOWQ0Ny05ZDJkMWEzYmY1Yzc", "type": "path", "description": "Unique identifier of an announcement playlist." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Get an announcement playlist in this organization." } ] }, "docs": "Fetch details of announcement playlist by its ID at an organization level.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Announcement Playlist", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId", "params": [ { "name": "playlistId", "value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ", "type": "path", "description": "Unique identifier of an announcement playlist." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify an announcement playlist in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify an existing announcement playlist at an organization level.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete Announcement Playlist", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId", "params": [ { "name": "playlistId", "value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jNzAwNmI4ZC1kYmQ3LTQ3YjctOWQ0Ny05ZDJkMWEzYmY1Yzc", "type": "path", "description": "Unique identifier of an announcement playlist." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Delete an announcement playlist in this organization." } ] }, "docs": "Delete an announcement playlist for an organization.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "List Playlist Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId/locations", "params": [ { "name": "playlistId", "value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ", "type": "path", "description": "Unique identifier of playlist." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Get location associated to a playlist in this organization." } ] }, "docs": "Fetch list of locations which are assigned to the given announcement playlist\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Playlist Locations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId/locations", "params": [ { "name": "playlistId", "value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ", "type": "path", "description": "Unique identifier of an announcement playlist." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify an assign location for announcement playlist for organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify list of assigned locations or add new locations to the announcement playlist. This will assing the playlist to the location's music on hold.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." } ] } ], "bundled": true }