API Documentation for Partners to automate billing workflows with Comms Channel

Overview

The CommsCDR API lets partners programmatically access their call detail records (CDRs) and billing information for mobile and internet services provisioned through Comms Channel — so you can automate billing workflows, reconciliation, auditing, and usage reporting without logging into the portal. This guide covers the three available APIs.

Base URL

https://commsportal.com.au/api

Note: All API endpoints require authentication. Call the Authentication API first to obtain an access token, then include it as a Bearer token in the Authorization header of every subsequent request.

1. Authentication API

The Authentication API issues a time-limited JSON Web Token (JWT) that must be included in all subsequent API calls. Tokens expire after 1 hour; use the refresh token to obtain a new access token without re-entering credentials.

Endpoint

POST  https://commsportal.com.au/api/Auth/GetAccessToken

Request Headers

Request Body

Sample Request

curl --location 'https://commsportal.com.au/api/Auth/GetAccessToken' \
--header 'Content-Type: application/json' \
--data '{
  "email": "your@email.com",
  "password": "yourpassword"
}'

Response Fields

Sample Response

{
  "tokenType": "Bearer",
  "accessToken": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9...",
  "expiresIn": 3600.0
}

Using the Token

Include the access token in the Authorization header of every subsequent API request:

Authorization: Bearer <accessToken>

Important: Access tokens expire after 1 hour (3600 seconds). Store the refreshToken securely and use it to request a new access token when needed. Do not hard-code tokens in your application.

2. Usage Records API (CDRs)

The Usage Records API returns individual call detail records (CDRs) for mobile services. Records can be filtered by date range, phone number, and customer name, and are returned in paginated form.

Endpoint

GET  https://commsportal.com.au/api/Cdr/GetUsageRecords

Request Headers

Query Parameters

Append these parameters to the URL as a query string (e.g. ?fromDate=...&toDate=...).

Note: The fromDate and toDate parameters are required. All other parameters are optional filters. Combine multiple optional filters to narrow results — for example, specifying both origin and customerName returns only records matching both criteria.

Date Format

Dates must be provided in the following human-readable format:

D Month, YYYY

Examples:
  1 January, 2026
  15 April, 2026
  3 December, 2025

Important: When including dates in a URL, spaces and commas must be percent-encoded. A space becomes %20 and a comma becomes %2C. Most HTTP client libraries handle this automatically. Example: 1%20January%2C%202026

Sample Request

curl --location 'https://commsportal.com.au/api/Cdr/GetUsageRecords
  ?fromDate=1%20January%2C%202026
  &toDate=15%20April%2C%202026
  &page=1
  &pageSize=5
  &origin=0491643501
  &destination=0101
  &customerName=Company1' \
--header 'accept: */*' \
--header 'Authorization: Bearer <accessToken>'

Response Fields

CDR Record Fields

Sample Response

{
  "totalRecords": 2,
  "cdrs": [
    {
      "recordType": "A",
      "custno": 1234567,
      "lineseqno": 10,
      "phoneNumber": "04XXXXXXXX",
      "batchno": 3346352,
      "callno": 456715424,
      "chargeType": "CALL",
      "dateStart": "2026-02-05T15:01:23",
      "duration": 20,
      "origin": "04XXXXXXXX",
      "destination": "04XXXXXXXX",
      "serviceid": "WM",
      "priceComp1": 0.0,
      "priceCharge": 0.0,
      "tariffCode": "PM:MVD",
      "extraInfo": "42510496",
      "extraInfo2": "Diverted Call"
    }
  ]
}

Pagination

Results are paginated. Use the page and pageSize parameters to navigate large result sets. The totalRecords field tells you the total number of matching records, which you can use to calculate how many pages exist.

Total pages = ceil(totalRecords / pageSize)

Example: totalRecords=250, pageSize=50  =>  5 pages
  Page 1: records 1-50
  Page 2: records 51-100
  ...

3. Billing Records API

The Billing Records API returns all internet and voice services currently provisioned and billed for your account. This is a snapshot of your active service portfolio — useful for reconciliation, auditing, and displaying service summaries to your end clients.

Note: This endpoint returns all billable services for the authenticated account. No filters are supported — the full service list is always returned.

Endpoint

GET  https://commsportal.com.au/api/Cdr/GetBillingRecords

Request Headers

Sample Request

curl --location 'https://commsportal.com.au/api/Cdr/GetBillingRecords' \
--header 'accept: */*' \
--header 'Authorization: Bearer <accessToken>'

Response Structure

The response is a JSON object with two top-level arrays:

Internet Service Fields

Voice Service Fields

Sample Response

{
  "InternetServices": [
    {
      "type": "internet",
      "id": 1,
      "description": "Business Fibre - Fibre 1000 - Unlimited - 48 Months",
      "status": "active",
      "unit_price": "650.0000",
      "start_date": "2026-2-11",
      "end_date": "0000-00-00",
      "additional_attributes": {
        "end_client_name": "Company1",
        "carrier_service_id": "12234",
        "ip_address": "",
        "po_number": ""
      },
      "geo": {
        "address": "15 Street 1",
        "marker": "-20.20,120.120"
      }
    }
  ],
  "VoiceServices": [
    {
      "type": "voice",
      "id": 9988,
      "description": "CommsMobile 2.0 - P-4G-S",
      "status": "active",
      "phone": "04XXXXXXXX",
      "phonesArray": ["04XXXXXXXX"],
      "unit_price": "26.0000",
      "start_date": "2026-03-17",
      "end_date": "0000-00-00",
      "additional_attributes": {
        "end_client_name": "Company1",
        "nickname": "User1 iPhone 17"
      }
    }
  ]
}

Error Handling

The API uses standard HTTP status codes. Below are the most common codes you may encounter:

Support

If you encounter any issues or have questions about the API, contact your Comms Channel account manager or reach out via the CommsPortal support portal at commsportal.com.au.

Important: Always store your API credentials and access tokens securely. Do not share tokens or embed them in client-side code. Refresh tokens programmatically before they expire to ensure uninterrupted access.