Wazo Recordings Announcements API

openapi: 3.2.0
info:
  title: wazo-confd Recordings Announcements API
  description: "Confd exposes an API for managing core resources on a Wazo server such as users, extensions, devices, voicemails, queues, etc. Resources can be associated together to provide additional functionality. For example: By associating a voicemail with a user, calls will automatically fallback on to the voicemail when the user cannot answer.\n\nImplementation notes\n====================\n\nErrors\n------\n\nResponses containing errors will have a status code in the 400 or 500 class. A list of error messages will be returned in the body of the response as a JSON-encoded array:\n\n~~~\n[\n    \"Input error - User not found\",\n    \"Resource error - User not associated to a line\"\n]\n~~~\n\n\nUpdating resources via PUT\n--------------------------\n\nWhen updating a resource, all fields become optional. In other words, only values that have been changed need to be sent to the server. Please note that this behavior may change in future versions of the API."
  version: '1.1'
  license:
    name: GPL v3
    url: http://www.gnu.org/licenses/gpl.txt
  contact:
    name: Wazo Dev Team
    url: https://wazo-platform.org/
    email: dev@wazo.community
  x-logo:
    url: https://wazo-platform.org/images/logo-black.svg
    backgroundColor: '#FAFAFA'
    altText: Wazo Logo
servers:
- url: /1.1
security:
- wazo_auth_token: []
tags:
- name: recordings-announcements
paths:
  /recordings/announcements:
    get:
      operationId: get_recordings_announcements
      summary: Get announcements configuration
      description: '**Required ACL:** `confd.recordings.announcements.read`'
      tags:
      - recordings-announcements
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      responses:
        '200':
          description: Recordings announcements configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingsAnnouncements'
    put:
      operationId: update_recordings_announcements
      summary: Update recordings announcements configuration
      description: '**Required ACL:** `confd.recordings.announcements.update`'
      tags:
      - recordings-announcements
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordingsAnnouncements'
        required: true
components:
  schemas:
    RecordingsAnnouncements:
      title: Recordings announcements
      type: object
      properties:
        recording_start:
          type: string
          description: The filename for the recording start announcement
        recording_stop:
          type: string
          description: The filename for the recording stop announcement
  responses:
    ResourceUpdated:
      description: Resource was updated successfully
  parameters:
    tenantuuid:
      name: Wazo-Tenant
      in: header
      description: The tenant's UUID, defining the ownership of a given resource.
      required: false
      schema:
        type: string
  securitySchemes:
    wazo_auth_token:
      type: apiKey
      name: X-Auth-Token
      in: header
x-xivo-port: 9486
x-xivo-name: confd
x-apievangelist-source:
  harvested_from: https://github.com/wazo-platform/wazo-confd
  assembly: base plugin api.yml deep-merged with all plugin api.yml fragments, reproducing what the running service serves at /api/confd/1.1/api/api.yml (see wazo_confd/plugins/api/http.py — xivo.chain_map.ChainMap)
  spec_version: Swagger 2.0 (as published by Wazo)
  harvested: '2026-08-17'