Default Announcements Catalog¶

Listing available default announcements¶

GET /api/v1/configs/default_announcements/¶

Return the list of all the default announcements in the catalog.

Example request:

GET /api/v1/configs/default_announcements/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "language": "English",
   "level": "All",
   "combineWithOr": true,
   "includeEmpty": false
}

Request JSON Object:

language (string) – (Optional) If provided will filter the default announcements based on the language. Default is all languages.
level (string) – (Optional) If provided will filter the default announcements based on the level. Allowed values: “All”, “Tenant”, “Group” or “User”. Default is “All”.
combineWithOr (boolean) – (Optional) If provided will combine the filters with OR logic. Default is False.
includeEmpty (boolean) – (Optional) Include in the answer the announcements with empty content. Default is False.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "announcements": [
      {
         "name": "test",
         "description": "",
         "language": "English",
         "level": "All"
      },
      ...
   ]
}

Response JSON Object:

announcements (array) – A list of default announcements. See Default Announcement Attributes.

Status Codes:

200 OK – no error

Display default announcement instance¶

GET /api/v1/configs/default_announcements/(string: instance_name)/¶

Retrieve information about the specified default announcement instance.

Example request:

GET /api/v1/configs/default_announcements/test/ HTTP/1.1
Host: example.com

Request JSON Object:

includeEmpty (boolean) – (Optional) Return the announcement even with empty content, otherwise if the content is empty a 404 will be returned. Default is False.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "name": "test",
   "description": "",
   "language": "English",
   "level": "All"
}

Response JSON Object:

name (string) – The name of the announcement. See name in Default Announcement Attributes.
description (string) – The description of the announcement. See description in Default Announcement Attributes.
language (string) – The language of the announcement. See language in Default Announcement Attributes.
level (string) – The level in which the announcement could be used. See level in Default Announcement Attributes.

Status Codes:

200 OK – no error
404 Not Found – the default announcement is not found.

Display default announcement instance content¶

GET /api/v1/configs/default_announcements/content/(string: instance_name)/¶

Retrieve the content of the specified default announcement instance.

Example request:

GET /api/v1/configs/default_announcements/content/test/ HTTP/1.1
Host: example.com

Request JSON Object:

includeEmpty (boolean) – (Optional) Return the announcement even with empty content, otherwise if the content is empty a 404 will be returned. Default is False.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "name": "test",
   "description": "",
   "content": CONTENT_AUDIO_FILE
   "language": "English",
   "level": "All"
}

Response JSON Object:

name (string) – The name of the announcement. See name in Default Announcement Attributes.
description (string) – The description of the announcement. See description in Default Announcement Attributes.
content (string) – See content in Default Announcement Attributes.
language (string) – The language of the announcement. See language in Default Announcement Attributes.
level (string) – The level in which the announcement could be used. See level in Default Announcement Attributes.

Status Codes:

200 OK – no error
404 Not Found – the default announcement is not found.

Default Announcement Attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	The name of the announcement.
description	String	A	The description of the announcement.
content	String	A	The media file content (encoded to base64 format).
language	String	A	The language of the announcement. If not set means that is multi language.
level	String	A	The level in which the announcement could be used. Could be “All”, “Tenant”, “Group” or “User”.