NGUC API Documentation

Quick start

Three steps to your first request

Most integrations exchange credentials for an access token, then call REST endpoints with a bearer header.

1

Authenticate

POST username and password to /oauth2/user-credentials to receive an access_token.
2

Call an endpoint

Send Authorization: Bearer <token> with each request.
3

Refresh as needed

Tokens last 24h. Use the refresh token to get a new pair without re-prompting credentials.

Authentication

OAuth 2.0 password grant

All NGUC API access is authenticated. Exchange your registered user account for a bearer token via the password grant flow. The credential information can be sent as either a JSON document or as URL-encoded form data.

Required parameters

grant_type: Must be password.
client_id: Format external.<COMPANY>.
username: Your account username.
password: Your account password.
tfa: 2FA code if enabled, otherwise empty string.

Status code semantics

401 for bad password — 402 for missing or expired 2FA code.

# POST /oauth2/user-credentials
curl --data-raw '{
  "grant_type": "password",
  "client_id":  "external.COMPANY",
  "username":   "USER",
  "password":   "SECRET",
  "tfa":        ""
}' \
  -H 'Content-Type: application/json' \
  -X POST https://api-nguc.weblink.se/oauth2/user-credentials

curl -d 'grant_type=password' \
  -d 'username=USER' \
  -d 'password=SECRET' \
  -d 'tfa=' \
  -d 'client_id=external.COMPANY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -X POST https://api-nguc.weblink.se/oauth2/user-credentials

{
  "access_token":  "NEW_ACCESS_TOKEN",
  "expires_in":    86400,
  "token_type":    "Bearer",
  "scope":         null,
  "refresh_token": "NEW_REFRESH_TOKEN"
}

POST /oauth2/user-credentials

Refresh access token

Access tokens are short-lived. Use the refresh_token from the original response to obtain a new pair without re-prompting credentials. Each refresh issues a new 24-hour access token; the same refresh token is reused and its validity is extended (up to ~6 weeks) on every refresh.

Authenticated requests

Once you have a token, every API call must carry an Authorization header.

POST /oauth2/refresh-token

curl --data-raw '{
  "grant_type":    "refresh_token",
  "refresh_token": "CURRENT_REFRESH_TOKEN",
  "client_id":     "external.COMPANY"
}' \
  -H 'Content-Type: application/json' \
  -X POST https://api-nguc.weblink.se/oauth2/refresh-token

GET /country Authenticated request example

curl -H 'Authorization: Bearer CURRENT_ACCESS_TOKEN' \
  -X GET https://api-nguc.weblink.se/country

Simple API

