Wazo Action API

openapi: 3.2.0
info:
  title: wazo-amid Action API
  description: Send AMI actions to Asterisk, providing token based authentication.
  version: '0.1'
  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: action
paths:
  /action/{action}:
    post:
      summary: AMI action
      description: '**Required ACL:** `amid.action.{action}.create`


        The Action endpoint sends an action to the Asterisk Manager.


        See https://docs.asterisk.org/Latest_API/API_Documentation/AMI_Actions/ for more details about the AMI message parameters.

        '
      parameters:
      - name: action
        in: path
        description: 'Name of the manager action. Currently not supported: Queues, Command.'
        required: true
        schema:
          type: string
      tags:
      - action
      responses:
        '200':
          description: The Asterisk Manager responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '401':
          description: Invalid authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Another service is unavailable (e.g. wazo-auth)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionArguments'
        description: 'Arguments for the manager action.


          Action: taken from the URL

          ActionID: not necessary


          If you need a same key multiple times, give a list of values.


          For Action: Originate, you should always use Async: True'
components:
  schemas:
    ActionArguments:
      properties: {}
      example:
        Channel: SIP/abcdef
        Priority: '1'
        Exten: '1234'
        Context: default
        Variable:
        - Var1=one
        - Var2=two
        Async: 'True'
    Error:
      properties:
        timestamp:
          type: number
          format: timestamp
        message:
          type: string
        error_id:
          type: string
        details:
          type: object
    Response:
      properties:
        response:
          type: string
          description: Name of the action response
  securitySchemes:
    wazo_auth_token:
      type: apiKey
      name: X-Auth-Token
      in: header
x-xivo-name: amid
x-xivo-port: 9491
x-apievangelist-source:
  harvested_from: https://github.com/wazo-platform/wazo-amid
  assembly: base plugin api.yml deep-merged with all plugin api.yml fragments, reproducing what the running service serves at /api/amid/1.0/api/api.yml (see wazo_amid/plugins/api/http.py — xivo.chain_map.ChainMap)
  spec_version: Swagger 2.0 (as published by Wazo)
  harvested: '2026-08-17'