Wazo Platform

https://wazo-platform.org/documentation
Admin
Wazo Platform is a programmable communications platform that provides APIs and services for building...
Tokens:405,572
Snippets:2,339
Trust Score:7.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### WebSocket Server Operation Examples

Source: https://wazo-platform.org/documentation/overview/websocket-app.html

Examples of specific server-to-client messages for initialization, subscription, starting, and ping responses.

```json
{"op": "init", "code": 0, "data": {"version": 2}}
```

```json
{"op": "subscribe", "code": 0}
```

```json
{"op": "start", "code": 0}
```

```json
{"op": "pong", "code": 0, "data": {"payload": "..."}}
```

--------------------------------

### Get installable plugins list response

Source: https://wazo-platform.org/documentation/api/provisioning.html

Returns a JSON object containing a list of installable packages with their descriptions, sizes, checksums, and versions.

```json
{
  * "pkgs": {
    * "property1": {
      * "capabilities": {
        * "property1": {
          * "property1": "string",
          * "property2": "string"
},
        * "property2": {
          * "property1": "string",
          * "property2": "string"
}
},
      * "description": "string",
      * "dsize": 0,
      * "sha1sum": "string",
      * "version": "string"
},
    * "property2": {
      * "capabilities": {
        * "property1": {
          * "property1": "string",
          * "property2": "string"
},
        * "property2": {
          * "property1": "string",
          * "property2": "string"
}
},
      * "description": "string",
      * "dsize": 0,
      * "sha1sum": "string",
      * "version": "string"
}
}

}
```

--------------------------------

### GET /pg_mgr/install

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves the installation service resources.

```APIDOC
## GET /pg_mgr/install

### Description
Retrieves the installation service resources.

### Method
GET

### Endpoint
https://openapi.wazo.community/api/provd/0.2/pg_mgr/install

### Authorizations
wazo_auth_token

### Required ACL
provd.pg_mgr.install.read

### Response
#### Success Response (200)
- **links** (array) - A list of related resources.

#### Response Example
{
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ]
}
```

--------------------------------

### GET /plugins

Source: https://wazo-platform.org/documentation/api/plugins.html

List all installed plugins.

```APIDOC
## GET /plugins

### Description
Allow the administrator to get a list of all installed plugins.

### Method
GET

### Endpoint
/plugins

### Response
#### Success Response (200)
- **items** (array) - List of installed plugins
- **total** (integer) - Total count of plugins
```

--------------------------------

### GET /pg_mgr/install/installable

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves the list of installable plugins available in the provisioning manager.

```APIDOC
## GET /pg_mgr/install/installable

### Description
Retrieves the list of installable plugins.

### Method
GET

### Endpoint
https://openapi.wazo.community/api/provd/0.2/pg_mgr/install/installable

### Authorizations
wazo_auth_token

### Required ACL
provd.pg_mgr.install.installable.read

### Response
#### Success Response (200)
- **pkgs** (object) - A collection of installable packages.

#### Response Example
{
  "pkgs": {
    "property1": {
      "capabilities": {
        "property1": {
          "property1": "string",
          "property2": "string"
        }
      },
      "description": "string",
      "dsize": 0,
      "sha1sum": "string",
      "version": "string"
    }
  }
}
```

--------------------------------

### Install a Package

Source: https://wazo-platform.org/documentation/api/provisioning.html

Initiates the installation of a specific plugin package.

```json
{
  * "id": "abcdef1234567890"

}
```

```json
"string"
```

--------------------------------

### Get Installable Packages List

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves a list of installable packages associated with a specific plugin.

```json
{
  "pkgs": {
    "property1": {
      "capabilities": {
        "property1": {
          "property1": "string",
          "property2": "string"
},
        "property2": {
          "property1": "string",
          "property2": "string"
}
},
      "description": "string",
      "dsize": 0,
      "sha1sum": "string",
      "version": "string"
},
    "property2": {
      "capabilities": {
        "property1": {
          "property1": "string",
          "property2": "string"
},
        "property2": {
          "property1": "string",
          "property2": "string"
}
},
      "description": "string",
      "dsize": 0,
      "sha1sum": "string",
      "version": "string"
}
}

}
```

--------------------------------

### GET /pg_mgr/install/installed

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves the list of all installed plugins.

```APIDOC
## GET /pg_mgr/install/installed

### Description
Retrieves the list of all installed plugins in the system.

### Method
GET

### Endpoint
/pg_mgr/install/installed

### Response
#### Success Response (200)
- **pkgs** (object) - List of installed plugins
```

--------------------------------

### Conference Participant Talk Started Event Example

Source: https://wazo-platform.org/documentation/events/application

Example payload and headers for the conference_participant_talk_started event.

```json
{
  "conference_id": 0,
  "participant": {
    "id": "string",
    "caller_id_name": "string",
    "caller_id_number": "string",
    "muted": true,
    "join_time": 0,
    "admin": true,
    "language": "string",
    "call_id": "string",
    "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f"
  }
}
```

```json
{
  "name": "conference_participant_talk_started",
  "required_acl": "events.conferences.{conference_id}.participants.talk",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z",
  "tenant_uuid": "3467989a-e428-43d0-b560-aedbbec33ae0",
  "user_uuid:{uuid}": true
}
```