The Simple API is different from the rest of the API: it authenticates with a token and is not tied to a user. To gain access, contact us. Send the token as a bearer header on the /simple/* endpoints:

Authenticated Simple API request

curl -H 'Authorization: Bearer SIMPLE_API_TOKEN' \
  'https://api-nguc.weblink.se/simple/company/extensions'

Rate limits

100 requests per 60 seconds

Limits are scoped per access token, not per IP. Once you cross the threshold the API returns 429 Too Many Requests with a Retry-After header indicating how many seconds to wait.

Window

60s

Sliding window per access token

Throttled response

HTTP/1.1 429 Too Many Requests
Retry-After: 42

Errors

Status codes

Code	Meaning	When you'll see it
200	OK	Request handled successfully.
401	Unauthorized	Bad password or expired token.
402	Payment Required	Missing, incorrect or expired 2FA code.
429	Too Many Requests	Rate limit exceeded — see `Retry-After`.

Guides

Queue statistics

Aggregate metrics, per-agent performance, and individual call records for any PBX queue. All endpoints require the read queue statistics permission.

get /company/queuestat

Get aggregated queue statistics Gets statistics for specified queues

get /company/queuestat/calls

List queue call statistics with filtering and pagination Get statistics for any calls originating from specified queues

get /company/queuestat/calls/{qsCallUniqueId}

Get detailed statistics for a specific queue call Get statistics for a specific call specified by it's unique call id

get /company/queuestat/calls/download

Export queue call statistics as a downloadable document Download available call statistics in specified document format

get /company/queuestat/calls/{qsCallUniqueId}/download

Export detailed call statistics as a downloadable document Download detailed call statistics in specified document format

Endpoint details

get /company/queuestat Get aggregated queue statistics Gets statistics for specified queues

Returns an object keyed by queue extension number. Each entry contains the queue name, aggregate counters (answered, abandoned, etc.), member performance data, and any currently waiting callers.

Query parameters

Name	Type	Required	Description
from	string	no	datetime in format: 'yyyy-MM-dd HH:mm:ss' (2024-12-27 08:00:00)
to	string	no	datetime in format: 'yyyy-MM-dd HH:mm:ss' (2024-12-27 16:59:00)
from_time	string	no	time in format: 'HH:mm:ss' (08:00:00)
to_time	string	no	time in format : 'HH:mm:ss' (16:59:00)
users	integer[]	no	an array of userid's to get data for.
queues	integer[]	no	an array of queueid's to get data for.
weekdays	integer[]	no	an array of weekday indexes starting with monday as zero.
includeNone	boolean	no
includeExternal	boolean	no	true indicates that we should include calls that was handled by external phone numbers.

Required permissions

read queue statistics

Request example

curl -G -H 'Authorization: Bearer <>' \
-d 'from=2024-01-01%2008%3A00%3A00' \
-d 'to=2024-06-30%2016%3A59%3A00' \
-d 'weekdays[]=0' \
-d 'weekdays[]=1' \
-d 'weekdays[]=2' \
-d 'weekdays[]=3' \
-d 'weekdays[]=4' \
-d 'queues[]=26355' \
https://api-nguc.weblink.se/company/queuestat

Response example

{
    "1338": {
        "name": "Support queue",
        "stats": {
            "answered": 145,
            "abandoned": 23,
            "unanswered": 5,
            "average_wait_time": 18,
            "average_talk_time": 245
        },
        "member": [
            {
                "agent_id": "1234",
                "name": "John Doe",
                "answered": 42,
                "talk_time": 10290
            }
        ],
        "entry": []
    }
}

get /company/queuestat/calls List queue call statistics with filtering and pagination Get statistics for any calls originating from specified queues

Returns a paginated list of individual queue calls. Use from/to or reldays to specify the time range. When users[], includeNone, or includeExternal is set, calls are filtered by handler. The event field indicates the call outcome: ABANDON, COMPLETEAGENT, COMPLETECALLER, EXITEMPTY, EXITWITHKEY, or EXITWITHTIMEOUT.

Query parameters

Name	Type	Required	Description
reldays	integer	no	Relative positive number of days before `to` query param that will be used to compute the `from` parameter.
from	string	no	Datetime from which calls will be included in the result, see the description for formats.
to	string	no	Datetime to which calls will be included in the result, see the description for formats. `NOW` will use the date and time of the API call. `Default: NOW`
from_time	string	no	Time of day in format: `HH:mm:ss` (08:00:00). For each day calls after this time will be included. `Default: 00:00:00`
to_time	string	no	Time of day in format: `HH:mm:ss` (16:59:00). For each day calls before this time will be included. `Default: 23:59:59`
weekdays	integer[]	no	Zero based weekday index starting with monday to include calls for. `Default: 0,1,2,3,4,5,6`
users	integer[]	no	An array of user id's to get calls for.
queues	integer[]	no	an array of queue id's to get calls for.
includeNone	boolean	no	True indicates that we should limit calls that was not handled by any agent. `Default: false`
includeExternal	boolean	no	True indicates that we should limit calls that was handled by external phone numbers. `Default: false`
limit	integer	no	Limit the number of records returned (used for paginating result). The limit will be applied after sorting. `Default: 20`
limit_from	integer	no	Record offset to return data from (used for paginating result).
order_by	string -enum	no	The data type to sort by. `Allowed: [datetime, id]` `Default: datetime`
order_dir	string -enum	no	The order in which to sort the data. `Allowed: [ASC, DESC]` `Default: ASC`

Required permissions

read queue statistics

Request example

curl -G -H 'Authorization: Bearer <>' \
-d 'from=2024-01-01%2008%3A00%3A00' \
-d 'to=2024-06-13%2016%3A59%3A00' \
-d 'from_time=08%3A00' \
-d 'to_time=16%3A59' \
-d 'weekdays[]=0' \
-d 'weekdays[]=1' \
-d 'weekdays[]=2' \
-d 'weekdays[]=3' \
-d 'weekdays[]=4' \
-d 'weekdays[]=5' \
-d 'weekdays[]=6' \
-d 'graphDataTypes[]=answered' \
-d 'graphDataTypes[]=abandoned' \
-d 'graphDataTypes[]=unanswered' \
-d 'graphDataTypes[]=average_wait_time' \
-d 'graphDataTypes[]=average_talk_time' \
-d 'queues[]=26355' \
https://api-nguc.weblink.se/company/4/queuestat/calls"

Response example

{
    "count": "3",
    "limit": 20,
    "limit_from": 0,
    "calls": [
        {
            "id": "343601609",
            "datetime": "2024-04-09 16:32:03",
            "datetimeconnect": "2024-04-09 16:32:03",
            "datetimeend": "2024-04-09 16:32:15",
            "event": "ABANDON",
            "agent": "NONE",
            "clid": "9863",
            "pbx_name": "Molle test",
            "uniqueid": "s1-1712673123.342",
            "wait_time": "12",
            "talk_time": "0",
            "ast_queue_id": "27028",
            "queue_extension": "1338",
            "call_guid": null,
            "callerid": null,
            "did": null
        },
        {
            "id": "359787086",
            "datetime": "2024-05-28 09:22:34",
            "datetimeconnect": "2024-05-28 09:22:34",
            "datetimeend": "2024-05-28 09:22:37",
            "event": "ABANDON",
            "agent": "NONE",
            "clid": "9861",
            "pbx_name": "Molle test",
            "uniqueid": "s1-1716880954.44",
            "wait_time": "3",
            "talk_time": "0",
            "ast_queue_id": "27028",
            "queue_extension": "1338",
            "call_guid": null,
            "callerid": null,
            "did": null
        },
        {
            "id": "359787050",
            "datetime": "2024-05-28 09:22:35",
            "datetimeconnect": "2024-05-28 09:22:35",
            "datetimeend": "2024-05-28 09:22:38",
            "event": "ABANDON",
            "agent": "NONE",
            "clid": "9861",
            "pbx_name": "Molle test",
            "uniqueid": "s1-1716880955.53",
            "wait_time": "3",
            "talk_time": "0",
            "ast_queue_id": "27028",
            "queue_extension": "1338",
            "call_guid": null,
            "callerid": null,
            "did": null
        }
    ],
}

get /company/queuestat/calls/{qsCallUniqueId} Get detailed statistics for a specific queue call Get statistics for a specific call specified by it's unique call id

Returns detailed event records for a specific call, showing each step the call took through the queue system.

Path parameters

Name	Type	Required	Description
qsCallUniqueId	string	yes	unique call id

Required permissions

read queue statistics

Request example

curl -H 'Authorization: Bearer <>' \
https://api-nguc.weblink.se/company/queuestat/calls/s1-1712673123.342

Response example

[
    {
        "datetime": "2024-04-09 16:31:51",
        "queue": "Support queue",
        "agent": "",
        "event": "ENTERQUEUE",
        "info1": "",
        "info2": "9863",
        "info3": "1",
        "info4": "",
        "info5": ""
    },
    {
        "datetime": "2024-04-09 16:32:03",
        "queue": "Support queue",
        "agent": "NONE",
        "event": "ABANDON",
        "info1": "1",
        "info2": "1",
        "info3": "12",
        "info4": "",
        "info5": ""
    }
]

get /company/queuestat/calls/download Export queue call statistics as a downloadable document Download available call statistics in specified document format

Downloads matching calls as a file. Requires the downloadType parameter (csv, html, pdf, xlsx, xls, excel). Uses the same filters as the browse endpoint. The export includes columns for date, queue, agent, caller/called numbers, call type, wait/talk times, service levels, and internal routing info.

Query parameters

Name	Type	Required	Description
downloadtype	string -enum	no	fileformat used to generate report in. `Allowed: [html, csv, excel, xlsx, xls, pdf]`
from	string	no	datetime in format: 'YYYY-mm-dd HH:mm:ss' (2024-12-01 08:00:00)
to	string	no	datetime in format: 'YYYY-mm-dd HH:mm:ss' (2024-12-24 16:59:00)
weekdays	integer[]	no	an array of weekday index's starting with monday as zero.
users	integer[]	no	an array of userid's to get calls for. Specify -1 to include calls that was answered by external phone numbers. Specify 0 to include calls that was abandoned hungup without being assigned to any agent.
queues	integer[]	no	an array of queueid's to get calls for.
includeNone	boolean	no
includeExternal	boolean	no	true indicates that we should include calls that was handled by external phone numbers.
limit	integer	no	limit the number of records returned, used for pagination. `Default: 20`
limit_from	integer	no	used for pagination.
order_by	string -enum	no	the sort order in which to return the results. `Allowed: [datetime, id]`
order_dir	string -enum	no	`Allowed: [ASC, DESC]`

Required permissions

read queue statistics

Request example

curl -G -H 'Authorization: Bearer <>' \
-d 'downloadType=csv' \
-d 'from=2024-01-01%2008%3A00%3A00' \
-d 'to=2024-06-30%2016%3A59%3A00' \
-d 'queues[]=26355' \
https://api-nguc.weblink.se/company/queuestat/calls/download \
-o queue_calls.csv

get /company/queuestat/calls/{qsCallUniqueId}/download Export detailed call statistics as a downloadable document Download detailed call statistics in specified document format

Downloads detailed event records for a single call as a file. Requires the downloadtype parameter. The export includes columns for date, queue, agent, event, and five info fields.

Path parameters

Name	Type	Required	Description
qsCallUniqueId	string	yes	unique call id

Query parameters

Name	Type	Required	Description
downloadtype	string -enum	no	fileformat used to generate report in. `Allowed: [html, csv, excel, xlsx, xls, pdf]`

Required permissions

read queue statistics

Request example

curl -H 'Authorization: Bearer <>' \
"https://api-nguc.weblink.se/company/queuestat/calls/s1-1712673123.342/download?downloadtype=xlsx" \
-o call_detail.xlsx

Recordings

Browse, stream and download call recordings. The endpoints under /recording support pagination and filtering by user, queue and date range.

get /company/recordings

List recordings with search and pagination List all available recordings

get /recording/stored/{recordingId}/{audioType}

Download a stored recording file Download company recording

Endpoint details

get /company/recordings List recordings with search and pagination List all available recordings

Query parameters

Name	Type	Required	Description
src	string	no	source phone number
dst	string	no	destination phone number
duration	integer	no	duration in seconds
date_from	string	no	datetime in format: 'yyyy-MM-dd HH:mm:ss' (2024-12-27 08:00:00)
date_to	string	no	datetime in format: 'yyyy-MM-dd HH:mm:ss' (2024-12-27 16:59:00)
order_dir	string -enum	no	Sort direction `Allowed: [ASC, DESC]` `Default: DESC`
order_by	string -enum	no	Field to order results by `Allowed: [added, calldate, dst, src, duration]` `Default: added`
limit	integer	no	limit the number of records returned (used for paginating result) `Default: 2`
limit_from	integer	no	record offset to return data from (used for paginating result)

Required permissions

read company recording

Request example

    curl -G -H 'Authorization: Bearer <>' \
    -d 'date_from=2024-01-01%2008%3A00%3A00' \
    -d 'date_to=2024-06-13%2016%3A59%3A00' \
    -d 'src=' \
    -d 'dst=' \
    "https://api-nguc.weblink.se/company/recordings"

Response example

    {
        "count": "157",
        "limit": 2,
        "limit_from": 0,
        "recordings": [
            {
                "id": "",
                "added": "2024-06-10 12:06:43",
                "downloaded": "0",
                "channel_id": "",
                "pbx_user_id": "",
                "call_guid": "",
                "duration": "0",
                "uploaded": null,
                "pbx_cdr_id": "",
                "direction": null,
                "src_callerid": "",
                "src_name": "",
                "dst_callerid": "",
                "dst_name": ""
            },
            {
                "id": "",
                "added": "2024-05-30 16:22:12",
                "downloaded": "0",
                "channel_id": "",
                "pbx_user_id": "",
                "call_guid": "",
                "duration": "25",
                "uploaded": null,
                "pbx_cdr_id": "",
                "direction": null,
                "src_callerid": "",
                "src_name": "Missing",
                "dst_callerid": "",
                "dst_name": ""
            }
        ]
    }

get /recording/stored/{recordingId}/{audioType} Download a stored recording file Download company recording

Path parameters

Name	Type	Required	Description
recordingId	integer	yes	unique recording id
audioType	string -enum	no	fileformat of the requested recording. `Allowed: [mp3, wav]` `Default: mp3`

Required permissions

read company recording

Request example

    curl -H 'Authorization: Bearer <>' \
        "https://api-nguc.weblink.se/recording/stored/{RECORDING_ID}/mp3" \
        -o 'recording.mp3' \

Reports

Schedule and generate reports across queues, users and date ranges.

post /company/report/{id}/argument

Create a new argument for a report

post /company/report

Create a new report with arguments

Endpoint details

post /company/report/{id}/argument Create a new argument for a report

Path parameters

Name	Type	Required	Description
id	integer	yes	The id

Required permissions

create company report

post /company/report Create a new report with arguments

Required permissions

create company report

AI transcripts

Retrieve AI transcripts and summaries of recorded calls in two steps. First list calls with GET /queue/cdr, GET /user/call/history or GET /user/call/{number}: each call carries transcript_id and transcript_status. Get queue IDs from GET /company/queues. When the status is done, fetch GET /transcript/{transcriptId}, with summary_only=1 if you only need the summaries. The transcript fields are filled in only when you hold a transcript read permission; queue-monitor access alone is not enough. Date filters are given in Swedish local time, while timestamps in responses are UTC.

get /company/queues

List queues accessible to the current user

get /queue/cdr

Search queue call history Search call history for queues

get /user/call/history

Get user call history Get user call history

get /user/call/{number}

Get call interactions for a given phone number Get interactions for a given number

get /transcript/{transcriptId}

Get a transcript by ID Get transcript by id Returns the transcript with its AI summaries and, when the caller holds the full-text grant, the verbatim text If you are connected with websocket you get an event when the respective summary is ready, usually within 2-5 seconds The company-level transcript read permission gives summaries and text for all company transcripts The user-level transcript read permission gives summaries and text for your own calls, and the summaries alone for queues you monitor Queue-monitor access without a transcript read permission is denied (403) Pass summary_only to skip the text and get the summaries alone The text list is then empty, exactly as it is for a caller without the full-text grant, so it does not tell you whether a text exists

Endpoint details

get /company/queues List queues accessible to the current user

Returns the queues you can monitor. Use the id of each queue in queues[] when you search queue call history with GET /queue/cdr.

Required permissions

read monitor queue read company queues

Request example

    curl -G -H 'Authorization: Bearer <>' \
    "https://api-nguc.weblink.se/company/queues"

get /queue/cdr Search queue call history Search call history for queues

If a queue conversation has been transcribed, you will receive: "transcript_id": "xxxxx", "transcript_status": "done"
Page with limit_from: add limit to it for each request until you have fetched count calls.

Query parameters

Name	Type	Required	Description
limit	integer	no	number of rows to return, with no upper limit; 0 or empty means 20 `Default: 20`
limit_from	integer	no	zero-based offset of the first row to return
datetime_from	string	no	oldest call to return, in Swedish local time (Europe/Stockholm), format 'yyyy-MM-dd HH:mm:ss' (2024-12-27 08:00:00) or 'yyyy-MM-dd' for midnight. Only calls after this time are returned. Timestamps in the response are UTC. A value in any other format is ignored
datetime_to	string	no	newest call to return, in Swedish local time (Europe/Stockholm), format 'yyyy-MM-dd HH:mm:ss' (2024-12-27 16:59:00) or 'yyyy-MM-dd' for midnight. Only calls before this time are returned, so a date alone excludes that day. Timestamps in the response are UTC. A value in any other format is ignored
order_dir	string -enum	no	direction to order result by `Allowed: [DESC, ASC]` `Default: DESC`
users	integer[]	no	only calls associated with these user ids; if any value is not an integer the filter is ignored
queues	integer[]	no	Queue ids to filter the results, as returned by GET /company/queues
disposition	string -enum	no	outcome of the call to filter by `Allowed: [ANSWERED, NOANSWERED, TRANSFER]`
handled_status	string -enum	no	handled status to filter by; new also matches calls nobody has handled `Allowed: [new, inprogress, assigned, handled]`

Required permissions

read queue monitor read company queues read user transcript_access read company transcript_access

Request example

    curl -G -H 'Authorization: Bearer <>' \
    -d 'queues[]=20' \
    -d 'queues[]=21' \
    --data-urlencode 'datetime_from=2026-09-23 08:00:00' \
    --data-urlencode 'datetime_to=2026-09-24 08:00:00' \
    -d 'limit=100' \
    -d 'limit_from=0' \
    -d 'order_dir=DESC' \
    "https://api-nguc.weblink.se/queue/cdr"

get /user/call/history Get user call history Get user call history

If a call has been transcribed, you will receive: "transcript_id": "xxxxx", "transcript_status": "done"
Page with limit_from: add limit to it for each request until you have fetched count calls.

Query parameters

Name	Type	Required	Description
limit	integer	no	limit number of results `Default: 20`
limit_from	integer	no	starting point to fetch limit number of results
show	string[]	no	the category of calls to show history for.
datetime_from	string	no	oldest call to return, in Swedish local time (Europe/Stockholm) unless the value carries a UTC offset, format 'yyyy-MM-dd HH:mm:ss' (2024-12-27 08:00:00) or ISO 8601 such as 2024-12-27T07:00:00+00:00. Calls at this time are included. Timestamps in the response are UTC. An unreadable value removes the lower bound. Without datetime_from and datetime_to the last 180 days are returned
datetime_to	string	no	newest call to return, in Swedish local time (Europe/Stockholm) unless the value carries a UTC offset, format 'yyyy-MM-dd HH:mm:ss' (2024-12-27 16:59:00) or ISO 8601 such as 2024-12-27T15:59:00+00:00. Calls at this time are included, so a date alone ends the range at midnight at the start of that day. Timestamps in the response are UTC. An unreadable value returns no calls
order_dir	string -enum	no	the direction to order the results by. `Allowed: [ASC, DESC]` `Default: DESC`
search	string	no	phone number to search for.

Required permissions

read user call history read user transcript_access

Request example

    curl -G -H 'Authorization: Bearer <>' \
    --data-urlencode 'datetime_from=2026-09-23 08:00:00' \
    --data-urlencode 'datetime_to=2026-09-24 08:00:00' \
    -d 'limit=100' \
    -d 'limit_from=0' \
    -d 'order_dir=DESC' \
    "https://api-nguc.weblink.se/user/call/history"

get /user/call/{number} Get call interactions for a given phone number Get interactions for a given number

If an interaction has a transcript that you have the right to see, i.e. a queue conversation, or a conversation that you have participated in yourself, you will be given: "transcript_id": "xxxxx", "transcript_status": "done"

Path parameters

Name	Type	Required	Description
number	string	yes	the phone number to search for.

Required permissions

read user call history read user transcript_access

Request example

    curl -G -H 'Authorization: Bearer <>' \
    "https://api-nguc.weblink.se/user/call/1234"

get /transcript/{transcriptId} Get a transcript by ID Get transcript by id Returns the transcript with its AI summaries and, when the caller holds the full-text grant, the verbatim text If you are connected with websocket you get an event when the respective summary is ready, usually within 2-5 seconds The company-level transcript read permission gives summaries and text for all company transcripts The user-level transcript read permission gives summaries and text for your own calls, and the summaries alone for queues you monitor Queue-monitor access without a transcript read permission is denied (403) Pass summary_only to skip the text and get the summaries alone The text list is then empty, exactly as it is for a caller without the full-text grant, so it does not tell you whether a text exists

Returns the transcript with its AI summaries and, with the full-text grant, the verbatim text. Pass summary_only=1 to get the summaries alone. Use only summaries whose state is done; the summary list is omitted until a summary exists. If you are connected with websocket you get an event when the respective summary is ready, usually within a few seconds.

Path parameters

Name	Type	Required	Description
transcriptId	integer	yes	the id of the transcript to retrieve.

Query parameters

Name	Type	Required	Description
summary_only	boolean	no	Return the summaries only; the text list comes back empty

Required permissions

read queue monitor read user transcript_access read company transcript_access

Request example

    curl -G -H 'Authorization: Bearer <>' \
    -d 'summary_only=1' \
    "https://api-nguc.weblink.se/transcript/123456"

Response example

    {
        "call_guid": "92d76de54e02a5c6ef439bd7459f07316c5b0536",
        "added_utc": "2026-09-24T07:15:40+00:00",
        "status": "done",
        "ast_queue_id": "20",
        "json_data": null,
        "transcript_id": "123456",
        "text": [],
        "summary": [
            {
                "id": "44321",
                "transcript_id": "123456",
                "state": "done",
                "name": "Short summary",
                "prompt": "Summarise the call ...",
                "summary": "The customer called about an incorrect invoice ...",
                "added": "2026-09-24T07:16:02+00:00",
                "started": "2026-09-24T07:16:03+00:00",
                "finished": "2026-09-24T07:16:06+00:00"
            }
        ]
    }

Real-time events

WebSocket event stream

Be notified instantly when users, devices, queues and calls change state. NGUC pushes events over WebSockets using the SockJS protocol. Only status changes generate events, so you should fetch the initial state via REST and apply events as deltas.

SockJS protocol

Reference specification.

Client implementations

Examples in many languages.

Heartbeat

Server emits h every ~25s.

Connect & authenticate

Open a WebSocket connection to the event endpoint with two random ID segments. id1 is a 3-digit numerical value (e.g. 123); id2 is a randomly generated 10–40 character alphanumeric string unique to your connection.

The server sends o as a prompt for authentication. You must reply within a few seconds with a valid OAuth 2.0 access token, otherwise the connection is dropped. When you refresh the access token, you must issue a new authenticate message on the open socket — there is no need to reconnect.

Endpoint

wss://event-nguc.weblink.se/id1/id2/websocket

Generate IDs (PHP)

rand(100, 999) . "/" . substr(md5(microtime()), 0, 8)

Authenticate frame

["[\"authenticate\",{\"authorization\":\"Bearer <access_token>\"}]"]

Protocol symbols

o

Server is requesting authentication.

c[…]

Authentication failed (with error code).

a[…]

Event payload received.

h

Heartbeat — emitted every ~25 seconds.

Event payload shape

a["[\"EventName\", { /* event data */ }]"]

