Kolmisoft Wiki - Recent changes [en]

WebRTC

Admin — Fri, 29 May 2026 11:24:03 GMT

Tracing WebRTC calls

← Older revision		Revision as of 11:24, 29 May 2026
Line 58:		Line 58:

	[[File:Device_webrtc_option.png]]		[[File:Device_webrtc_option.png]]

			<br><br>
			<br><br>
			=== Media use received transport ===

			For PJSIP devices that use TLS/DTLS-SRTP but are not using the '''WebRTC''' toggle, enable '''Media use received transport''' in '''Advanced''' settings ('''Yes'''). This maps to Asterisk <code>media_use_received_transport</code> and makes Asterisk echo the media transport from the client's SDP offer in the answer. Devices created with '''TLS''' transport get this set to '''Yes''' automatically. See [[Device settings#PJSIP endpoint options (Advanced)\|Device settings — PJSIP endpoint options]] and [[MOR API device update\|device_update]] (<code>media_use_received_transport=yes\|no</code>).

	<br><br>		<br><br>
Line 110:		Line 116:

	<br><br>		<br><br>

	== Testing with WebRTC Phone ==		== Testing with WebRTC Phone ==

MOR API device update

Admin — Fri, 29 May 2026 11:23:18 GMT

← Older revision		Revision as of 11:23, 29 May 2026
Line 78:		Line 78:
	* '''qualify_timeout''' - value >= 500 in ms.		* '''qualify_timeout''' - value >= 500 in ms.
	* '''qualify_frequency''' - value >= 10 in seconds. Works only for PJSIP devices.		* '''qualify_frequency''' - value >= 10 in seconds. Works only for PJSIP devices.
			* '''media_use_received_transport''' - Optional. Allowed values: <code>yes</code>, <code>no</code>. Works only when the device uses SIP with the PJSIP driver (<code>chan_pjsip</code>). When <code>yes</code>, Asterisk sets <code>media_use_received_transport</code> on the endpoint so the media transport from the received SDP offer is echoed in the answer (useful for DTLS-SRTP / [[WebRTC\|WebRTC]] and some NAT scenarios). Invalid values are ignored; the column is unchanged. Not available on device_create — new devices inherit the Default Device template and TLS auto-default rules instead. Response field on [[MOR API device details get\|device_details_get]]: <code>pjsip_endpoint_media_use_received_transport</code>.

	<br><br>		<br><br>
	'''Additional feature'''		'''Additional feature'''
	<br><br>		<br><br>
	If API setting '''Allow Resellers to use Admin Localization Rules''' is enabled:<br>Reseller is able to set location inherited from Admin. '''new_location_id''' should be used as a parameter for location.		If the API setting '''Allow Resellers to use Admin Localization Rules''' is enabled:<br>Reseller is able to set a location inherited from Admin. '''new_location_id''' should be used as a parameter for location.
	<br><br>		<br><br>

Device settings

Admin — Fri, 29 May 2026 11:22:23 GMT

MOR API dids get

Admin — Wed, 27 May 2026 11:27:33 GMT

MOR API v2 DIDs

Admin — Wed, 27 May 2026 11:25:29 GMT

Created page with "List DIDs via MOR API v2. == Documentation == Full MOR REST API documentation is available at <code>/billing/api/v2/api-docs/</code>. == Description == The DIDs API retrieves the list of DIDs visible to the authenticated '''admin''' or '''accountant''' user. Responses are JSON. The same data scope and VoiceAI integration fields as legacy dids_get apply. Authentication follows Usage on the parent page (JW..."

New page

List DIDs via [[MOR API v2]].

 
== Documentation ==

Full MOR REST API documentation is available at <code>/billing/api/v2/api-docs/</code>.

 
== Description ==

The DIDs API retrieves the list of DIDs visible to the authenticated '''admin''' or '''accountant''' user. Responses are JSON. The same data scope and VoiceAI integration fields as legacy [[MOR API dids get|dids_get]] apply. Authentication follows [[MOR API v2#Usage|Usage]] on the parent page (JWT via Basic login).

Only '''admin''' and '''accountant''' users may call this endpoint. '''Reseller''' and '''simple user''' accounts receive HTTP 401.

 
== API ==

'''Endpoint:''' <code>GET /billing/api/v2/dids</code>

Query parameters (all optional):

* '''search_did_number''' — filter by DID number (SQL LIKE partial match)
* '''search_status''' — lifecycle filter: '''free''', '''reserved''', '''active''', '''closed''', '''terminated''' (lowercase; see '''did_status''' in the response)
* '''search_hide_terminated_dids''' — '''1''' hide terminated DIDs, '''0''' show
* '''from''' — '''1-based''' index of the first record to return (pagination; same as legacy '''dids_get''')
* '''max_results''' — page size. When omitted, the server returns all matching rows (legacy parity). Integrators with large inventories should paginate (for example '''max_results=500''').

 
=== Authentication ===

The DIDs API requires the same authentication as other [[MOR API v2]] endpoints: Basic authentication to obtain a JWT, then a Bearer token on each request. See [[MOR API v2#Usage|Usage]] on the parent page.

'''Basic authentication (login)''' 
<code>POST /billing/api/v2/authentication/login</code> with HTTP Authorization header <code>Basic base64(username:password)</code>. Use the user's '''GUI password''' (the same password as for the MOR web interface), not the global API Secret Key.

Example:

<pre>
POST http://<SERVER_IP>/billing/api/v2/authentication/login HTTP/1.1
Authorization: Basic <base64(accountant:password)>
</pre>

'''JWT authentication (list DIDs)''' 
Pass the <code>access_token</code> from login in the Authorization header. The access token is valid for 15 minutes; use <code>/billing/api/v2/authentication/refresh</code> before expiry.

Example:

<pre>
GET http://<SERVER_IP>/billing/api/v2/dids?search_status=free&from=1&max_results=500
Authorization: Bearer <access_token>
</pre>

 
=== Authorization and visibility ===

* '''Accountant''' users need '''Manage DIDs''' read permission on their accountant permission group; otherwise the API returns HTTP 401 with <code>{"errors":"Unauthorized"}</code>.
* When '''API restricted''' is enabled on the user and an API permission group is assigned, the logical method '''dids_get''' must be allowed in that group (for example the '''VoiceAI DIDs Reader''' preset); otherwise the response is HTTP 401 with <code>{"errors":"API method not permitted: dids_get"}</code>.
* '''Admin''' and '''accountant''' (with Manage DIDs) see system-wide DIDs. '''Reseller''' and '''simple user''' are not permitted on this v2 endpoint.
* Fields such as '''provider''' and '''dial_plan''' are included for admin and accountant responses only.

 
=== Integration user setup ===

Typical read-only DID inventory integration (for example, VoiceAI sync):

# SETTINGS → Setup → '''Accountant Permissions''' — grant '''Manage DIDs''' read on the integration accountant's group.
# SETTINGS → Setup → '''API Permission Groups''' — create or use a group that allows '''dids_get''' read (preset: '''VoiceAI DIDs Reader''').
# SETTINGS → Users — create or edit an '''accountant''' user; enable '''API restricted''' and assign the API permission group.
# Enable API globally (SETTINGS → Setup → Settings → '''API''' tab).
# Authenticate with that accountant's username and '''GUI password''' via <code>/billing/api/v2/authentication/login</code>; call <code>GET /billing/api/v2/dids</code> with the returned Bearer token.

 
=== Returns ===

'''Success (HTTP 200)'''

<pre>
{
"dids": [
{
"id": 6501,
"did": "37066105718",
"did_number": "37066105718",
"status": "Active",
"did_status": "active",
"ai_agent_compatible": true,
"routes_to_openai_project_id": "proj_xxx",
"updated_at": "2026-05-27T07:35:57Z",
"owner": "User Resellers",
"device": "IAX2/105",
"provider": "Test Provider",
"dial_plan": "testDialPlan (authbypin)"
}
],
"meta": {
"from": 1,
"max_results": 500,
"returned": 42
}
}
</pre>

'''DID object fields'''

* '''id''' — DID record ID in the MOR database
* '''did''' / '''did_number''' — same DID number string (both returned for compatibility)
* '''status''' — capitalized GUI label (for example '''Active''')
* '''did_status''' — lowercase lifecycle value from the database (for example '''free''', '''active''', '''reserved''') — use for machine parsing
* '''ai_agent_compatible''' — '''true''' or '''false''' when the VoiceAI column exists on the server; omitted when the column is absent
* '''routes_to_openai_project_id''' — VoiceAI routing target (may be empty)
* '''updated_at''' — last change in RFC3339 UTC with '''Z''' suffix (for example '''2026-05-27T07:35:57Z'''); omitted when not set. See [[MOR API#Useful to know|Useful to know]] (API values are not reformatted by GUI date settings).
* '''owner''' — user display name
* '''device''' — assigned device label
* '''provider''' — provider name (admin/accountant only)
* '''dial_plan''' — dial plan name and type (admin/accountant only)

'''meta object'''

* '''from''' — 1-based offset used for this page
* '''max_results''' — page size requested (<code>null</code> when omitted in the request)
* '''returned''' — number of DID objects in this response

'''Empty result (HTTP 200)'''

<pre>
{
"dids": [],
"meta": {
"from": 1,
"max_results": null,
"returned": 0
}
}
</pre>

 
=== Errors ===

Errors are JSON and HTTP 401 unless noted. The DIDs endpoint uses an '''errors''' string; the login endpoint uses '''error'''.

{| class="wikitable"
|-
! Condition !! HTTP !! Example body
|-
| Invalid or missing JWT || 401 || <code>{"errors":"Invalid token value"}</code>
|-
| API disabled globally || 401 || <code>{"errors":"API Requests are disabled"}</code>
|-
| Wrong login password || 401 || <code>{"error":"unauthorized"}</code> (login endpoint)
|-
| User type not allowed (reseller, simple user) || 401 || <code>{"errors":"Unauthorized"}</code>
|-
| Accountant without Manage DIDs read || 401 || <code>{"errors":"Unauthorized"}</code>
|-
| API restricted — '''dids_get''' not permitted || 401 || <code>{"errors":"API method not permitted: dids_get"}</code>
|}

 
== Additional notes ==

* Legacy XML listing remains available via [[MOR API dids get|dids_get]] (API Secret Key + hash). Prefer this v2 endpoint for new integrations.
* More request/response examples are in <code>/billing/api/v2/api-docs/</code> under the '''DIDs''' tag.

 
== See also ==

* [[MOR API v2]]
* [[MOR API dids get]] — legacy XML DID listing

MOR API v2

Admin — Wed, 27 May 2026 11:24:43 GMT

DIDs

← Older revision		Revision as of 11:24, 27 May 2026
(2 intermediate revisions by the same user not shown)
Line 32:		Line 32:
	[[File:MOR_api_v2_bearerAuthorization.png]]		[[File:MOR_api_v2_bearerAuthorization.png]]

	~~Now you~~ can use the available APIs. Expand them to see the documentation.		You can now use the available APIs. Expand them to see the documentation.
	<br><br>		<br><br>

Line 43:		Line 43:
	==Calls==		==Calls==
	* [[MOR_API_v2_Calls\|retrieve_calls]] - retrieves the list of calls in the selected time period for the specified User/Device.		* [[MOR_API_v2_Calls\|retrieve_calls]] - retrieves the list of calls in the selected time period for the specified User/Device.
			<br>

			== DIDs ==
			* [[MOR API v2 DIDs\|dids]] — list DIDs visible to the authenticated admin or accountant (JSON).
	<br>		<br>

MOR Manual

Admin — Wed, 27 May 2026 11:20:40 GMT

Other functionality

← Older revision		Revision as of 11:20, 27 May 2026
Line 353:		Line 353:
	** [[MOR and Trixbox]]		** [[MOR and Trixbox]]
	* [[MOR API]]		* [[MOR API]]
			** [[MOR API Permission Groups]]
	** [[API Configuration]]		** [[API Configuration]]
	* [[Cron actions]]		* [[Cron actions]]

MOR API Permission Groups

Admin — Wed, 27 May 2026 11:20:12 GMT

Created page with "''Fine-grained allow lists for hash-protected MOR API methods. Assign a group to integration users so they can call only the API actions you permit.'' == Overview == '''What are API permission groups?''' An API permission group is a named template of per-method API rights. Each hash-protected API method (for example <code>dids_get</code>, <code>users_get</code>, <code>did_create</code>) can be set to '''Disabled''', '''Read''', or '''Write''' inside th..."

New page

''Fine-grained allow lists for hash-protected [[MOR API]] methods. Assign a group to integration users so they can call only the API actions you permit.''

 
== Overview ==

'''What are API permission groups?''' 
An API permission group is a named template of per-method API rights. Each hash-protected API method (for example <code>dids_get</code>, <code>users_get</code>, <code>did_create</code>) can be set to '''Disabled''', '''Read''', or '''Write''' inside the group. You assign one group to a user when '''API restricted''' is enabled on that account.

'''When does the group matter?''' 
Permissions are enforced only for users with '''API restricted''' turned on. If '''API restricted''' is off, the account keeps full access to hash-protected API methods (still subject to normal API settings such as [[API Configuration]], hash authentication, and role-specific rules such as accountant '''Manage DIDs''' on [[Accountant permissions]]).

Only '''user''' and '''accountant''' accounts can use '''API restricted'''. The checkbox is not shown for resellers, admins, or other user types.

 
== Permission levels ==

On the group edit screen, each API method has three radio options:

{| class="wikitable"
|-
! Column in GUI !! Value !! Effect
|-
| '''Disabled''' || 0 || The method is denied for restricted users in this group.
|-
| '''Read''' || 1 || Allows methods classified as read-only (for example <code>dids_get</code>, <code>users_get</code>).
|-
| '''Write''' || 2 || Required for methods that create, update, or delete data (for example <code>did_create</code>, <code>user_details_update</code>). Also satisfies read-only methods.
|}

'''Read-only methods in the GUI''' 
For methods that only read data, the '''Write''' column is disabled — you can set '''Disabled''' or '''Read''' only. This matches how the system classifies each action internally.

'''Methods not listed in the ACL table''' 
Hash-protected methods are included in the group editor. <code>callback_init</code> is shown for compatibility but is marked '''hash-only''' — ACL is not enforced for that action (legacy uniquehash behaviour). All other hash-protected actions in the registry are gated when '''API restricted''' is on.

 
== Manage API permission groups ==

'''Where to open the list''' 
Go to '''SETTINGS → Setup → API Permission Groups'''.

You can also open the same list from '''SETTINGS → Setup → Settings''' ([[API Configuration|API tab]]) via the '''API Permission Groups''' link.

'''Admin only''' 
Only an administrator can create, edit, or delete groups.

 
=== Create a group ===

# Open '''API Permission Groups'''.
# Enter '''Name''' and '''Description''' in the bottom row of the table.
# Click the add icon to create the group.

A new group starts with every method set to '''Disabled'''. Open the edit (pencil) icon to configure permissions.

 
=== Edit permissions ===

# On the list page, click edit for the group.
# Set '''Disabled''', '''Read''', or '''Write''' for each API method (grouped by category in the table).
# Click '''Update''' to save.

'''VoiceAI DIDs Reader preset''' 
On the edit page, '''Apply VoiceAI DIDs Reader preset''' sets all methods to '''Disabled''' except:

* [[MOR API dids get|dids_get]] — '''Read'''
* <code>system_version_get</code> — '''Read'''

Use this preset for integration accountants that should sync DID inventory (for example VoiceAI) without broader API write access. You can adjust individual methods after applying the preset.

 
=== Delete a group ===

# On the list page, click delete for the group.

A group cannot be deleted while any user still has it assigned. Reassign or clear '''API restricted''' on those users first.

 
== Assign a group to a user ==

# Go to '''SETTINGS → Users''' (or edit an existing user).
# Create or edit a '''user''' or '''accountant''' account.
# Enable '''API restricted'''.
# Choose the group from the dropdown (shown when '''API restricted''' is checked).
# Save the user.

If no groups exist yet, the form shows a link to create one first.

Saving requires a group when '''API restricted''' is enabled; otherwise validation fails with '''API permission group is required when API restricted is enabled'''.

 
== How enforcement works ==

When a restricted user calls a hash-protected API action (XML <code>/billing/api/</code> or [[MOR API v2]] where applicable):

# MOR authenticates the user (<code>u</code> / hash or v2 login).
# If '''API restricted''' is off for that user, the ACL check passes.
# If '''API restricted''' is on, MOR loads the user's assigned group and compares the method's required level with the permission stored for that method.
# If the permission is too low or missing, the call is rejected.

'''Typical denial responses'''

* XML API: <code>API method not permitted: users_get</code> (action name varies per call).
* MOR API v2 (JSON): same message with HTTP 401.

'''ACL is not the only gate''' 
Passing the permission group does not bypass other rules. For example, an accountant still needs '''Manage DIDs''' (read) on their [[Accountant permissions|accountant permission group]] to use [[MOR API dids get|dids_get]]; otherwise the API returns '''You are not authorized to manage DIDs''' even when <code>dids_get</code> is allowed in the API permission group.

Similarly, global settings ([[API Configuration|Allow API]], hash requirements) and data scope (admin vs reseller vs user) still apply.

 
== Example: read-only DID sync user ==

Typical setup for an external system that only lists DIDs:

# Create or edit an API permission group; apply '''VoiceAI DIDs Reader preset''' (or manually allow '''Read''' on [[MOR API dids get|dids_get]] and <code>system_version_get</code> only).
# Create an '''accountant''' user with rights needed for your integration (for DID listing, '''Manage DIDs''' read on an [[Accountant permissions|accountant permission group]]).
# Enable '''API restricted''' and select the API permission group.
# Use that user's credentials for API calls (<code>u</code> + hash, or MOR API v2 login).

The user can call allowed read methods but receives '''API method not permitted''' for disallowed actions such as <code>did_details_update</code> or <code>users_get</code>.

 
== Related topics ==

* [[MOR API]] — authentication, [[MOR API hash construction|hash construction]], and method list
* [[MOR API v2]] — JSON API (same ACL rules for restricted users on gated endpoints)
* [[Accountant permissions]] — GUI and API rights (for example '''Manage DIDs''') separate from API permission groups
* [[API Configuration]] — global '''Allow API''', secret key, and hash settings
* [[MOR API dids get]] — DID listing API often used with '''VoiceAI DIDs Reader preset'''

MOR API

Admin — Wed, 27 May 2026 11:16:50 GMT

← Older revision		Revision as of 11:16, 27 May 2026
Line 15:		Line 15:
	* Accountant - only by using Admin Hash and Secret key		* Accountant - only by using Admin Hash and Secret key
	* Simple User		* Simple User


			<br><br>
			=[[MOR API Permission Groups]]=
			Fine-grained allow lists for hash-protected [[MOR API]] methods. Assign a group to integration users so they can call only the API actions you permit.

	<br><br>		<br><br>

MOR API dids get

Admin — Wed, 27 May 2026 10:35:14 GMT

Show changes

Warning balance

Edvardas — Tue, 26 May 2026 12:20:00 GMT

From Admin Account

← Older revision		Revision as of 12:20, 26 May 2026
Line 30:		Line 30:
	* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.		* '''Warning Balance Email''' – This Email is used as a primary email to send the Warning Balance email. If this email is empty '''Email''' in the Registration Address section is used.

	* '''Admin Webhook''' – together with the Warning Balance email, a request is sent to the specified URL with data according to the URL config. Webhook URL: '''http://''' or '''https://''' required.		* '''Admin Webhook''' – together with the Warning Balance email, a request is sent to the specified URL with data according to the URL config. Webhook URL: '''http://''' or '''https://''' required. Webhook is not tied to email. It can work without email. Just enable "Active", specify values and Webhook URL.
	<br><br>		<br><br>

