MOR API v2 ring groups

Ring Groups

List ring groups with member device extensions and caller IDs (MOR API v2).

Authentication

Bearer JWT — same as other MOR API v2 endpoints. Obtain a token via POST /api/v2/authentication/login.

Endpoint

GET /api/v2/ring_groups

Authorization

• Admin — allowed when PBX addon is active.
• Accountant — requires manage_ring_groups (read) and API method v2_ring_groups_index granted on the user's API permission group when API restrictions apply.
• User / Reseller — not supported.

Query parameters

Parameter	Description
search_name	Filter by ring group name (LIKE on dialplan name).
search_extension	Filter by ring group local extension (LIKE on dialplan extension).
from	1-based offset for pagination.
max_results	Page size. When omitted, all matching rows are returned.

Response (200)

{
  "ring_groups": [
    {
      "id": 1,
      "name": "RGname",
      "extension": "100",
      "comment": "",
      "timeout": 60,
      "strategy": "ringall",
      "cid_prefix": "",
      "pbx_pool_id": 1,
      "inbound_dids": ["+37060011244"],
      "members": [
        {
          "device_id": 3,
          "priority": 0,
          "device_type": "SIP",
          "device_name": "101",
          "extension": "101",
          "callerid": "+37060000101"
        }
      ]
    }
  ],
  "meta": { "from": 1, "max_results": 500, "returned": 1 }
}

Errors

• 401 — missing/invalid token, insufficient GUI rights, or API method not permitted.
• 403 — PBX addon inactive (You are not authorized to view this page).

Notes

• Use this endpoint to export ring group names and member numbers. GET /api/v2/dids only shows inbound DIDs routed to a ring group dialplan, not member devices.
• Member extension and callerid come from the device record. Additional numbers stored only as device CLIs are not included in v1.
• Clients may build a flat phone list per group from non-empty members[].extension and members[].callerid.

See also

• MOR API v2
• MOR API v2 DIDs