Event catalog

Click any event to see its payload schema and an example.

Cdr User Call Data Record event

Call information associated with a single user

Field	Type	Format	Description
id	string	int32	Unique call identifier as integer
pbx_recording_id	string	int32	Recording identifier that is associated with the call If there are no recording present then a boolean false will be used.
dst_pbx_user_id	string	int32	Destination/callee user identifier. If the destination is a user in the PBX then this property will contain the user identifier.
src_pbx_user_id	string	int32	Source/caller user identifier. If the caller is a user in the PBX then this property will contain the user identifier.
remote_pbx_contact_id	string	int32	Remote contact identifier
direction	string-enum		The direction of the call; if the call originated (OUT) or received (IN) `Allowed: [IN, OUT]`
dst	string		Destination/dialed number
calldate	string	date-time	Date and time when the call was created
src	string		Source number/ANI
org_src	string		Original source number Calling number as it arrived, before any caller ID rewriting, in national format. Empty string when it is not known.
billsec	string	int32	Billable seconds Number of seconds the call has lasted that will be used for billing.
disposition	string-enum		Current disposition of the call The result/outcome of the call. `Allowed: [INVALID, ANSWER, NO ANSWER, BUSY, CANCEL]`
call_guid	string		Call identifier as string Call identifier as string. `Max chars: 40`
transcript_id	string	int32	Transcript identifier Identifier of the call's transcript. Empty string when the call has no transcript or when the receiving user lacks the user- or company-level transcript read permission. Fetch the transcript with GET /transcript/{transcriptId}.
transcript_status	string		Transcript status Status of the transcript: init, running, error or done. Empty string under the same conditions as transcript_id.

