Wazo Registers API

openapi: 3.2.0
info:
  title: wazo-confd Registers 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: registers
paths:
  /registers/iax:
    get:
      operationId: list_registers_iax
      summary: List registers iax
      description: '**Required ACL:** `confd.registers.iax.read`'
      tags:
      - registers
      parameters:
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: Registers IAX list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterIAXItems'
    post:
      operationId: create_register_iax
      summary: Create register_iax
      description: '**Required ACL:** `confd.registers.iax.create`'
      tags:
      - registers
      responses:
        '201':
          description: Register IAX created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterIAX'
        '400':
          $ref: '#/components/responses/CreateError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterIAX'
        description: Register iax to create
        required: true
  /registers/iax/{register_iax_id}:
    get:
      operationId: get_register_iax
      summary: Get register IAX
      description: '**Required ACL:** `confd.registers.iax.{register_iax_id}.read`'
      tags:
      - registers
      parameters:
      - $ref: '#/components/parameters/registeriaxid'
      responses:
        '200':
          description: Register IAX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterIAX'
        '404':
          $ref: '#/components/responses/NotFoundError'
    put:
      operationId: update_register_iax
      summary: Update register IAX
      description: '**Required ACL:** `confd.registers.iax.{register_iax_id}.update`'
      tags:
      - registers
      parameters:
      - $ref: '#/components/parameters/registeriaxid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterIAX'
        required: true
    delete:
      operationId: delete_register_iax
      summary: Delete register IAX
      description: '**Required ACL:** `confd.registers.iax.{register_iax_id}.delete`'
      tags:
      - registers
      parameters:
      - $ref: '#/components/parameters/registeriaxid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceDeleted'
        '400':
          $ref: '#/components/responses/DeleteError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  /trunks/{trunk_id}/registers/iax/{iax_id}:
    put:
      operationId: associate_trunk_register_iax
      summary: Associate trunk and IAX register
      description: '**Required ACL:** `confd.trunks.{trunk_id}.registers.iax.{iax_id}.update`'
      tags:
      - registers
      parameters:
      - $ref: '#/components/parameters/trunkid'
      - $ref: '#/components/parameters/iaxid'
      responses:
        '204':
          description: Trunk and IAX register associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
    delete:
      operationId: dissociate_trunk_register_iax
      summary: Dissociate trunk and IAX register
      description: '**Required ACL:** `confd.trunks.{trunk_id}.registers.iax.{iax_id}.delete`'
      tags:
      - registers
      parameters:
      - $ref: '#/components/parameters/trunkid'
      - $ref: '#/components/parameters/iaxid'
      responses:
        '204':
          description: Trunk and IAX register dissociated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  responses:
    NotFoundError:
      description: The resource requested was not found on the server
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ResourceDeleted:
      description: Resource was deleted successfully
    ResourceUpdated:
      description: Resource was updated successfully
    CreateError:
      description: An error occurred when creating the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    GenericError:
      description: An error occurred during the operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UpdateError:
      description: An error occurred when updating the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    DeleteError:
      description: An error occurred when deleting the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    RegisterIAXItems:
      title: RegisterItems
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/RegisterIAX'
        total:
          type: integer
    RegisterIAX:
      title: Register IAX
      allOf:
      - $ref: '#/components/schemas/RegisterIAXRelationBase'
      - properties:
          auth_username:
            type: string
            description: The username used by the remote_host for the authentication
          auth_password:
            type: string
            description: The password to authenticate to the remote_host
          remote_host:
            type: string
            description: The register domain
          remote_port:
            type: integer
            description: The port of the remote_host
          callback_extension:
            type: string
            description: The callback extension to use for the register
          callback_context:
            type: string
            description: The callback context to use for the register
        required:
        - remote_host
    Error:
      type: array
      items:
        type: string
    RegisterIAXRelationBase:
      properties:
        id:
          type: integer
          readOnly: true
          description: The id of the register IAX
  parameters:
    offset:
      required: false
      name: offset
      in: query
      description: Number of items to skip over in the list. Useful for pagination.
      schema:
        type: integer
    order:
      required: false
      name: order
      in: query
      description: Name of the field to use for sorting the list of items returned.
      schema:
        type: string
    registeriaxid:
      description: Register IAX's ID
      name: register_iax_id
      in: path
      required: true
      schema:
        type: integer
    direction:
      required: false
      name: direction
      in: query
      description: Sort list of items in 'asc' (ascending) or 'desc' (descending) order
      schema:
        type: string
        enum:
        - asc
        - desc
    search:
      required: false
      name: search
      in: query
      description: Search term for filtering a list of items. Only items with a field containing the search term will be returned.
      schema:
        type: string
    iaxid:
      required: true
      name: iax_id
      in: path
      schema:
        type: integer
    trunkid:
      description: Trunk's ID
      name: trunk_id
      in: path
      required: true
      schema:
        type: integer
    limit:
      required: false
      name: limit
      in: query
      description: Maximum number of items to return in the list
      schema:
        type: integer
  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'