--------------------------------

### Get Configuration Manager Resource Response

Source: https://wazo-platform.org/documentation/api/provisioning.html

Example response structure for the configuration manager entry point.

```json
{
  * "links": [
    * {
      * "href": "string",
      * "rel": "string"
}
]

}
```

--------------------------------

### GET /pg_mgr/plugins/{plugin_id}/install/installable

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves a list of installable packages for a specific provisioning plugin.

```APIDOC
## GET /pg_mgr/plugins/{plugin_id}/install/installable

### Description
Retrieves the list of installable packages associated with a specific plugin.

### Method
GET

### Endpoint
/pg_mgr/plugins/{plugin_id}/install/installable

### Parameters
#### Path Parameters
- **plugin_id** (string) - Required - Plugin ID

### Response
#### Success Response (200)
- **pkgs** (object) - A collection of installable packages with their metadata.

#### Response Example
{
  "pkgs": {
    "property1": {
      "capabilities": {
        "property1": {
          "property1": "string",
          "property2": "string"
        }
      },
      "description": "string",
      "dsize": 0,
      "sha1sum": "string",
      "version": "string"
    }
  }
}
```

--------------------------------

### GET /plugins/{namespace}/{name}

Source: https://wazo-platform.org/documentation/api/plugins.html

Fetch information about an installed plugin.

```APIDOC
## GET /plugins/{namespace}/{name}

### Description
Fetch the information about a plugin that has been installed.

### Method
GET

### Endpoint
/plugins/{namespace}/{name}

### Parameters
#### Path Parameters
- **namespace** (string) - Required - The plugin's namespace
- **name** (string) - Required - The plugin's name

### Response
#### Success Response (200)
- **name** (string) - Plugin name
- **namespace** (string) - Plugin namespace
- **version** (string) - Plugin version
```

--------------------------------

### Configure a conference backend source response example

Source: https://wazo-platform.org/documentation/api/contact.html

Example response body returned upon successfully creating a conference source.

```json
{
  "auth": {
    "key_file": "/usr/share/wazo-dird/my-auth-key.yml"
},
  "format_columns": {
    "displayname": "{name}"
},
  "name": "conferences",
  "searched_columns": [
    "number",
    "name"
]

}
```

--------------------------------

### Install Webhook Plugin

Source: https://wazo-platform.org/documentation/overview/webhook-core.html

Command to install the custom webhook service package.

```bash
python ./setup.py install
```

--------------------------------

### Get General Provd Configuration Response

Source: https://wazo-platform.org/documentation/api/provisioning.html

Example JSON response structure for the general configuration endpoint.

```json
{
  * "params": [
    * {
      * "description": "string",
      * "id": "string",
      * "links": {
        * "links": [
          * {
            * "href": "string",
            * "rel": "string"
}
]
},
      * "value": "string"
}
]

}
```

--------------------------------

### GET /pg_mgr/plugins/{plugin_id}/install

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves the installation service resources for a specific plugin.

```APIDOC
## GET /pg_mgr/plugins/{plugin_id}/install

### Description
Retrieves the package installation service resources for the specified plugin.

### Method
GET

### Endpoint
/pg_mgr/plugins/{plugin_id}/install

### Parameters
#### Path Parameters
- **plugin_id** (string) - Required - Plugin ID

### Response
#### Success Response (200)
- **links** (array) - Links to the installation resources

#### Error Response (404)
- No such resource. The provided id does not exist.
```

--------------------------------

### POST /pg_mgr/install/install

Source: https://wazo-platform.org/documentation/api/provisioning.html

Installs a plugin by its ID.

```APIDOC
## POST /pg_mgr/install/install

### Description
Installs a plugin using the provided package ID.

### Method
POST

### Endpoint
/pg_mgr/install/install

### Request Body
- **id** (string) - Required - The ID of the package to install.

### Request Example
{
  "id": "abcdef1234567890"
}

### Response
#### Success Response (201)
- Operation in progress
```

--------------------------------

### POST /plugins

Source: https://wazo-platform.org/documentation/api/plugins.html

Install a new plugin on the server.

```APIDOC
## POST /plugins

### Description
Allow the administrator to install a plugin on the server.

### Method
POST

### Endpoint
/plugins

### Parameters
#### Query Parameters
- **reinstall** (boolean) - Optional - If true, the plugin will be reinstalled if already present

#### Request Body
- **method** (string) - Required - The method used to fetch this plugin (e.g., "git")
- **options** (object) - Optional - Method dependant installation options

### Response
#### Success Response (200)
- **uuid** (string) - The UUID of the installation process
```

--------------------------------

### Start Command Response

Source: https://wazo-platform.org/documentation/overview/websocket-app.html

The server's confirmation message after the start command is processed.

```json
{"op": "start", "code": 0}
```

--------------------------------

### Install Plugin Request and Response

Source: https://wazo-platform.org/documentation/api/plugins.html

Payload for installing a plugin and the corresponding response containing the installation UUID.

```json
{
  * "method": "git",
  * "options": { }

}
```