Configuration from GUI

Edvardas — Mon, 25 May 2026 15:27:58 GMT

Security

← Older revision		Revision as of 15:27, 25 May 2026
Line 391:		Line 391:

	== Security ==		== Security ==
	* '''Allow short passwords in devices'''		* '''Allow short passwords in devices''' - by default, device passwords are expected to be longer than 7 characters. If enabled, MOR will permit shorter device passwords.
	* '''Use strong passwords for users'''		* '''Use strong passwords for users'''
	* '''Admin login with approved IP only''' - security measure which allows to approve IP's that try to [[MOR_Login_with_approved_IP%27s\|login with Admin Account]].		* '''Admin login with approved IP only''' - security measure which allows to approve IP's that try to [[MOR_Login_with_approved_IP%27s\|login with Admin Account]].

Support

Viliuss — Mon, 25 May 2026 06:44:16 GMT

@@ Line 158: / Line 158: @@
 *'''Hangup Call if PDD is more than'''- set maximum PDD time (in seconds) before call hangup. Note that failover providers will not be used in this case. The call will be hung up completely and will not be passed to other providers in LCR.
 =Advanced=
@@ Line 222: / Line 223: @@
 * '''STIR/SHAKEN Attestation''' - only in PJSIP Devices. [https://wiki.kolmisoft.com/index.php/MOR_STIR/SHAKEN#Device/Provider_configuration STIR/SHAKEN] attestation level when calling to this Device.
 * '''WebRTC''' - only in PJSIP Devices. Enable WebRTC support for this Device. WebRTC must be configured in Asterisk - [https://wiki.kolmisoft.com/index.php/WebRTC#WebRTC%2FWebSockets%2FWSS Enabling WebRTC].
 <br><br>
@@ Line 233: / Line 258: @@
 * '''Repeat remaining time when left''' – repeats the remaining time when some time is left (in seconds).
 <br><br>
 =Debug=
@@ Line 255: / Line 281: @@
 * [[Hide Device username for Users]]
 * [[What is PIN]]

← Older revision		Revision as of 11:27, 27 May 2026
(2 intermediate revisions by the same user not shown)
Line 143:		Line 143:

	* [[MOR API]]		* [[MOR API]]
	* [[MOR API v2]] — JSON DID listing ~~(when available on your MOR version)~~: '''GET /billing/api/v2/dids'''		* [[MOR API v2 DIDs]] — JSON DID listing: '''GET /billing/api/v2/dids'''

← Older revision		Revision as of 06:44, 25 May 2026
Line 115:		Line 115:
	= See also =		= See also =
	* [[Support System explanation]]		* [[Support System explanation]]
	* [[Create new Ticket in Ticket System]]
	* [[Write comment to the Ticket]]