Wazo Sip API

The sip API from Wazo — 11 operation(s) for sip.

Operations 24

GET /endpoints/sip List SIP endpoints #
POST /endpoints/sip Create a SIP endpoint #
GET /endpoints/sip/{sip_uuid} Get SIP Endpoint #
PUT /endpoints/sip/{sip_uuid} Update SIP Endpoint #
DELETE /endpoints/sip/{sip_uuid} Delete SIP Endpoint #
GET /endpoints/sip/templates List SIP endpoints templates #
POST /endpoints/sip/templates Create a SIP endpoint template #
GET /endpoints/sip/templates/{template_uuid} Get SIP Endpoint template #
PUT /endpoints/sip/templates/{template_uuid} Update SIP Endpoint Template #
DELETE /endpoints/sip/templates/{template_uuid} Delete SIP Endpoint Template #
PUT /lines/{line_id}/endpoints/sip/{sip_uuid} Associate line and SIP endpoint #
DELETE /lines/{line_id}/endpoints/sip/{sip_uuid} Dissociate line and SIP endpoint #
GET /asterisk/pjsip/doc List all PJSIP configuration options #
GET /asterisk/pjsip/system List of PJSIP options for the `system` section #
PUT /asterisk/pjsip/system Update PJSIP section options #
GET /asterisk/pjsip/global List of PJSIP options for the `global` section #
PUT /asterisk/pjsip/global Update PJSIP section options #
GET /sip/transports List all configured SIP transports #
POST /sip/transports Create SIP transport #
GET /sip/transports/{transport_uuid} Get SIP transport #
PUT /sip/transports/{transport_uuid} Update SIP transport #
DELETE /sip/transports/{transport_uuid} Delete SIP transport #
PUT /trunks/{trunk_id}/endpoints/sip/{sip_uuid} Associate trunk and SIP endpoint #
DELETE /trunks/{trunk_id}/endpoints/sip/{sip_uuid} Dissociate trunk and SIP endpoint #

Documentation

Specifications

Other Resources

🔗
Console
https://api.wazo.io/documentation/console/authentication/
🔗
SourceCode
https://github.com/wazo-platform/wazo-auth
🔗
ChangeLog
https://github.com/wazo-platform/wazo-auth/blob/master/CHANGELOG.md
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/conventions/wazo-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/errors/wazo-problem-types.yml
🔗
Console
https://api.wazo.io/documentation/console/configuration/
🔗
SourceCode
https://github.com/wazo-platform/wazo-confd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-confd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/application/
🔗
SourceCode
https://github.com/wazo-platform/wazo-calld
🔗
ChangeLog
https://github.com/wazo-platform/wazo-calld/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/cdr/
🔗
SourceCode
https://github.com/wazo-platform/wazo-call-logd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-call-logd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/contact/
🔗
SourceCode
https://github.com/wazo-platform/wazo-dird
🔗
ChangeLog
https://github.com/wazo-platform/wazo-dird/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/webhook/
🔗
SourceCode
https://github.com/wazo-platform/wazo-webhookd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-webhookd/blob/master/CHANGELOG.md
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-events-webhooks.yml
🔗
Console
https://api.wazo.io/documentation/console/plugins/
🔗
SourceCode
https://github.com/wazo-platform/wazo-plugind
🔗
ChangeLog
https://github.com/wazo-platform/wazo-plugind/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/agent/
🔗
SourceCode
https://github.com/wazo-platform/wazo-agentd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-agentd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/chat/
🔗
SourceCode
https://github.com/wazo-platform/wazo-chatd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-chatd/blob/master/CHANGELOG.md
🔗
SourceCode
https://github.com/wazo-platform/wazo-phoned
🔗
ChangeLog
https://github.com/wazo-platform/wazo-phoned/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/setup/
🔗
SourceCode
https://github.com/wazo-platform/wazo-setupd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-setupd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/amid/
🔗
SourceCode
https://github.com/wazo-platform/wazo-amid
🔗
ChangeLog
https://github.com/wazo-platform/wazo-amid/blob/master/CHANGELOG.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/wazo-sip-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

wazo-sip-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: wazo-confd Sip API
  description: Confd exposes an API for managing core resources on a Wazo server such as users, extensions, devices, voicemails, queues, etc.
  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: sip