```json
{
  * "uuid": "string"

}
```

--------------------------------

### LDAP Source Configuration Example

Source: https://wazo-platform.org/documentation/api/contact.html

A concrete example of a valid JSON payload for configuring an LDAP source.

```json
{
  "format_columns": {
    "displayname": "{displayName}",
    "exten": "{telephoneNumber}",
    "firstname": "{givenName}",
    "lastname": "{sn}"
},
  "ldap_base_dn": "ou=people,dc=example,dc=com",
  "ldap_custom_filter": "(l=québec)",
  "ldap_password": "foobar",
  "ldap_uri": "ldap://example.com",
  "ldap_username": "cn=admin,dc=example,dc=org",
  "name": "ldap",
  "searched_columns": [
    "firstname",
    "lastname"
],
  "unique_column": "objectGUID",
  "unique_column_format": "binary_uuid"

}
```

--------------------------------

### Provisioning Networking Edited Event Example

Source: https://wazo-platform.org/documentation/events/configuration

Example payload and headers for the provisioning_networking_edited event.

```json
{}
```

```json
{
  "name": "provisioning_networking_edited",
  "required_acl": "events.config.provisioning.networking.edited",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z"
}
```

--------------------------------

### List Installed Plugins Response

Source: https://wazo-platform.org/documentation/api/plugins.html

JSON structure for the list of currently installed plugins.

```json
{
  * "items": [
    * {
      * "name": "string",
      * "namespace": "string",
      * "version": "string"
}
],
  * "total": 0

}
```

--------------------------------

### User External App Created Event Example

Source: https://wazo-platform.org/documentation/events/configuration

Example payload and headers for the user_external_app_created configuration event.

```json
{
  "name": "string"
}
```

```json
{
  "name": "user_external_app_created",
  "required_acl": "events.config.user_external_apps.created",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z",
  "tenant_uuid": "3467989a-e428-43d0-b560-aedbbec33ae0"
}
```

--------------------------------

### Create Conference Source Response Example

Source: https://wazo-platform.org/documentation/api/contact.html

Example response returned after successfully creating a conference source.

```json
{
  "auth": {
    "key_file": "/usr/share/wazo-dird/my-auth-key.yml"
  },
  "format_columns": {
    "displayname": "{name}"
  },
  "name": "conferences",
  "searched_columns": [
    "number",
    "name"
  ]
}
```

--------------------------------

### POST /setup

Source: https://wazo-platform.org/documentation/api/setup.html

Performs the initial setup of the Wazo Engine, including optional Nestbox registration.

```APIDOC
## POST /setup

### Description
Setup the Wazo Engine.

### Method
POST

### Endpoint
https://openapi.wazo.community/1.0/setup

### Request Body
- **engine_instance_uuid** (string) - Optional - The UUID identifying this instance on Nestbox.
- **engine_internal_address** (string) - Optional - IP address of the engine.
- **engine_language** (string) - Required - The interface language for the Wazo Engine (en_US or fr_FR).
- **engine_license** (boolean) - Required - Whether the GNU GPLv3 license is accepted.
- **engine_password** (string) - Required - Password of the first administrator root on the engine.
- **engine_rtp_icesupport** (boolean) - Optional - Enable ICE support (Default: false).
- **engine_rtp_stunaddr** (string) - Optional - The address of the STUN server (Default: null).
- **nestbox_engine_host** (string) - Optional - Host used by Nestbox to contact the engine.
- **nestbox_engine_port** (integer) - Optional - Port used by Nestbox to contact the engine (Default: 443).
- **nestbox_host** (string) - Optional - Host of the Nestbox where the engine will register.
- **nestbox_instance_name** (string) - Optional - Name of the engine in Nestbox.
- **nestbox_instance_preferred_connection** (string) - Optional - Preferred connection method (private or public, Default: public).
- **nestbox_port** (integer) - Optional - Port of the Nestbox where the engine will register (Default: 443).
- **nestbox_service_id** (string) - Optional - Nestbox username used to register the engine.
- **nestbox_service_key** (string) - Optional - Nestbox password used to register the engine.
- **nestbox_verify_certificate** (boolean) - Optional - Should the certificate used for HTTPS be verified? (Default: true).

### Response
#### Success Response (201)
- **status** (string) - The setup has been completed
```

--------------------------------

### CSV source creation response example

Source: https://wazo-platform.org/documentation/api/contact.html

An example of a successful 201 response body after creating a CSV source.

```json
{
  "delimiter": ":",
  "format_columns": {
    "displayname": "{firstname} {lastname}"
},
  "list_url": "https://my-service/all",
  "lookup_url": "https://my-service/search",
  "name": "ws",
  "searched_columns": [
    "firstname",
    "lastname"
],
  "unique_column": "uuid",
  "verify_certificate": false

}
```

--------------------------------

### POST /pg_mgr/plugins/{plugin_id}/install/install

Source: https://wazo-platform.org/documentation/api/provisioning.html

Initiates the installation of a specific plugin package.

