OpenAPI - Revision history

Admin at 12:05, 31 May 2026

2026-05-31T12:05:00Z

@@ Line 523: / Line 523: @@
+}
 </pre>
 == Additional Configuration Objects ==

2026-05-25T14:42:53Z

← Older revision		Revision as of 14:42, 25 May 2026
Line 1:		Line 1:
			== Overview ==

	== Overview ==		== Overview ==

Line 71:		Line 73:
	Some objects can be edited at global level by adding <code>global=yes</code>. This is supported for global settings, global custom destinations, global media files, global music on hold, global caller ID blacklist entries, global cron jobs, global feature codes, and global short numbers.		Some objects can be edited at global level by adding <code>global=yes</code>. This is supported for global settings, global custom destinations, global media files, global music on hold, global caller ID blacklist entries, global cron jobs, global feature codes, and global short numbers.

	~~Objects without a~~ tenant ~~column, such as users~~, user ~~profiles~~, ~~routing profiles~~, and ~~tenants,~~ require ~~a global~~ API key. For users, adding <code>tenant=TENANTCODE</code> filters list and get requests to users assigned to that tenant.		The <code>tenant</code>, <code>user</code>, <code>userprofile</code>, and <code>routingprofile</code> objects require an Admin API key. Tenant API keys are rejected for these objects. For users, adding <code>tenant=TENANTCODE</code> with an Admin API key filters list and get requests to users assigned to that tenant.

	<pre>		<pre>

2026-05-25T14:39:18Z

2026-05-25T13:15:07Z

2026-05-25T10:17:37Z

2026-05-25T08:44:53Z

2026-05-25T08:06:26Z

@@ Line 259: / Line 259: @@
 === Example Response ===
-The response includes the normalized fields <code>id</code>, <code>number</code>, <code>name</code>, and <code>tech</code>, the extension table fields, the current state when available, the technology username, and technology-specific details.
+The response includes all fields from the extension table, the normalized fields <code>id</code>, <code>number</code>, <code>name</code>, and <code>tech</code>, the current state when available, the technology username, technology-specific details, and related records.
 <pre>
@@ Line 292: / Line 296: @@
        "username": "100"
+     }
+   }
+}

2026-05-25T07:58:19Z

2026-05-25T07:50:06Z

2026-05-25T07:45:21Z

← Older revision		Revision as of 07:45, 25 May 2026
Line 104:		Line 104:
	curl "https://pbx.example.com/openapi.php/extensions?tenant=TENANTCODE&key=APIKEY"		curl "https://pbx.example.com/openapi.php/extensions?tenant=TENANTCODE&key=APIKEY"
	</pre>		</pre>

			Using header authentication:

			<pre>
			curl \
			-H "X-API-Key: APIKEY" \
			"https://pbx.example.com/openapi.php/extensions?tenant=TENANTCODE"
			</pre>

			=== Example Response ===

			<syntaxhighlight lang="json">
			[
			{
			"id": 101,
			"number": "100",
			"name": "Reception",
			"tech": "PJSIP"
			},
			{
			"id": 102,
			"number": "101",
			"name": "Office",
			"tech": "SIP"
			}
			]
			</syntaxhighlight>

			== Response Fields ==

			{\| class="wikitable"
			! Field
			! Type
			! Description
			\|-
			\| <code>id</code>
			\| integer
			\| Extension internal ID
			\|-
			\| <code>number</code>
			\| string
			\| Extension number
			\|-
			\| <code>name</code>
			\| string
			\| Extension display name
			\|-
			\| <code>tech</code>
			\| string
			\| Extension technology, for example <code>SIP</code>, <code>PJSIP</code>, <code>VIRTUAL</code>, or <code>CUSTOM</code>
			\|}

			== Error Responses ==

			Errors are returned as JSON.

			=== Missing API Key ===

			<syntaxhighlight lang="json">
			{
			"error": {
			"code": "missing_api_key",
			"message": "Missing API key."
			}
			}
			</syntaxhighlight>

			=== Invalid API Key ===

			<syntaxhighlight lang="json">
			{
			"error": {
			"code": "invalid_api_key",
			"message": "Invalid API key."
			}
			}
			</syntaxhighlight>

			=== Tenant Not Found ===