telyzer
Start free trial
Menu
Sign in العربية

Grandstream UCM

The UCM posts each call record to Telyzer over HTTPS as the call ends, or Telyzer reads them from the UCM's CDR API — with the last 30 days of history.

Documentation menu
Note: Built from the vendor's documented record format and tested against its examples. We mark it supported once a customer's real records pass our checks — send us a few lines if you can.

Grandstream UCM6300, UCM6300A, UCM6200 and UCM6510 can send every call detail record (CDR) the moment a call ends — the CDR Real-Time Output, over HTTPS or TCP, in JSON or XML — and keep records it could not deliver until the receiver is back. Telyzer can also ask the UCM's CDR API for new records, which brings in earlier calls as well.

Values in dashed boxes are this organization's own: the portal's How to connect panel shows them filled in, with copy buttons.

CDR Real-time Output over HTTPS — the UCM posts each record

Recommended for Telyzer Cloud.

Telyzer Cloud

  1. Sign in to the UCM web interface and open Integrations → API Configuration → CDR Real-Time Output Settings (older firmware: Value-added Features → API Configuration → CDR Real-Time Output Settings). Tick Enable.
  2. Server Address: your connector's push address — enter the full address. If your firmware shows a separate Port field, enter 443 there.
  3. Delivery Method: HTTP/HTTPS. Format: JSON (XML is read too).
  4. Username and Password: leave them empty — the secret part of the address identifies your connector. Save, then choose Apply Changes.

Telyzer Server

  1. Sign in to the UCM web interface and open Integrations → API Configuration → CDR Real-Time Output Settings (older firmware: Value-added Features → API Configuration → CDR Real-Time Output Settings). Tick Enable.
  2. Server Address: your connector's push address — enter the full address. If your firmware shows a separate Port field, enter 443 there.
  3. On a Telyzer Server this address is the server's own portal address on your local network; the UCM must be able to reach it.
  4. Delivery Method: HTTP/HTTPS. Format: JSON (XML is read too).
  5. Username and Password: leave them empty — the secret part of the address identifies your connector. Save, then choose Apply Changes.
Firewall: Telyzer Cloud The UCM opens the connection: allow outbound HTTPS (TCP 443) from the UCM; nothing inbound.
Firewall: Telyzer Server The UCM opens the connection: a firewall between the UCM and the server must allow TCP from the UCM to the server's HTTPS port.

CDR API — Telyzer asks the UCM for new records (with history)

Recommended for Telyzer Server.

Telyzer Cloud

  1. UCM6300 / UCM6300A: open Integrations → API Configuration → HTTPS API Settings (New), tick Enable, and add a user telyzer with a strong password.
  2. On the same page, add the address Telyzer connects from to the login whitelist, so failed sign-ins never block Telyzer's address.
  3. UCM6200 series and UCM6510 (legacy API): open Integrations → API Configuration → HTTPS API Settings (Old) (older firmware: Value-added Features → API Configuration), tick Enable, set TLS Bind Address 0.0.0.0:8443, User Name telyzer and a password, Permitted IP(s) the address Telyzer connects from/255.255.255.255, and tick CDR API. Save, then Apply Changes.
  4. In Telyzer, enter the UCM's address, the port (8089 for the new API, 8443 for the legacy one), the user and password, and the UCM family, then choose Check connection.
  5. On the first connection Telyzer collects the last 30 days of calls, then asks the UCM for new records every minute.
  6. Telyzer Cloud reaches the UCM over the internet, so it must be reachable on that port. If it is not, use the HTTPS push instead, or the Telyzer Relay on your network: telyzer-relay add-collector --kind grandstream_api --host <UCM address> --user telyzer --password <password> (add --flavor legacy for UCM6200/6510), then Restart-Service TelyzerRelay.

Telyzer Server

  1. UCM6300 / UCM6300A: open Integrations → API Configuration → HTTPS API Settings (New), tick Enable, and add a user telyzer with a strong password.
  2. On the same page, add the address Telyzer connects from to the login whitelist, so failed sign-ins never block Telyzer's address.
  3. UCM6200 series and UCM6510 (legacy API): open Integrations → API Configuration → HTTPS API Settings (Old) (older firmware: Value-added Features → API Configuration), tick Enable, set TLS Bind Address 0.0.0.0:8443, User Name telyzer and a password, Permitted IP(s) the address Telyzer connects from/255.255.255.255, and tick CDR API. Save, then Apply Changes.
  4. In Telyzer, enter the UCM's address, the port (8089 for the new API, 8443 for the legacy one), the user and password, and the UCM family, then choose Check connection.
  5. On the first connection Telyzer collects the last 30 days of calls, then asks the UCM for new records every minute.