```APIDOC
## POST /pg_mgr/plugins/{plugin_id}/install/install

### Description
Starts the installation process for a plugin package.

### Method
POST

### Endpoint
/pg_mgr/plugins/{plugin_id}/install/install

### Parameters
#### Path Parameters
- **plugin_id** (string) - Required - Plugin ID

#### Request Body
- **id** (string) - Required - Package ID

### Request Example
{
  "id": "abcdef1234567890"
}

### Response
#### Success Response (201)
- Operation in progress
```

--------------------------------

### GET /displays

Source: https://wazo-platform.org/documentation/api/contact.html

Retrieves a list of configured displays.

```APIDOC
## GET /displays

### Description
Retrieves a list of configured displays.

### Method
GET

### Endpoint
https://openapi.wazo.community/0.1/displays

### Parameters
#### Query Parameters
- **recurse** (boolean) - Optional - Should the query include sub-tenants (Default: false)
- **order** (string) - Optional - Name of the field to use for sorting the list of items returned.
- **direction** (string) - Optional - Sort list of items in 'asc' (ascending) or 'desc' (descending) order
- **limit** (integer) - Optional - The limit defines the number of individual objects that are returned
- **offset** (integer) - Optional - The offset defines the offsets the start by the number specified (Default: 0)

#### Header Parameters
- **Wazo-Tenant** (string) - Required - The tenant's UUID, defining the ownership of a given resource.

### Response
#### Success Response (200)
- A list of configured displays
```

--------------------------------

### List Configurations Response

Source: https://wazo-platform.org/documentation/api/provisioning.html

Example response structure for listing device configurations.

```json
{
  * "configs": [
    * {
      * "deletable": true,
      * "id": "abcdef123456890",
      * "parent_ids": [
        * "base"
],
      * "raw_config": {
        * "sip_lines": {
          * "1": {
            * "auth_username": "100",
            * "display_name": "Foo",
            * "password": "100",
            * "username": "100"
}
}
}
}
]

}
```

--------------------------------

### GET /pg_mgr/plugins

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves a list of all installed plugins.

```APIDOC
## GET /pg_mgr/plugins

### Description
Returns a list of all installed plugins and their associated resources.

### Method
GET

### Endpoint
/pg_mgr/plugins

### Response
#### Success Response (200)
- **plugins** (object) - List of all the installed plugins and their resources.
```

--------------------------------

### wazo-setupd API Overview

Source: https://wazo-platform.org/documentation/console/setup

The wazo-setupd service provides endpoints for system configuration, initialization, and status monitoring.

```APIDOC
## wazo-setupd

### Description
The wazo-setupd service allows for the initialization and management of the Wazo Engine platform configuration.

### Base URL
/1.0

### Available Operations
- **config**: Manage system configuration settings.
- **setup**: Perform initial system setup operations.
- **status**: Retrieve the current status of the setup process.
```

--------------------------------

### Create User Response Sample

Source: https://wazo-platform.org/documentation/api/authentication.html

Example of the JSON response returned upon successful user creation.

```json
{
  * "authentication_method": "default",
  * "emails": [
    * {
      * "address": "string",
      * "confirmed": true,
      * "main": true
}
],
  * "purpose": "user",
  * "username": "string",
  * "uuid": "string"

}
```

--------------------------------

### GET /sources

Source: https://wazo-platform.org/documentation/api/contact.html

Retrieves a list of all configured sources.

```APIDOC
## GET /sources

### Description
Retrieves a list of all configured sources. Requires the 'dird.sources.read' ACL.

### Method
GET

### Endpoint
https://openapi.wazo.community/0.1/sources

### Parameters
#### Header Parameters
- **Wazo-Tenant** (string) - Required - The tenant's UUID, defining the ownership of a given resource.

#### Query Parameters
- **recurse** (boolean) - Optional - Should the query include sub-tenants (Default: false)
- **order** (string) - Optional - Name of the field to use for sorting the list of items returned.
- **direction** (string) - Optional - Sort list of items in 'asc' (ascending) or 'desc' (descending) order
- **limit** (integer) - Optional - The limit defines the number of individual objects that are returned
- **offset** (integer) - Optional - The offset defines the offsets the start by the number specified (Default: 0)
- **search** (string) - Optional - Search term for filtering a list of items.

### Response
#### Success Response (200)
- **filtered** (integer) - Number of filtered items
- **items** (array) - List of source objects
- **total** (integer) - Total number of items

#### Response Example
{
  "filtered": 0,
  "items": [
    {
      "backend": "string",
      "name": "string",
      "uuid": "string"
    }
  ],
  "total": 0
}
```

--------------------------------

### GET /pg_mgr/install/install/{operation_id}

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves the status of an ongoing plugin installation operation.

```APIDOC
## GET /pg_mgr/install/install/{operation_id}

### Description
Retrieves the current status of a plugin installation operation identified by the operation ID.

### Method
GET

### Endpoint
/pg_mgr/install/install/{operation_id}

### Parameters
#### Path Parameters
- **operation_id** (string) - Required - Operation In Progress ID

### Response
#### Success Response (200)
- **status** (string) - The current status of the operation

#### Response Example
{
  "status": "string"
}
```

--------------------------------

### Define Webhook Service in setup.py

Source: https://wazo-platform.org/documentation/overview/webhook-core.html