Example payload

{
    "id": "1019433380",
    "pbx_recording_id": false,
    "dst_pbx_user_id": null,
    "src_pbx_user_id": "86480",
    "remote_pbx_contact_id": null,
    "direction": "OUT",
    "dst": "90510",
    "calldate": "2024-09-10 09:03:09",
    "src": "3024",
    "org_src": "",
    "billsec": "12",
    "disposition": "ANSWER",
    "call_guid": "92d76de54e02a5c6ef439bd7459f07316c5b0536",
    "transcript_id": "1234347",
    "transcript_status": "done"
}

Queue Queue status information

This event is sent when state of call or member in the queue changes. The event is sent as a snapshot of the queue at the time of the event.

Field	Type	Description
callers	array	Queue calls Calls that are currently in the queue.
members	array	Information related to the members in the queue
queue	object	Queue information Contains information about the queue itself.

callers — Queue calls

Field	Type	Format	Description
added	string	date-time	Creation time Date and time when the call was created.
id	string	int32	Unique call identifier
number	string		Caller number The caller number in national format.
pbx_queue_id	string	int32	Associated queue identifier The identifier of the queue where the call resides.
position	string	int32	Queue position The position of the caller within the queue. `Min: 1`
wait_time	string	int32	Wait time For how long the call has been in the queue in seconds.