Firewall: Telyzer Cloud Telyzer opens the connection to the UCM's HTTPS port (8089; legacy API 8443): the UCM must accept it from the internet — forward that port to the UCM and allow only the address Telyzer connects from.
Firewall: Telyzer Server Telyzer opens the connection to the UCM's HTTPS port (8089; legacy API 8443): allow it from the server on your local network.

CDR Real-time Output over TCP — the UCM connects to Telyzer

Telyzer Cloud

  1. Sign in to the UCM web interface and open Integrations → API Configuration → CDR Real-Time Output Settings (older firmware: Value-added Features → API Configuration → CDR Real-Time Output Settings). Tick Enable.
  2. Server Address: your Telyzer address — Port: your connector's port.
  3. Delivery Method: TCP. Format: JSON (XML is read too).
  4. Username and Password: leave them empty. Save, then choose Apply Changes.
  5. In Telyzer, add your office's public IP address — the address its traffic leaves your network from — to the connector's allowed addresses. Records from any other address are refused.

Telyzer Server

  1. Sign in to the UCM web interface and open Integrations → API Configuration → CDR Real-Time Output Settings (older firmware: Value-added Features → API Configuration → CDR Real-Time Output Settings). Tick Enable.
  2. Server Address: your Telyzer address — Port: your connector's port.
  3. Delivery Method: TCP. Format: JSON (XML is read too).
  4. Username and Password: leave them empty. Save, then choose Apply Changes.
  5. In Telyzer, enter the phone system's LAN address in the connector's allowed addresses (the UCM's LAN address, shown under System Status → Network Status). Left empty, any phone system on your local network is accepted.
Firewall: Telyzer Cloud UCM opens the connection: allow outbound TCP from UCM to your Telyzer address port your connector's port; no inbound rule is needed.
Firewall: Telyzer Server UCM opens the connection. Windows Firewall on the server already accepts phone systems on its local network on the connector ports; a firewall between UCM and the server must allow TCP to your connector's port.

Through the Telyzer Relay on your network

  1. In Telyzer, open this connector and choose Create enrollment code. You get a code and a download link for the person at the site; both work once and expire in 24 hours.
  2. On an always-on Windows PC on the same network as the phone system, open the link and run TelyzerRelaySetup.exe (the code is filled in). Choose Another phone system and Install. The relay runs as the TelyzerRelay service; only outbound HTTPS leaves this PC.
  3. Set the relay to read documents (PowerShell as Administrator on the relay PC): telyzer-relay set-input --documents, then Restart-Service TelyzerRelay.
  4. Sign in to the UCM web interface and open Integrations → API Configuration → CDR Real-Time Output Settings (older firmware: Value-added Features → API Configuration → CDR Real-Time Output Settings). Tick Enable.
  5. Server Address: the relay PC's LAN address — Port: 33333. Delivery Method: TCP. Format: JSON.
  6. Username and Password: leave them empty. Save, then choose Apply Changes.
Firewall: The phone system sends to the relay PC on your local network (TCP 33333 unless you chose another port; the setup opens it in Windows Firewall for private and domain networks only). The relay PC needs outbound HTTPS (TCP 443) only: no inbound port, and the phone system is never exposed to the internet.

Check that it works

Telyzer Cloud

  1. Make an external test call and hang up. The phone system sends the record when the call ends, so it arrives a few seconds later.
  2. In Telyzer, Waiting for the first call record turns green when the first record is read. If it shows a problem instead — no connection yet, connections refused, or records that could not be read — it names the cause and shows the line received.
  3. On the UCM, CDR → CDR lists the same call. With the API, Check connection in Telyzer reports a wrong user or password, a refused address or a certificate problem precisely.
  4. Connections refused by the allowlist show as Refused connections from …. If that is your phone system's address (your firewall may translate it to another public address), choose Add to allowlist; it is accepted within 30 seconds.

Telyzer Server

  1. Make an external test call and hang up. The phone system sends the record when the call ends, so it arrives a few seconds later.
  2. In Telyzer, Waiting for the first call record turns green when the first record is read. If it shows a problem instead — no connection yet, connections refused, or records that could not be read — it names the cause and shows the line received.
  3. On the UCM, CDR → CDR lists the same call. With the API, Check connection in Telyzer reports a wrong user or password, a refused address or a certificate problem precisely.

Notes

  • CDR Real-Time Output needs firmware 1.0.17.16 or later on UCM6200/6510 and 1.0.5.4 or later on UCM6300A. While Telyzer cannot be reached, the UCM keeps up to 10,000 records and sends them when the connection returns.
  • The UCM has one CDR Real-Time Output. If another program already receives it, choose the CDR API instead, which does not take it over.
  • The TCP output is not encrypted: over the internet prefer HTTPS, or restrict the connector to your office's public address.
  • The HTTPS API uses the UCM's web certificate and works only when the UCM's web interface runs on HTTPS.

All phone systems