Register the webhook service using setuptools entry points to ensure discovery by stevedore.

```python
    from setuptools import setup
    from setuptools import find_packages

    setup(
        name='wazo-webhookd-service-example',
        version='1.0',
        packages=find_packages(),
        entry_points={
        'wazo_webhookd.services': [
                'example = example_service.plugin:Service',
            ]
        }
    )
```

--------------------------------

### GET /pg_mgr/plugins/{plugin_id}/install/install/{operation_id}

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves the status of a package installation operation.

```APIDOC
## GET /pg_mgr/plugins/{plugin_id}/install/install/{operation_id}

### Description
Retrieves the status of a package installation operation.

### Method
GET

### Endpoint
/pg_mgr/plugins/{plugin_id}/install/install/{operation_id}

### Parameters
#### Path Parameters
- **plugin_id** (string) - Required - Plugin ID
- **operation_id** (string) - Required - Operation In Progress ID

### Response
#### Success Response (200)
- **status** (string) - The current status of the operation

#### Error Response (404)
- No such resource. The provided id does not exist
```

--------------------------------

### POST /wizard

Source: https://wazo-platform.org/documentation/api/configuration.html

Configures the system using the wizard. This API can only be used before the wizard configuration is completed.

```APIDOC
## POST /wizard

### Description
Configures the system using the provided wizard parameters. This API can only be used before the wizard configuration is completed.

### Method
POST

### Endpoint
/wizard

### Request Body
- **admin_password** (string) - Required - Wazo administrator root password
- **language** (string) - Optional - Default: "en_US"
- **license** (boolean) - Required - Accept/decline the GPLv3
- **network** (object) - Required - Network configuration
- **steps** (object) - Optional - Wizard configuration steps
- **timezone** (string) - Required - System timezone

### Response
#### Success Response (201)
- Wizard passed successfully
```

--------------------------------

### GET /pg_mgr/plugins/{plugin_id}/install/installed

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves the list of installed packages for a specific plugin.

```APIDOC
## GET /pg_mgr/plugins/{plugin_id}/install/installed

### Description
Retrieves the list of installed packages for a specific plugin identified by its ID.

### Method
GET

### Endpoint
/pg_mgr/plugins/{plugin_id}/install/installed

### Parameters
#### Path Parameters
- **plugin_id** (string) - Required - Plugin ID

### Response
#### Success Response (200)
- **pkgs** (object) - List of installed packages

#### Error Response (404)
- No such resource. The provided id does not exist
```

--------------------------------

### Create device response

Source: https://wazo-platform.org/documentation/api/configuration.html

Example of the JSON response returned upon successful device creation.

```json
{
  "description": "string",
  "id": "string",
  "ip": "string",
  "is_new": true,
  "mac": "string",
  "model": "string",
  "options": {
    "switchboard": true
},
  "plugin": "string",
  "sn": "string",
  "status": "autoprov",
  "template_id": "string",
  "tenant_uuid": "string",
  "vendor": "string",
  "version": "string"
}
```

--------------------------------

### Create Extension Response Sample

Source: https://wazo-platform.org/documentation/api/configuration.html

Example of the JSON response returned upon successful creation of an extension.

```json
{
  "context": "string",
  "exten": "string",
  "id": 0,
  "commented": true,
  "enabled": true,
  "tenant_uuid": "string",
  "conference": {
    "id": 0,
    "name": "string"
},
  "group": {
    "id": 0,
    "name": "string",
    "uuid": "string"
},
  "incall": {
    "id": 0
},
  "lines": [
    {
      "id": 0,
      "name": "string"
}
],
  "outcall": {
    "id": 0,
    "name": "string"
},
  "parking_lot": {
    "id": 0,
    "name": "string"
},
  "queue": {
    "id": 0,
    "label": "string",
    "name": "string"
}

}
```

--------------------------------

### Get Localization Configuration Response

Source: https://wazo-platform.org/documentation/api/configuration.html

Example JSON response structure for the localization configuration endpoint.

```json
{
  "country": "string",
  "tenant_uuid": "string"
}
```

--------------------------------

### Run unit tests

Source: https://wazo-platform.org/documentation/overview/authentication-dev.html

Installs necessary system dependencies and runs unit tests using tox.

```bash
apt update
apt install libldap2-dev libpq-dev python-dev libffi-dev libyaml-dev libsasl2-dev
pip install tox
tox --recreate -e py27
```

--------------------------------

### Retrieve User List Response

Source: https://wazo-platform.org/documentation/api/authentication.html

Example JSON response structure for the GET /users endpoint.

```json
{
  "filtered": 0,
  "items": [
    {
      "emails": [
        {
          "address": "string",
          "confirmed": true,
          "main": true
        }
      ],
      "enabled": true,
      "firstname": "string",
      "lastname": "string",
      "purpose": "user",
      "tenant_uuid": "string",
      "username": "string",
      "uuid": "string"
    }
  ],
  "total": 0
}
```

--------------------------------

### Run the wazo-plugind container

Source: https://wazo-platform.org/documentation/overview/plugins-admin.html

Starts the service container, requiring the XIVO_UUID environment variable to be set.

