Group Pre Alerting Announcement

Display group’s pre alerting announcement

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/pre_announcement/

Retrieve the settings of the Pre Alerting Announcement service of the group.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/pre_announcement/ HTTP/1.1
Host: example.com

Example response:

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

{
     "announcementInterruption": "Not Allowed",
     "interruptionDigitSequence": "1111",
     "audioSelection": "File"
     "audioFile": {
          "name": "APIO Group Test Announcement",
          "level": "Group"
     }
}

Response JSON Object:

• announcementInterruption (string) – Specify the announcement interruption action behaviour. A value from list: “Not Allowed”, “Any Digit”, “Digit Sequence”

• interruptionDigitSequence (string) – The digit sequence for the announcement interruption.

• audioSelection (string) – The audio announcement selection. A value from list: “File”, “Default”.

• audioFile (object) – An object as defined in Announcement File Name.

Status Codes:

• 200 OK – no error

Update a group’s pre alerting announcement

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/pre_announcement/

Update the settings of the Pre Alerting Announcement service of the group.

Authorization rights: minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/pre_announcement/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "announcementInterruption": "Not Allowed",
     "interruptionDigitSequence": "1111",
     "audioSelection": "File"
     "audioFile": {
          "name": "APIO Group Test Announcement"
     }
}

Request JSON Object:

• announcementInterruption (string) – (Optional) Specify the announcement interruption action behaviour. A value from list: “Not Allowed”, “Any Digit”, “Digit Sequence”

• interruptionDigitSequence (string) – (Conditional) The digit sequence for the announcement interruption. It is mandatory when announcementInterruption is set to “Digit Sequence” and no sequence has been already configured.

• audioSelection (string) – (Optional) The audio announcement selection. A value from list: “File”, “Default”. If “File” is selected, an audioFile must be specified.

• audioFile (object) – (Conditional) An object as defined in Announcement File Name or an empty string to unassign the announcement. It is mandatory when audioSelection is set to “File” and no file has been already configured.

Example response:

HTTP/1.1 200 OK

Status Codes:

• 200 OK – no error

• 400 Bad Request –

  invalid request due to invalid parameters, with possible sub error codes:

  • 9 MISSING_CONDITIONAL_PARAMETERS, ‘It is mandatory to provide the interruptionDigitSequence when “Digit Sequence” is selected as announcement interruption.’.

  • 9 MISSING_CONDITIONAL_PARAMETERS, ‘It is mandatory to provide the audioFile when “File” is selected as audioSelection.’.