Skip to end of metadata
Go to start of metadata

Overview

Returns a list of announcement audio files for an announcement type.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
typeAnnouncementTypeEnumDefines what type of announcement files should be listedMandatory

Response

Parameters of the API response:

ParameterType

Description

announcementsList<String>Announcement audio files of the filtered announcement type
returnStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED

Examples

 Example ListAnnouncements transaction.
Example ListAnnouncements transaction.
Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v3:listAnnouncements>
         <token>YWygO3Nw0LlqWWThMKxBa18G3zQ8HKq3</token>
         <type>CONFERENCE</type>
      </v3:listAnnouncements>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listAnnouncementsResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <announcements>This_Meeting_Is_Being_Recorded.wma</announcements>
            <announcements>This_Meeting_Is_Being_Recorded_other_file.wma</announcements>
            <announcements>This_Meeting_Is_Being_Recorded_other_file_2.wma</announcements>
            <status>
               <statusCode>OK</statusCode>
            </status>
         </return>
      </ns2:listAnnouncementsResponse>
   </S:Body>
</S:Envelope>