How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wazo Funckeys API

The funckeys API from Wazo — 9 operation(s) for funckeys.

Wazo Funckeys API is one of 113 APIs that Wazo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include funckeys. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, a changelog, authentication docs, and an AsyncAPI specification.

This API exposes 18 operations across 9 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.1.

Requests are made against a single base URL, /1.1.

18 operations 9 paths 7 schemas 4 DELETE8 GET1 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1
Base URL
https://{wazo_stack}/api/auth/0.1
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Wazo Funckeys API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (wazo_auth_token). By default, every request must be authenticated.

Paths & Operations 18

Across 9 paths, the API surfaces 18 operations — 4 DELETE, 8 GET, 1 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

funckeys 18
GET
/funckeys/destinations
List of possible func key destinations and their parameters
list_func_key_destinations → 200
GET
/funckeys/templates
List a func key template
list_func_key_template 5 params → 200404
POST
/funckeys/templates
Create a template of func keys
create_func_key_template 1 param body → 201400
GET
/funckeys/templates/{template_id}
Get a func key template
get_func_key_template 2 params → 200404
PUT
/funckeys/templates/{template_id}
Update a func key template
update_func_key_template 2 params body → 204400
DELETE
/funckeys/templates/{template_id}
Delete func key template
delete_func_key_template 2 params → 204400404
GET
/funckeys/templates/{template_id}/users
List users associated to template
list_func_key_template_user_associations 2 params → 200404
GET
/funckeys/templates/{template_id}/{position}
Get a func key inside template
get_func_key 3 params → 200404
PUT
/funckeys/templates/{template_id}/{position}
Add/Replace a func key in a template
update_func_key 3 params body → 204400
DELETE
/funckeys/templates/{template_id}/{position}
Remove func key from template
delete_func_key 3 params → 204400404
GET
/users/{user_id}/funckeys
List func keys for a user
list_user_func_keys 2 params → 200
PUT
/users/{user_id}/funckeys
Update func keys for a user
update_user_func_keys 2 params body → 204400
GET
/users/{user_id}/funckeys/{position}
Get a func key for a user
get_user_func_key 3 params → 200404
PUT
/users/{user_id}/funckeys/{position}
Add/Replace a func key for a user
update_user_func_key 3 params body → 204400
DELETE
/users/{user_id}/funckeys/{position}
Remove func key for user
delete_user_func_key 3 params → 204400404
GET
/users/{user_id}/funckeys/templates
List funckey templates associated to user
list_user_func_key_template_associations 2 params → 200404
PUT
/users/{user_id}/funckeys/templates/{template_id}
Associate a func key template to a user
associate_user_func_key_template 3 params → 204400404
DELETE
/users/{user_id}/funckeys/templates/{template_id}
Dissociate a func key template to a user
dissociate_user_func_key_template 3 params → 204400404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are FuncKeyTemplate (4 properties), FuncKeyDestinationParameter (3 properties), FuncKey (3 properties), UserFuncKeyTemplate (2 properties). Each schema is shown below with its type and property counts.

FuncKeyDestination
object
2 properties
FuncKeyTemplate
object
Further documentation at https://wazo-platform.org/uc-doc/administration/users/csvimport
4 properties
FuncKeyDestinationItems
array
Description of func key destinations and their parameters
FuncKey
object
Further documentation at https://wazo-platform.org/uc-doc/apisdk/restapi/confd/funckeys
3 properties
UserFuncKeyTemplate
object
Association between a User and a FuncKey Template
2 properties
FuncKeyDestinationParameter
object
3 properties
Error
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wazo-funckeys-api-openapi.yml Raw ↑

Other APIs Wazo publishes across the network.

Wazo Phone Provisioning API (wazo-provd)
Wazo Websocket Event Stream (wazo-websocketd)
Wazo Aastra API
Wazo Access Features API
Wazo Action API
Wazo Adhoc Conferences API
Wazo Admin API
Wazo Agent Statistics API
Wazo Agents API
Wazo Applications API
Wazo Asterisk API
Wazo Backends API
Where this information came from

This is an independent, third-party profile of Wazo Funckeys API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.