members — Information related to the members in the queue

Field	Type	Format	Description
avg_call_length	string	int32	Average call length Todays average call length for the member (in this group) in seconds.
call_guid	string		Unique identifier as string. If the member is busy in a call; contains the identifier of that call.
calls_missed	string	int32	Number of calls missed today. Number of calls that was not answered today.
calls_taken	string	int32	Number of calls answered Number of calls answered by the member today.
dur_added	string		TODO
dur_bridged	string		TODO
id	string	int32	Unique queue member identifier The identifier is unique to this member instance within the group.
last_call	string		TODO
membername	string		Full name Full name of the member/user. `Max chars: 50`
paused	string	int32	If the member is currently paused in the queue The possible values are 0 (available) and 1 (paused).
paused_reason	string		Pause reason If there is any reason, other than user initiated, then this property contains the cause for pause.
pbx_queue_id	string	int32	Associated queue identifier for this member TODO
pbx_user_id	string	int32	Member user identifier User identifier as integer.
penalty	string		TODO TODO
priority	string		Member priority The priority of the member within this queue to receive calls. Higher priority implies higher probability to receive calls from the queue.
remote_name	string		Remote name Contains the name of the remote party if there is one.
remote_number	string		Remote number If the member is busy in a call; contains the number of the remote party.
remote_seconds	string	int32	Connect time If the member is busy in a call; the call duration in seconds.
skills	string	int32	Skills Member skill in the queue.
state	string-enum	int32	Current state The current state of the member. `Allowed: [1, 2, 3, 4, 5]`