```bash
docker run -e"XIVO_UUID=<the xivo UUID>" wazoplatform/wazo-plugind
```

--------------------------------

### Retrieve LDAP source configurations

Source: https://wazo-platform.org/documentation/api/contact.html

Example JSON response structure returned by the GET /backends/ldap/sources endpoint.

```json
{
  "filtered": 0,
  "total": 0,
  "items": [
    {
      "first_matched_columns": [
        "string"
      ],
      "format_columns": { },
      "name": "string",
      "searched_columns": [
        "string"
      ],
      "uuid": "string",
      "ldap_base_dn": "string",
      "ldap_custom_filter": "string",
      "ldap_network_timeout": 0.3,
      "ldap_password": "string",
      "ldap_timeout": 1,
      "ldap_uri": "string",
      "ldap_username": "string",
      "unique_column": "string",
      "unique_column_format": "string"
    }
  ]
}
```

--------------------------------

### Retrieve connected users list response

Source: https://wazo-platform.org/documentation/api/authentication.html

Example JSON response for the GET /external/{auth_type}/users endpoint.

```json
{
  * "filtered": 3,
  * "items": [
    * {
      * "user_uuid": "210ef281-4201-4f95-952f-5f8d5211e085"
},
    * {
      * "user_uuid": "28e6f253-a19d-458d-8b52-2ba6feb788bc"
},
    * {
      * "user_uuid": "e72fe53d-3981-4c51-a488-e06ca94fcbb1"
}
],
  * "total": 3

}
```

--------------------------------

### Create a new display configuration response

Source: https://wazo-platform.org/documentation/api/contact.html

Example JSON response structure for a successful display configuration creation.

```json
{
  "columns": [
    {
      "field": "firstname",
      "title": "Firstname"
    },
    {
      "default": "",
      "field": "lastname",
      "title": "Lastname"
    },
    {
      "field": "number",
      "number_display": "{firstname} {lastname}",
      "title": "Number",
      "type": "number"
    },
    {
      "field": "email",
      "title": "Email",
      "type": "email"
    }
  ],
  "name": "english"
}
```

--------------------------------

### Status Response Schema

Source: https://wazo-platform.org/documentation/api/setup.html

Example response structure for the GET /status endpoint indicating the health of internal components.

```json
{
  * "master_tenant": {
    * "status": "fail"
},
  * "rest_api": {
    * "status": "fail"
}

}
```

--------------------------------

### GET /configure

Source: https://wazo-platform.org/documentation/api/provisioning.html

Retrieves the general provd configuration settings.

```APIDOC
## GET /configure

### Description
Retrieves the general provd configuration settings.

### Method
GET

### Endpoint
https://openapi.wazo.community/api/provd/0.2/configure

### Response
#### Success Response (200)
- **params** (array) - List of configuration parameters.
```

--------------------------------

### Get Google Configuration Response Sample

Source: https://wazo-platform.org/documentation/api/contact.html

Sample response structure for listing configured Google sources.

```json
{
  "filtered": 0,
  "total": 0,
  "items": [
    {
      "first_matched_columns": [
        "string"
],
      "format_columns": { },
      "name": "string",
      "searched_columns": [
        "string"
],
      "uuid": "string",
      "auth": {
        "host": "localhost",
        "timeout": 0,
        "verify_certificate": true,
        "port": 9497,
        "version": "0.1"
}
}
]

}
```

--------------------------------

### Get Recordings Announcements Configuration

Source: https://wazo-platform.org/documentation/api/configuration.html

Response schema for retrieving the current recording start and stop announcement filenames.

```json
{
  * "recording_start": "string",
  * "recording_stop": "string"

}
```

--------------------------------

### Plugin Install Progress Headers

Source: https://wazo-platform.org/documentation/events/plugins

AMQP header structure for the plugin_install_progress event.

```json
{
  "name": "plugin_install_progress",
  "required_acl": "events.plugin.install.{uuid}.{status}",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z"
}
```

--------------------------------

### Retrieve user external auth data response

Source: https://wazo-platform.org/documentation/api/authentication.html

Example JSON response for the GET /users/{user_uuid}/external endpoint.

```json
{
  * "filtered": 0,
  * "items": [
    * {
      * "data": { },
      * "enabled": true,
      * "plugin_info": { },
      * "type": "string"
}
],
  * "total": 0

}
```

--------------------------------

### Full WebSocket Client Implementation

Source: https://wazo-platform.org/documentation/overview/websocket-app.html

A complete HTML page example demonstrating how to connect to the Wazo WebSocket service, subscribe to events, and handle incoming messages.

