Australian Consumer Data Standards
CDR Telco API
Specifications for resource endpoints applicable to data holders in the Telco sector.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Specifications for resource endpoints applicable to data holders in the Telco sector.
Endpoints 18
Telco Products
- GETGet Telco Products
https://tls.dh.example.com/cds-au/v1/telco/productsObtain a list of telco products that are currently offered to the market. Note that the results returned by this endpoint are expected to be ordered in… - GETGet Telco Product Detail
https://tls.dh.example.com/cds-au/v1/telco/products/:productIdObtain detailed information on a single telco product offered openly to the market.
Telco Accounts
- GETGet Telco Accounts
/telco/accountsObtain the list of telco accounts available under the authorised consent. - GETGet Telco Account Detail
/telco/accounts/:accountIdObtain detailed information for a specific telco account. - GETGet Telco Agreed Payment Schedule
/telco/accounts/:accountId/payment-scheduleObtain the agreed payment schedule and details, if any, for a specific telco account. Some general notes about this endpoint: <ul><li>This API describes how… - GETGet Telco Concessions
/telco/accounts/:accountId/concessionsObtain the details of any concessions or arrangements applied to a specific telco account.
Telco Account Service Usage
- GETGet Usage For Telco Service
/telco/accounts/:serviceId/usageObtain a usage data from a particular _serviceId_. - GETGet Usage
/telco/accounts/usageObtain usage data for all services associated with the customer. - POSTGet Usage For Specific Telco Service
/telco/accounts/usageObtain usage data for a specific service.
Telco Account Balances
- GETGet Balance For Telco Account
/telco/accounts/:accountId/balanceObtain the current balance for a specific account. - GETGet Bulk Telco Balances
/telco/accounts/balanceObtain the current balance for all accounts. - POSTGet Balances For Specific Telco Accounts
/telco/accounts/balanceObtain the current balance for a specified set of accounts.
Telco Account Billing
- GETGet Invoices For Telco Account
/telco/accounts/:accountId/invoicesObtain the invoices for a specific account. - GETGet Telco Invoices
/telco/accounts/invoicesObtain the invoices for all accounts. - POSTGet Invoices For Specific Telco Accounts
/telco/accounts/invoicesObtain invoices for a specified set of accounts. - GETGet Transactions For Telco Account
/telco/accounts/:accountId/transactionsObtain the billing transactions for a specific account. - GETGet Telco Transactions
/telco/accounts/transactionsObtain billing transactions for all accounts. - POSTGet Transactions For Specific Telco Accounts
/telco/accounts/transactionsObtain transactions for a specified set of accounts.
API details
- Base URL
https://mtls.dh.example.com/cds-au/v1- Authentication
- None declared in the description
- Operations
- 18 operations on 14 pathsGET 14POST 4
- Main resources
- Telco Account Billing 6Telco Accounts 4Telco Account Balances 3Telco Account Service Usage 3Telco Products 2
- Description format
- OpenAPI 3.0.3, API version
1.36.0 - Links
- OpenAPI document · Support
How to test the CDR Telco API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the CDR Telco API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Get Telco Products” (GET https://tls.dh.example.com/cds-au/v1/telco/products), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the CDR Telco API?
Specifications for resource endpoints applicable to data holders in the Telco sector. It is listed under Government & public and has 18 endpoints.
Who publishes the CDR Telco API?
It is listed from Australian Consumer Data Standards's public API description (an OpenAPI document), not published by Australian Consumer Data Standards on Swastik Codes. Anyone who controls consumerdatastandards.gov.au can claim the profile by adding a DNS TXT record.
What is the base URL of the CDR Telco API?
Requests go to https://mtls.dh.example.com/cds-au/v1. Endpoint paths are added to this base URL.
How do I authenticate with the CDR Telco API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the CDR Telco API have?
18 operations on 14 paths (14 GET, 4 POST). The largest groups are Telco Account Billing, Telco Accounts, Telco Account Balances, Telco Account Service Usage.
Is forking the CDR Telco API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.