queue — Queue information

Field	Type	Format	Description
abandoned	string	int32	Number of abandoned calls Number of calls that has entered the queue but disconnected early without being handled today.
completed	string	int32	Number of completed calls Total number of calls that was completed/handled in the queue today.
holdtime	string	int32	Accumulated hold time The accumulated hold time today for all calls and members.
id	string	int32	Unique queue identifier
member_available	string	int32	Number of queue members that is available to handle calls in this queue
member_total	string	int32	Total member queue regardless their ability to handle calls
name	string		Name of the queue
service_level	string	int32	Current service level that the queue is set to `Min: 0 Max: 100`
service_level_time	string	int32	For how long the current service level has been set in seconds.
talktime	string	int32	Accumulated talk time Accumulated talk time in seconds for all members in the queue today.
total	string	int32	Total calls Total number of calls within the queue.
wait_avg	string	int32	Average waiting time in seconds
wait_longest	string	int32	Longest wait time The longest wait time in the queue before being either answered or unhandled today in seconds.
waiting	string	int32	Number of calls that is currently waiting in the queue

Example payload

{
    "callers": [
        {
            "added": "2024-09-12T06:29:00+00:00",
            "id": "16907471",
            "number": "0858615676",
            "pbx_queue_id": "21200",
            "position": "1",
            "wait_time": "1"
        }
    ],
    "members": [
        {
            "avg_call_length": "207",
            "call_guid": "2a8d9c52b1fb263e437253daa96f91fafcf07e84",
            "calls_missed": "1",
            "calls_taken": "1",
            "dur_added": "1",
            "dur_bridged": null,
            "id": "123456",
            "last_call": "1152",
            "membername": "Firstname Lastname",
            "paused": "0",
            "paused_reason": "",
            "pbx_queue_id": "123456",
            "pbx_user_id": "123456",
            "penalty": "0",
            "priority": "3",
            "remote_name": "External user",
            "remote_number": "0812345678",
            "remote_seconds": "1",
            "skills": "1",
            "state": "5"
        }
    ],
    "queue": {
        "abandoned": "0",
        "completed": "3",
        "holdtime": "48",
        "id": "123456",
        "member_available": "6",
        "member_total": "7",
        "name": "Support",
        "service_level": "0.67",
        "service_level_time": "60",
        "talktime": "499",
        "total": "3",
        "wait_avg": "58",
        "wait_longest": "153",
        "waiting": "1"
    }
}