```html
<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>Wazo WebSocket Example</title>
<script>
var socket = null;
var started = false;

function connect() {
    if (socket != null) {
        console.log("socket already connected");
        return;
    }

    var host = document.getElementById("host").value;
    var token_id = document.getElementById("token").value;
    socket = new WebSocket("wss://" + host + "/api/websocketd/?token=" + token_id);
    socket.onclose = function(event) {
        socket = null;
        console.log("websocketd closed with code " + event.code + " and reason '" + event.reason + "'");
    };
    socket.onmessage = function(event) {
        var msg = JSON.parse(event.data);
        switch (msg.op) {
            case "init":
                subscribe("*");
                start();
                break;
            case "start":
                console.log("waiting for messages");
                break;
            case "event":
                console.log("message received: " + msg.data);
                break;
        }
    };
    started = false;
}

function subscribe(event_name) {
    var msg = {
        op: "subscribe",
        data: {
          event_name: event_name
        }
    };
    socket.send(JSON.stringify(msg));
};

function start() {
    var msg = {
        op: "start"
    };
    socket.send(JSON.stringify(msg));
}
</script>
</head>
<body>
  <p>Open the web console to see what's happening.</p>
  <form>
    <div>
      <label for="host">Host:</label>
      <input type="text" id="host" autofocus>
    </div>
    <div>
      <label for="token">Token ID:</label>
      <input type="text" id="token" size="35">
    </div>
    <div>
      <button type="button" onclick="connect();">Connect</button>
    </div>
  </form>
</body>
</html>
```

--------------------------------

### Retrieve User External Auth Data Response

Source: https://wazo-platform.org/documentation/api/authentication.html

Example JSON response structure for the GET /users/{user_uuid}/external endpoint.

```json
{
  "filtered": 0,
  "items": [
    {
      "data": { },
      "enabled": true,
      "plugin_info": { },
      "type": "string"
    }
  ],
  "total": 0
}
```

--------------------------------

### Run unit tests with tox

Source: https://wazo-platform.org/documentation/overview/application-dev.html

Install tox and execute the test suite for the Python 3.7 environment.

```bash
pip install tox
tox --recreate -e py37
```

--------------------------------

### GET /exports/{export_uuid}

Source: https://wazo-platform.org/documentation/api/cdr.html

Get an export by the given UUID.

```APIDOC
## GET /exports/{export_uuid}

### Description
Get an export by the given UUID.

### Method
GET

### Endpoint
https://openapi.wazo.community/1.0/exports/{export_uuid}

### Parameters
#### Path Parameters
- **export_uuid** (string) - Required - UUID of the given export

### Response
#### Success Response (200)
- **filename** (string) - Filename of the export
- **requested_at** (string) - Timestamp of request
- **status** (string) - Status of the export
- **tenant_uuid** (string) - Tenant UUID
- **user_uuid** (string) - User UUID
- **uuid** (string) - Export UUID
```

--------------------------------

### Create a new tenant response sample

Source: https://wazo-platform.org/documentation/api/authentication.html

JSON schema for the response returned after a successful tenant creation.

```json
{
  "name": "string",
  "parent_uuid": "string",
  "uuid": "string"

}
```

--------------------------------

### Build and Run Wazo Auth Docker Images

Source: https://wazo-platform.org/documentation/overview/authentication-admin.html

Commands to build and execute the Wazo Auth and database containers.

```bash
% docker build -t wazoplatform/wazo-auth .
```

```bash
% docker run -p 9497:9497 -v /conf/wazo-auth:/etc/wazo-auth/conf.d/ -it wazoplatform/wazo-auth bash
% wazo-auth [-df] [-u <user>] [-c <path/to/config/file>]
```

```bash
% docker build -f contribs/docker/Dockerfile-db -t wazoplatform/wazo-auth-db .
```

--------------------------------

### GET /users/{user_uuid}/presences

Source: https://wazo-platform.org/documentation/api/chat.html

Get the presence status of a specific user.

```APIDOC
## GET /users/{user_uuid}/presences

### Description
Get user presence information.

### Method
GET

### Endpoint
/users/{user_uuid}/presences

### Parameters
#### Path Parameters
- **user_uuid** (string) - Required - The UUID of the user

#### Header Parameters
- **Wazo-Tenant** (string) - Optional - The tenant's UUID, defining the ownership of a given resource.

### Response
#### Success Response (200)
- **connected** (boolean)
- **do_not_disturb** (boolean)
- **last_activity** (string)
- **line_state** (string)
- **lines** (array)
- **mobile** (boolean)
- **state** (string)
- **status** (string)
- **tenant_uuid** (string)
- **uuid** (string)

#### Error Response (404)
- The resource requested was not found on the server
```

--------------------------------

### Queue Edited Event Example

Source: https://wazo-platform.org/documentation/events/configuration

Example payload and headers for the queue_edited event.

```json
{
  "queue_id": 0
}
```

```json
{
  "name": "queue_edited",
  "required_acl": "events.config.queues.edited",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z",
  "tenant_uuid": "3467989a-e428-43d0-b560-aedbbec33ae0"
}
```

--------------------------------

### Configure Personal Backend Source Response

Source: https://wazo-platform.org/documentation/api/contact.html

Example response body for a successfully created personal contact source.

```json
{
  "format_columns": {
    "displayname": "{firstname} {lastname}"
},
  "name": "Personals",
  "searched_columns": [
    "firstname",
    "lastname"
]

}
```

--------------------------------

### Run integration tests

Source: https://wazo-platform.org/documentation/overview/application-dev.html

Commands to set up and execute integration tests, requiring Docker and the chan-test repository.

