Extensions

An extension is the telephony identifier (a phone number, phone name, BroadWorks user ID, agent ID, and so on) that links recorded calls to a user. In a multi-tenant deployment, the pool of extensions is owned by tenants; tenant administrators assign the extensions of their tenant to users. See Extensions in the Operator Guide.

The extension endpoints manage the pool. They are guarded by the Tenants permission (view, create, edit, delete). To assign an extension to a user, set fieldset_recording.extensions of the user.

Endpoints

Request	Description
GET /api/v2/extensions.json	List and search extensions
GET /api/v2/extensions/<extension-id>.json	View one extension
POST /api/v2/extensions.json	Create extension
PUT /api/v2/extensions/<extension-id>.json	Update extension
DELETE /api/v2/extensions/<extension-id>.json	Delete extension

Extension object fields

{
    "extension": {
        "ext_id": "01c1a942-1e6a-11ef-9119-9b3d971aa321",
        "extension": "12005040976",
        "user_id": "3fce14ba-0848-440c-95a1-98d376067b77",
        "tenant_id": "209e8a10-e250-4824-8567-43f48e07a060"
    }
}

Attribute	Type	Description
ext_id	UUID	Unique ID of the extension, assigned by MiaRec when the extension is created. Read-only.
extension	string	The extension value, 1 to 256 characters. Required. Unique system-wide, or within the tenant when the tenant's extension uniqueness is set to "Within tenant only".
user_id	UUID or null	ID of the user the extension is assigned to, or null when unassigned. Read-only: assign extensions through the user.
tenant_id	UUID	ID of the tenant that owns the extension. Available only when multi-tenancy is enabled, and returned only to API users of the System tenant. When omitted on creation, the tenant of the API user is used.