QueueCdr Queue Call Data Record

Sent for each call during each step of the call lifetime.

Field	Type	Format	Description
calldate	string	date-time	Created datetime Date and time in UTC when the call was created.
e164_src	string		Source E.164 Source caller number in E.164 format.
e164_did	string		Target E.164 Target destination/dialed number in E.164 format.
call_guid	string		Unique call identifier Unique call identifier as string.
ast_queue_id	string	int32	Queue identifier Unique identifier of the queue that received the call
disposition	string-enum		The end result of the call This indicates the end result of the call. `Allowed: [ANSWERED, NOANSWERED, TRANSFER]`
answered_by	string		The full name of the agent who answered `Max chars: 50`
reason	string		TODO
wait_time	string	int32	Wait time Accumulated time waiting in queue in seconds.
talk_time	string	int32	Talk time Accumulated talk time in seconds.
pbx_user_id	string	int32	Remote user identity The identifier of the user associated with the call.
id	string	int32	Unique call identifier as integer
handled	object		If the CDR has been handled. If a member of the group has handled the called.
callerid	string		Caller number Caller identifier that is presented as national number (no country code)
did	string		Dialed number The dialed number as national number (no country code)
transcript_id	string	int32	Transcript identifier Identifier of the transcript of the queue call. Empty string when the queue call has no transcript or when the receiving user lacks the user- or company-level transcript read permission. Fetch the transcript with GET /transcript/{transcriptId}.
transcript_status	string		Transcript status Status of the transcript: init, running, error or done. Empty string under the same conditions as transcript_id.

Example payload

{
    "calldate": "2024-09-12T09:44:16+00:00",
    "e164_src": "1000",
    "e164_did": null,
    "call_guid": "cfc5b95bd30a3f58b5f289f4591a2d3c1fe14017",
    "ast_queue_id": "123456",
    "disposition": "ANSWERED",
    "answered_by": "Firstname Lastname",
    "reason": null,
    "wait_time": "5",
    "talk_time": "60",
    "pbx_user_id": "123456",
    "id": "12345689",
    "handled": [],
    "callerid": "1000",
    "did": "",
    "transcript_id": "1234347",
    "transcript_status": "done"
}

TranscriptionSegmentAdded Transcription segment added