```bash
cd integration_tests
pip install -r test-requirements.txt
git clone https://github.com/wazo-platform/chan-test
export CHAN_TEST_DIR=$PWD/chan-test   # CHAN_TEST_DIR defaults to ../../chan-test
make test-setup
make test
```

--------------------------------

### Queue Deleted Event Example

Source: https://wazo-platform.org/documentation/events/configuration

Example payload and headers for the queue_deleted event.

```json
{
  "queue_id": 0
}
```

```json
{
  "name": "queue_deleted",
  "required_acl": "events.config.queues.deleted",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z",
  "tenant_uuid": "3467989a-e428-43d0-b560-aedbbec33ae0"
}
```

--------------------------------

### Queue Created Event Example

Source: https://wazo-platform.org/documentation/events/configuration

Example payload and headers for the queue_created event.

```json
{
  "queue_id": 0
}
```

```json
{
  "name": "queue_created",
  "required_acl": "events.config.queues.created",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z",
  "tenant_uuid": "3467989a-e428-43d0-b560-aedbbec33ae0"
}
```

--------------------------------

### User Edited Event Example

Source: https://wazo-platform.org/documentation/events/configuration

Example payload and headers for the user_edited configuration event.

```json
{
  "user_id": 0,
  "subscription_type": "string",
  "created_at": "string"
}
```

```json
{
  "name": "user_edited",
  "required_acl": "events.config.user.edited",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z",
  "tenant_uuid": "3467989a-e428-43d0-b560-aedbbec33ae0",
  "user_uuid:{uuid}": true
}
```

--------------------------------

### POST /dev_mgr/devices

Source: https://wazo-platform.org/documentation/api/provisioning.html

Creates a new device in the provisioning system.

```APIDOC
## POST /dev_mgr/devices

### Description
Creates a new device using the provided device schema.

### Method
POST

### Endpoint
/dev_mgr/devices

### Parameters
#### Header Parameters
- **Wazo-Tenant** (string) - Optional - The tenant's UUID, defining the ownership of a given resource

#### Request Body
- **device** (object) - Required - A device schema

### Request Example
{
  "device": {
    "added": "string",
    "config": "string",
    "description": "string",
    "id": "string",
    "ip": "string",
    "mac": "string",
    "model": "string",
    "plugin": "string",
    "remote_state_sip_username": "string",
    "vendor": "string",
    "version": "string"
  }
}

### Response
#### Success Response (201)
- **id** (string) - The ID of the created device

#### Response Example
{
  "id": "abcdef1234567890"
}
```

--------------------------------

### Conference Participant Muted Event Example

Source: https://wazo-platform.org/documentation/events/application

Example payload and headers for the conference_participant_muted event.

```json
{
  "conference_id": 0,
  "participant": {
    "id": "string",
    "caller_id_name": "string",
    "caller_id_number": "string",
    "muted": true,
    "join_time": 0,
    "admin": true,
    "language": "string",
    "call_id": "string",
    "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f"
  }
}
```

```json
{
  "name": "conference_participant_muted",
  "required_acl": "events.conferences.{conference_id}.participants.mute",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z",
  "tenant_uuid": "3467989a-e428-43d0-b560-aedbbec33ae0"
}
```

--------------------------------

### Launch Wazo Auth

Source: https://wazo-platform.org/documentation/overview/authentication-admin.html

Command to start the Wazo Auth service with optional debug mode and configuration path.

```bash
wazo_auth [-d] [--user <user>] --config <path/to/config/file>
```

--------------------------------

### Voicemail Transcription Completed Headers Example

Source: https://wazo-platform.org/documentation/events/webhook

Example JSON headers for the voicemail_transcription_completed event.

```json
{
  "name": "voicemail_transcription_completed",
  "required_acl": "events.voicemails.transcriptions.completed",
  "origin_uuid": "311e21cd-c040-4b48-bc92-4bc16db9c2a0",
  "timestamp": "2019-08-24T14:15:22Z",
  "tenant_uuid": "3467989a-e428-43d0-b560-aedbbec33ae0"
}
```

--------------------------------

### Voicemail Transcription Completed Payload Example

Source: https://wazo-platform.org/documentation/events/webhook

Example JSON payload for the voicemail_transcription_completed event.

```json
{
  "message_id": "string",
  "tenant_uuid": "3467989a-e428-43d0-b560-aedbbec33ae0",
  "voicemail_id": 0,
  "transcription_text": "string",
  "provider_id": "string",
  "language": "string",
  "duration": 0,
  "completed_at": "2019-08-24T14:15:22Z"
}
```

--------------------------------

### Wazo backend source creation response

Source: https://wazo-platform.org/documentation/api/contact.html

Example response returned upon successful creation of a source.

```json
{
  "auth": {
    "key_file": "/usr/share/wazo-dird/my-auth-key.yml"
},
  "format_columns": {
    "displayname": "{firstname} {lastname}"
},
  "name": "internal_users",
  "searched_columns": [
    "firstname",
    "lastname"
]

}
```

--------------------------------

### Start Event Stream

Source: https://wazo-platform.org/documentation/overview/websocket-app.html

Command to initiate the delivery of subscribed events from the server.

```json
{"op": "start"}
```
Tokens:
Raw