openapi: 3.2.0
info:
  title: wazo-calld Adhoc Conferences API
  description: Control your calls from a REST API
  version: 1.0.0
  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.0
security:
- wazo_auth_token: []
tags:
- name: adhoc_conferences
paths:
  /users/me/conferences/adhoc:
    post:
      summary: Create an adhoc conference
      description: '**Required ACL:** `calld.users.me.conferences.adhoc.create`. An adhoc conference allows a user to merge multiple calls in one conversation. It acts like a conference room, but has no dedicated extension. The user creating the adhoc conference acts as the owner of the conference and controls who enters or leaves the conference. The conference will be destroyed when the owner leaves the conference.'
      tags:
      - adhoc_conferences
      responses:
        '201':
          description: Conference adhoc has been created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdhocConference'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '409':
          $ref: '#/components/responses/HostAlreadyInConference'
        '503':
          $ref: '#/components/responses/AnotherServiceUnavailable'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdhocConferenceCreation'
        description: Parameters of the conference calls
        required: true
  /users/me/conferences/adhoc/{conference_id}:
    delete:
      summary: Delete an adhoc conference
      description: '**Required ACL:** `calld.users.me.conferences.adhoc.delete`. All calls in the adhoc conference will be hungup.'
      parameters:
      - $ref: '#/components/parameters/AdhocConferenceID'
      tags:
      - adhoc_conferences
      responses:
        '204':
          description: Conference adhoc has been deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdhocConference'
        '404':
          $ref: '#/components/responses/NoSuchAdhocConference'
        '503':
          $ref: '#/components/responses/AnotherServiceUnavailable'
  /users/me/conferences/adhoc/{conference_id}/participants/{call_id}:
    put:
      summary: Add a participant into an adhoc conference
      description: '**Required ACL:** `calld.users.me.conferences.adhoc.participants.update`'
      parameters:
      - $ref: '#/components/parameters/AdhocConferenceID'
      - $ref: '#/components/parameters/CallID'
      tags:
      - adhoc_conferences
      responses:
        '204':
          description: Participant has been added to the adhoc conference
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NoSuchAdhocConference'
        '503':
          $ref: '#/components/responses/AnotherServiceUnavailable'
    delete:
      summary: Remove a participant from an adhoc conference
      description: '**Required ACL:** `calld.users.me.conferences.adhoc.participants.delete`'
      parameters:
      - $ref: '#/components/parameters/AdhocConferenceID'
      - $ref: '#/components/parameters/CallID'
      tags:
      - adhoc_conferences
      responses:
        '204':
          description: Participant has been removed from the adhoc conference
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '404':
          $ref: '#/components/responses/NoSuchAdhocConference'
        '503':
          $ref: '#/components/responses/AnotherServiceUnavailable'
components:
  responses:
    InvalidRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    AnotherServiceUnavailable:
      description: Another service is unavailable (e.g. wazo-auth, wazo-confd, Asterisk, ...)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    HostAlreadyInConference:
      description: The host call is already in a conference
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NoSuchAdhocConference:
      description: The specified adhoc conference does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    AdhocConferenceID:
      name: conference_id
      in: path
      description: ID of the adhoc conference
      required: true
      schema:
        type: string
    CallID:
      name: call_id
      in: path
      description: ID of the call
      required: true
      schema:
        type: string
  schemas:
    AdhocConference:
      type: object
      properties:
        conference_id:
          description: The ID of the adhoc conference
          type: string
    Error:
      title: Error
      description: Error message for the client
      properties:
        message:
          description: Human readable explanation of the error
          type: string
        error_id:
          description: Identifier of the type of error. It is more precise than the HTTP status code.
          type: string
        details:
          description: Additional information about the error. The keys are specific to each error.
          type: object
        timestamp:
          description: Time when the error occured
          type: number
          format: timestamp
    AdhocConferenceCreation:
      type: object
      properties:
        host_call_id:
          description: The call_id of the host call
          type: string
        participant_call_ids:
          description: The call_id of the participating calls in this conference, excluding the host.
          type: array
          items:
            type: string
  securitySchemes:
    wazo_auth_token:
      type: apiKey
      name: X-Auth-Token
      in: header
x-xivo-port: 9500
x-xivo-name: calld
x-apievangelist-source:
  harvested_from: https://github.com/wazo-platform/wazo-calld
  assembly: base plugin api.yml deep-merged with all plugin api.yml fragments, reproducing what the running service serves at /api/calld/1.0/api/api.yml (see wazo_calld/plugins/api/http.py — xivo.chain_map.ChainMap)
  spec_version: Swagger 2.0 (as published by Wazo)
  harvested: '2026-08-17'