Sent to the user whose call is being transcribed for each new segment with text, if that user holds the user-level transcript read permission.

Field	Type	Format	Description
transcript_id	integer	int64	Transcript identifier Identifier of the transcript. Fetch it with GET /transcript/{transcriptId}.
segment_id	integer	int64	Segment identifier Unique identifier of the segment.
payload	object		Segment The transcribed segment.

payload — Segment

Field	Type	Format	Description
IsValid	boolean		Valid segment True when the segment has an offset and text, which every sent segment has.
speaker_id	string		Speaker Speaker the segment is attributed to, Unknown when diarisation could not tell.
offset	integer	int32	Offset Start of the segment in milliseconds from the beginning of the call.
duration	integer	int32	Duration Length of the segment in milliseconds.
text	string		Text Transcribed text of the segment.
seqno	integer	int32	Sequence number Position of the segment within the transcript.
confidence	number	double	Confidence Recognition confidence reported by the speech service, for example 0.47. Omitted when zero.
language	string		Language Language of the segment as a language tag, for example en-US.

Example payload

{
    "transcript_id": 1234347,
    "segment_id": 10004620,
    "payload": {
        "IsValid": true,
        "speaker_id": "Guest-1",
        "offset": 510,
        "duration": 9440,
        "text": "Hello, I am calling about my latest invoice.",
        "seqno": 1,
        "language": "en-US"
    }
}

TranscriptionStarted Transcription started

Sent to the user whose call is being transcribed when transcription starts, if that user holds the user-level transcript read permission. Fetch the transcript with GET /transcript/{transcriptId} once its status is done.

Field	Type	Format	Description
meta	object		Call information
agent_id	integer	int32	User identifier Identifier of the user whose call is transcribed.
transcript_id	integer	int64	Transcript identifier Identifier of the transcript. Fetch it with GET /transcript/{transcriptId}.

meta — Call information

Field	Type	Format	Description
call_id	string		Call identifier Globally unique call identifier, the same value as call_guid in call history and queue CDR. `Max chars: 40`

Example payload

{
    "meta": {
        "call_id": "e6ef13b2f809df9d2df20e99570d2c7268d064b5"
    },
    "agent_id": 95086,
    "transcript_id": 1234347
}

TranscriptionStopped Transcription stopped

Sent to the user whose call was transcribed when transcription stops. Unlike the other transcription events it is sent regardless of transcript permissions.

Field	Type	Format	Description
agent_id	integer	int32	User identifier Identifier of the user whose call is transcribed.
transcript_id	integer	int64	Transcript identifier Identifier of the transcript. Fetch it with GET /transcript/{transcriptId}.

Example payload

{
    "agent_id": 95086,
    "transcript_id": 1234347
}

TranscriptionSummary Transcription summary

Sent when an AI summary of a transcript is ready: to the user whose call was transcribed, if that user holds the user-level transcript read permission, and for queue calls to users with queue monitor access and the user-level transcript read permission.

Field	Type	Format	Description
transcript_id	integer	int64	Transcript identifier Identifier of the transcript. Fetch it with GET /transcript/{transcriptId}.
name	string		Summary name Name of the summary type, as configured on the company, for example summary_short.
summary	string		Summary Generated summary text.

Example payload

{
    "transcript_id": 1234347,
    "name": "summary_short",
    "summary": "\u00c4mne:\nSamtalet best\u00e5r av osammanh\u00e4ngande och otydliga uttalanden utan ett definierat \u00e4mne.\n\nSamtalsparter:\nKund, F\u00f6retagsrepresentant\n\nSammanfattning:\nTranskriptionen inneh\u00e5ller fragmenterade yttranden som saknar ett tydligt \u00e4mne."
}

UserStatus User status information

Contains current line state for a single user

Field	Type	Format	Description
pbx_user_id	string	int32	Unique user identifier
status	string-enum	int32	Current status as integer This is a flaggable integer where multiple values can be set at the same time. `Allowed: [Idle(0), InUse(1), Unavailable(4), Ringing(8), InUse and Ringing(9)]`
status_text	string-enum		Current status as text Contains the current status as text. `Allowed: [Idle, InUse, Unavailable, Ringing, InUse&Ringing]`

Example payload

{
    "pbx_user_id": "123456",
    "status": "1",
    "status_text": "InUse"
}

Reference

Simple API

The simple endpoints are different from the rest of the API: they authenticate with a token and are not tied to a user. They are intended for server-to-server integrations.

To gain access, contact us.

Open Swagger UI

Full API reference

Every endpoint, every parameter, every response — fully interactive. Try requests directly from the browser.

Swagger UI

Live, interactive OpenAPI explorer with grouped controllers and request/response samples.

Open Swagger UI Browse categories only Filter example

?only[]= filter to specific categories · ?hide show category list only

NGUC API

Three steps to your first request

Authenticate

Call an endpoint

Refresh as needed

OAuth 2.0 password grant

Required parameters

Refresh access token

Authenticated requests

Simple API

100 requests per 60 seconds

Status codes

Queue statistics

Endpoint details

Recordings

Endpoint details

Reports

Endpoint details

AI transcripts

Endpoint details

WebSocket event stream

Connect & authenticate

Protocol symbols

Event catalog

Simple API

Full API reference

Swagger UI