paths:
  /endpoints/sip:
    get:
      operationId: list_endpoints_sip
      summary: List SIP endpoints
      description: '**Required ACL:** `confd.endpoints.sip.read`


        List all SIP configurations, each individual configuration includes only fields that it

        defines. Inherited fields from the templates or default values are not returned here.'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/recurse'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/query_string_uuid_filter'
      responses:
        '200':
          description: SIP endpoint list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointSIPItems'
    post:
      operationId: create_endpoint_sip
      summary: Create a SIP endpoint
      description: '**Required ACL:** `confd.endpoints.sip.create`


        Create a new SIP endpoint. This endpoint can inherit from other endpoints, only modify

        fields that have to be modified.'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      responses:
        '201':
          description: SIP endpoint created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointSIP'
        '400':
          $ref: '#/components/responses/CreateError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointSIP'
        description: SIP Endpoint to create
  /endpoints/sip/{sip_uuid}:
    get:
      operationId: get_endpoint_sip
      summary: Get SIP Endpoint
      description: '**Required ACL:** `confd.endpoints.sip.{sip_uuid}.read`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/sipuuid'
      - $ref: '#/components/parameters/endpoint_sip_view'
      responses:
        '200':
          description: SIP Endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointSIP'
        '404':
          $ref: '#/components/responses/NotFoundError'
    put:
      operationId: update_endpoint_sip
      summary: Update SIP Endpoint
      description: '**Required ACL:** `confd.endpoints.sip.{sip_uuid}.update`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/sipuuid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointSIP'
        required: true
    delete:
      operationId: delete_endpoint_sip
      summary: Delete SIP Endpoint
      description: '**Required ACL:** `confd.endpoints.sip.{sip_uuid}.delete`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/sipuuid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceDeleted'
        '400':
          $ref: '#/components/responses/DeleteError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  /endpoints/sip/templates:
    get:
      operationId: list_endpoints_sip_templates
      summary: List SIP endpoints templates
      description: '**Required ACL:** `confd.endpoints.sip.templates.read`


        List all SIP configuration templates, each individual configuration includes only fields that it

        defines. Inherited fields from the templates or default values are not returned here.'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/recurse'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: SIP endpoint template list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointSIPItems'
    post:
      operationId: create_endpoint_sip_template
      summary: Create a SIP endpoint template
      description: '**Required ACL:** `confd.endpoints.sip.templates.create`


        Create a new SIP endpoint configuration template. This endpoint can inherit from other templates,

        only modify fields that have to be modified.'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      responses:
        '201':
          description: SIP endpoint created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointSIP'
        '400':
          $ref: '#/components/responses/CreateError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointSIP'
        description: SIP Endpoint to create
  /endpoints/sip/templates/{template_uuid}:
    get:
      operationId: get_endpoint_sip_template
      summary: Get SIP Endpoint template
      description: '**Required ACL:** `confd.endpoints.sip.templates.{template_uuid}.read`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/template_uuid'
      responses:
        '200':
          description: SIP Endpoint template
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointSIP'
        '404':
          $ref: '#/components/responses/NotFoundError'
    put:
      operationId: update_endpoint_sip_template
      summary: Update SIP Endpoint Template
      description: '**Required ACL:** `confd.endpoints.sip.templates.{template_uuid}.update`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/template_uuid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointSIP'
        required: true
    delete:
      operationId: delete_endpoint_sip_template
      summary: Delete SIP Endpoint Template
      description: '**Required ACL:** `confd.endpoints.sip.templates.{template_uuid}.delete`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/template_uuid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceDeleted'
        '400':
          $ref: '#/components/responses/DeleteError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  /lines/{line_id}/endpoints/sip/{sip_uuid}:
    put:
      operationId: associate_line_endpoint_sip
      summary: Associate line and SIP endpoint
      description: '**Required ACL:** `confd.lines.{line_id}.endpoints.sip.{sip_uuid}.update`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/lineid'
      - $ref: '#/components/parameters/sipuuid'
      responses:
        '204':
          description: Line and SIP endpoint associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
    delete:
      operationId: dissociate_line_endpoint_sip
      summary: Dissociate line and SIP endpoint
      description: '**Required ACL:** `confd.lines.{line_id}.endpoints.sip.{sip_uuid}.delete`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/lineid'
      - $ref: '#/components/parameters/sipuuid'
      responses:
        '204':
          description: Line and SIP endpoint dissociated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  /asterisk/pjsip/doc:
    get:
      description: '**Required ACL:**: `confd.asterisk.pjsip.doc.read`


        List all available configuration options for PJSIP, those values are

        used to validate to content of POST and PUT requests.'
      operationId: show_pjsip_doc
      responses:
        '200':
          description: A list of all PJSIP configuration options
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PJSIPConfigurationOptions'
        '400':
          description: wazo-confd could not read the PJSIP documentation file
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      summary: List all PJSIP configuration options
      tags:
      - sip
  /asterisk/pjsip/system:
    get:
      operationId: list_asterisk_pjsip_system
      summary: List of PJSIP options for the `system` section
      description: '**Required ACL:** `confd.asterisk.pjsip.system.read`'
      tags:
      - sip
      responses:
        '200':
          description: SIP system
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PJSIPSystem'
    put:
      operationId: update_asterisk_pjsip_system
      summary: Update PJSIP section options
      description: '**Required ACL:** `confd.asterisk.pjsip.system.update`

        The PJSIP system configuration is shared among all tenants of an instance.

        **WARNING** This endpoint restore to default value or delete all fields that

        are not defined.'
      tags:
      - sip
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PJSIPSystem'
        required: true
  /asterisk/pjsip/global:
    get:
      operationId: list_asterisk_pjsip_global
      summary: List of PJSIP options for the `global` section
      description: '**Required ACL:** `confd.asterisk.pjsip.global.read`'
      tags:
      - sip
      responses:
        '200':
          description: SIP global
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PJSIPGlobal'
    put:
      operationId: update_asterisk_pjsip_global
      summary: Update PJSIP section options
      description: '**Required ACL:** `confd.asterisk.pjsip.global.update`

        The PJSIP global configuration is shared among all tenants of an instance.

        **WARNING** This endpoint restore to default value or delete all fields that

        are not defined.'
      tags:
      - sip
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PJSIPGlobal'
        required: true
  /sip/transports:
    get:
      operationId: list_sip_transports
      summary: List all configured SIP transports
      description: '**Required ACL:** `confd.sip.transports.read`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: The SIP transport list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SIPTransportItems'
    post:
      operationId: create_sip_transport
      summary: Create SIP transport
      description: '**Required ACL:** `confd.sip.transports.create`


        Transports are shared between all tenants and should be readable to the

        tenants'' administrators.


        There should always be atleast one transport configured on the system.'
      tags:
      - sip
      responses:
        '201':
          description: SIP transport created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SIPTransport'
        '400':
          $ref: '#/components/responses/CreateError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SIPTransport'
        description: Transport to create
        required: true
  /sip/transports/{transport_uuid}:
    get:
      operationId: get_sip_transport
      summary: Get SIP transport
      description: '**Required ACL**: `confd.sip.transports.{transport_uuid}.read`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/transportuuid'
      responses:
        '200':
          description: A SIP transport
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SIPTransport'
        '404':
          $ref: '#/components/responses/NotFoundError'
    put:
      operationId: update_sip_transport
      summary: Update SIP transport
      description: '**Required ACL**: `confd.sip.transports.{transport_uuid}.update`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/transportuuid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SIPTransport'
        required: true
    delete:
      operationId: delete_sip_transport
      summary: Delete SIP transport
      description: '**Required ACL:** `confd.sip.transports.{transport_uuid}.delete`


        Deletes a transport, all associated configuration will be assigned to

        the `fallback` transport.'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/transportuuid'
      - $ref: '#/components/parameters/fallback_transport'
      responses:
        '204':
          $ref: '#/components/responses/ResourceDeleted'
        '400':
          $ref: '#/components/responses/DeleteError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  /trunks/{trunk_id}/endpoints/sip/{sip_uuid}:
    put:
      operationId: associate_trunk_endpoint_sip
      summary: Associate trunk and SIP endpoint
      description: '**Required ACL:** `confd.trunks.{trunk_id}.endpoints.sip.{sip_uuid}.update`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/trunkid'
      - $ref: '#/components/parameters/sipuuid'
      responses:
        '204':
          description: Trunk and SIP endpoint associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
    delete:
      operationId: dissociate_trunk_endpoint_sip
      summary: Dissociate trunk and SIP endpoint
      description: '**Required ACL:** `confd.trunks.{trunk_id}.endpoints.sip.{sip_uuid}.delete`'
      tags:
      - sip
      parameters:
      - $ref: '#/components/parameters/trunkid'
      - $ref: '#/components/parameters/sipuuid'
      responses:
        '204':
          description: Trunk and SIP endpoint dissociated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  schemas:
    SIPTransportRelation:
      properties:
        uuid:
          type: string
      required:
      - uuid
    SIPTransport:
      properties:
        uuid:
          type: string
          readOnly: true
        name:
          type: string
        options:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueOption'
      required:
      - name
      - options
      example:
        name: transport-udp
        options:
        - - protocol
          - udp
        - - bind
          - 0.0.0.0:5060
    SIPAuthSectionOptions:
      title: PJSIP Auth Section Options
      $ref: '#/components/schemas/KeyValueOption'
    SIPTransportItems:
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SIPTransport'
        total:
          type: integer
    PJSIPGlobal:
      description: 'PJSIP global configuration.

        This configuration will be in the file ''''pjsip.conf'''' used by asterisk.

        '
      properties:
        options:
          type: object
      example:
        options:
          max_forwards: '5'
          keep_alive_interval: '30'
          user_agent: Wazo
          debug: false
    SIPIdentifySectionOptions:
      title: PJSIP Identify Section Options
      $ref: '#/components/schemas/KeyValueOption'
    SIPEndpointSectionOptions:
      title: SIP Endpoint Section Options
      $ref: '#/components/schemas/KeyValueOption'
    PJSIPConfigurationOptions:
      properties:
        aor:
          description: A list of all configuration options for this section
          items:
            $ref: '#/components/schemas/PJSIPConfigurationOption'
          type: array
        auth:
          description: A list of all configuration options for this section
          items:
            $ref: '#/components/schemas/PJSIPConfigurationOption'
          type: array
        contact:
          description: A list of all configuration options for this section
          items:
            $ref: '#/components/schemas/PJSIPConfigurationOption'
          type: array
        domain_alias:
          description: A list of all configuration options for this section
          items:
            $ref: '#/components/schemas/PJSIPConfigurationOption'
          type: array
        endpoint:
          description: A list of all configuration options for this section
          items:
            $ref: '#/components/schemas/PJSIPConfigurationOption'
          type: array
        global:
          description: A list of all configuration options for this section
          items:
            $ref: '#/components/schemas/PJSIPConfigurationOption'
          type: array
        registration:
          description: A list of all configuration options for this section
          items:
            $ref: '#/components/schemas/PJSIPConfigurationOption'
          type: array
        system:
          description: A list of all configuration options for this section
          items:
            $ref: '#/components/schemas/PJSIPConfigurationOption'
          type: array
        transport:
          description: A list of all configuration options for this section
          items:
            $ref: '#/components/schemas/PJSIPConfigurationOption'
          type: array
    KeyValueOption:
      description: "Options must have the following form:\n```\n{\n  \"options\": [\n      [\"option\", \"value\"],\n  ]\n}\n```\n"
      title: Key Value
      type: array
      items:
        type: string
      maxItems: 2
      minItems: 2
      example:
      - option
      - value
    PJSIPSystem:
      description: 'PJSIP system configuration.

        This configuration will be in the file ''''pjsip.conf'''' used by asterisk.

        '
      properties:
        options:
          type: object
      example:
        options:
          accept_multiple_sdp_answers: 'yes'
          compact_headers: 'yes'
          disable_tcp_switch: 'yes'
          follow_early_media_fork: 'no'
    EndpointSIPTemplatesRelation:
      properties:
        uuid:
          type: string
          description: The UUID of this resource
        label:
          type: string
          description: The label of this resource
          readOnly: true
      required:
      - uuid
    SIPAORSectionOptions:
      title: PJSIP AOR Section Options
      $ref: '#/components/schemas/KeyValueOption'
    Error:
      type: array
      items:
        type: string
    PJSIPConfigurationOption:
      properties:
        name:
          type: string
          description: The name of the option
        synopsis:
          type: string
          description: A brief description of the option
        description:
          type: string
          description: A long description of the option
        default:
          type: string
          description: The default value for this option
    EndpointSIP:
      title: SIP Endpoint
      properties:
        uuid:
          type: string
          description: The UUID of this resource
          readOnly: true
        name:
          type: string
          description: The name of the PJSIP entity, auto-generated if missing
        label:
          type: string
          description: The human readable name for this configuration
        aor_section_options:
          type: array
          items:
            $ref: '#/components/schemas/SIPAORSectionOptions'
          description: A list of PJSIP AOR section options for this endpoint
        auth_section_options:
          type: array
          items:
            $ref: '#/components/schemas/SIPAuthSectionOptions'
          description: A list of PJSIP auth section options for this endpoint
        endpoint_section_options:
          type: array
          items:
            $ref: '#/components/schemas/SIPEndpointSectionOptions'
          description: A list of PJSIP endpoint section options for this endpoint
        identify_section_options:
          type: array
          items:
            $ref: '#/components/schemas/SIPIdentifySectionOptions'
          description: A list of PJSIP identify section options for this endpoint
        registration_section_options:
          type: array
          items:
            $ref: '#/components/schemas/SIPRegistrationSectionOptions'
          description: A list of PJSIP registration section options for this endpoint
        registration_outbound_auth_section_options:
          type: array
          items:
            $ref: '#/components/schemas/SIPAuthSectionOptions'
          description: A list of PJSIP auth section options for this endpoint
        outbound_auth_section_options:
          type: array
          items:
            $ref: '#/components/schemas/SIPAuthSectionOptions'
          description: A list of PJSIP auth section options for this endpoint
        transport:
          description: The transport used by this endpoint
          $ref: '#/components/schemas/SIPTransportRelation'
        templates:
          type: array
          items:
            $ref: '#/components/schemas/EndpointSIPTemplatesRelation'
          description: 'A list of templates this configuration will inherit from.


            The inheritance only applies to option sections. Not to the name, label and other fields.

            For a given list of templates [A, B, C] A will be applied over B. C will be applied over (A,B) etc.

            '
        tenant_uuid:
          type: string
          description: The UUID of the tenant
          readOnly: true
        asterisk_id:
          type: string
          description: The ID of the Asterisk onto which this configuration applies.
    SIPRegistrationSectionOptions:
      title: PJSIP Registration Section Options
      $ref: '#/components/schemas/KeyValueOption'
    EndpointSIPItems:
      title: SIP Endpoints
      properties:
        items:
          items:
            $ref: '#/components/schemas/EndpointSIP'
          type: array
        total:
          type: integer
  responses:
    GenericError:
      description: An error occurred during the operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFoundError:
      description: The resource requested was not found on the server
      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'
    ResourceUpdated:
      description: Resource was updated successfully
    UpdateError:
      description: An error occurred when updating the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    CreateError:
      description: An error occurred when creating the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ResourceDeleted:
      description: Resource was deleted successfully
  parameters:
    fallback_transport:
      required: false
      name: fallback
      in: query
      description: 'The UUID of the transport that should be associated to orphaned

        SIP configurations

        '
      schema:
        type: string
    sipuuid:
      required: true
      name: sip_uuid
      in: path
      schema:
        type: string
    offset:
      required: false
      name: offset
      in: query
      description: Number of items to skip over in the list. Useful for pagination.
      schema:
        type: integer
    trunkid:
      description: Trunk's ID
      name: trunk_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
    order:
      required: false
      name: order
      in: query
      description: Name of the field to use for sorting the list of items returned.
      schema:
        type: string
    transportuuid:
      required: true
      name: transport_uuid
      in: path
      description: The UUID of the transport
      schema:
        type: string
    limit:
      required: false
      name: limit
      in: query
      description: Maximum number of items to return in the list
      schema:
        type: integer
    lineid:
      required: true
      name: line_id
      in: path
      schema:
        type: integer
    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
    endpoint_sip_view:
      required: false
      name: view
      in: query
      description: 'Different view of the SIP endpoint


        The `default` view, when the argument is omitted, is to include only options that

        are defined on the specified endpoint.


        The `merged` view includes all options from included templates.

        '
      schema:
        type: string
        enum:
        - merged
    template_uuid:
      required: true
      name: template_uuid
      in: path
      schema:
        type: string
    recurse:
      name: recurse
      in: query
      description: Should the query include sub-tenants
      required: false
      schema:
        type: boolean
        default: false
    tenantuuid:
      name: Wazo-Tenant
      in: header
      description: The tenant's UUID, defining the ownership of a given resource.
      required: false
      schema:
        type: string
    query_string_uuid_filter:
      in: query
      name: uuid
      required: false
      description: Search filter for resource UUID, can be used to search multiple elements. Using a comma separated list of UUID
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
        maxItems: 20
        minItems: 1
        uniqueItems: true
  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'