APIs to enable you to download daily or consolidated unrated call records (CDRs) for your end-customer billing, or rated monthly CDRs and non-usage charges such as number activation or port-in charges for your cost reconciliation.

Voice Billing API Details

Status

LIVE

Version

v1

Maturity status

Production

Endpoint (Production)

https://apis.colt.net/usageManagement/resourceName

Endpoint (Sandbox)

https://sandbox.apis.colt.net/usageManagement/resourceName

 

Resource Names:

Operation

Resource Name

Unrated CDR

/unratedCallDetailRecord

Generate consolidated unrated CDR

/generateConsolidatedUnratedCallDetailRecord

Consolidated unrated CDR

​/consolidatedUnratedCallDetailRecord

Rated CDR

/ratedCallDetailRecord

Non usage report

​/nonUsageReport

Call Detail Records API_v1.0.0_06Feb2025.yaml (45.4 KB)
Colt Voice REST Billing API Guide 1.0.docx (517.2 KB)
Title
Voice Billing APIs

Next Gen REST CDR APIs will enable you to download the following:

  • Daily unrated and/or consolidated unrated CDRs for the products listed below
    1. Geographic Number Hosting
    2. IN for Resellers (e.g. Freephone, Shared Cost, IN Geo etc.)
    3. Voice Line                          
    4. Voice Line (v) (also known as IPVoiceLine)
    5. SIP Trunking
    6. CIC for Resellers
    7. CIC Opc Reseller
  • monthly rated CDRs for any Colt voice product
  • non-usage files (.r.cat) containing e.g. Number Hosting order charges, such as new number activation
  • The existing rules will not change e.g. regarding the availability of the CDRs & non-usage files (e.g. unrated CDRs will continue to be available for the past 90 days only).
  • The existing CDR download functionality available in Cocom Web Manager and via FTP will continue to be available.

Our full list of terms and conditions, alongside our acceptable use policy is available below.

Read our terms and conditions

 

Country Code

Country Name

AT

Austria

BE

Belgium

DE

Germany

ES

Spain

FR

France

GB

Great Britain

IE

Ireland

IT

Italy

NL

Netherlands

SE

Sweden

DK

Denmark

PT

Portugal

CH

Switzerland

LU*

Luxembourg

CZ*

Czech Republic

SK*

Slovakia

RO*

Romania

PL*

Poland

FI*

Finland

NO*

Norway

JP*

Japan


*Unrated CDRs for these countries are available for the SIP Trunking service only.

Below is the TMF compliant error payload:

{

  "code": "ERR01",

  "reason": "string",

  "message": "string"

}

 

Get Unrated CDRs

Twice a day, every day of the week, Colt will deposit a file of Call Detail Records (CDR) on the server.

The exception is for the Global SIP countries such as Luxembourg, the Czech Republic, Slovakia & Romania, where the unrated CDRs are delivered daily. 

This will contain all of the CDRs collected by the Colt network since the last file, typically each 12 hours. The CDR files are provided in a pre-defined, fixed length format.

Post Consolidated Unrated CDRs

This feature enables you to place a request for a consolidated CDR file through APIs.

Up to 90 days of CDRs can be requested, e.g. a consolidated file of a week’s worth of CDRs and these files will be delivered to both Colt Online & APIs.

 

Get Consolidated unrated CDR

Within 2 hours the consolidated CDR file will be available for download via APIs which you used in your request. 

The consolidated CDR file will be available to download for 5 days, after that the file will be removed and you will need to submit a new request (if you have not downloaded it).

All Consolidated CDR files delivered have a filename in the following format:-

<profile><orderID>.cdr.zip.

Where:

  • <profile> is up to 5 alphanumeric and is the applicable profile for the product
  • <orderID> is the combination of date and unique number returned after requesting for consolidated CDR
  • .cdr is the extension
  • .zip is where the file is zipped

Example: AM220120110182.cdr.zip

The CDR file contains only CDR records in a fixed length format. A CDR file is made available twice per day – once in the morning and once in the afternoon. The files are delivered at approximately 9AM and 5PM CET.

  • The 9 AM CET file contains calls from 4PM CET the previous day until 8AM CET on the current day
  • The 5 PM CET file contains calls from 8AM CET to 4PM CET on the current day

Please note that CDR files are delivered to your directory 7 days a week and will vary in size depending on the level of traffic that your customers generate.

Please note the exception is for the Global SIP countries such as Luxembourg, the Czech Republic, Slovakia & Romania, where the unrated CDRs are delivered daily at approximately 9 AM CET.

    1.  

CDR File Format

Character Coding

ASCII

File Mark-up Coding

  • No structured Mark-Up used
  • Fixed length records
  • Fixed length fields, space filled

Compression/Decompression Algorithms

CDR files are delivered in Zip format (Unix Gzip, MS Windows Zip). However, Colt recognizes that this can be difficult for certain companies to receive and the CDR files can be delivered in plain text if required. Please notify the Colt Customer Services if you need the CDR files to be delivered as plain text (Uncompressed) files.

File Name

All unrated CDR files delivered to Colt Online and APIs have a filename in the following format:-

<countrycode>_<profile>_<productidentifier>_<sequence no>_<date>.cdr.gz

Where:

  • <countrycode>  in ISO 2 character format
  • <profile> is up to 5 alphanumerics and is the applicable profile for the product
  • <productidentifier> is the product identifier (1-2 alphanumerics) – see table below
  • <sequence no> is a rolling four digit sequence per <profile>_<product> combination
  • <date> is YYYYMMDDHHmmss
  • .cdr is the extension
  • .gz is where the file is zipped

Product Identifier

Product name

00

Voice Line

10

SIP Trunking

11

IP Voice Line (Voice Line (v))

12

IN for Resellers

15

Geographic Number Hosting

19

CIC for Resellers

20

CIC Opc Reseller

Example: DE_ABC_01_0001_20101208090122.cdr.gz

 

A standard format for unrated CDRs applies to our reseller and wholesale product portfolio. This standard CDR format is harmonised across all Colt countries and applies to existing and new products going forward in Colt Online.

Please note: There is an ASCII Control Character (Line Feed, HEX 0A) after the last field 19 “End of record”. This Control character generates a new line for the next CDR and shows that the actual CDR ends. Normally you can ignore this control character except you use a HEX-Editor to process your CDRs.

Please Note: The first CDR file will appear in Colt Online after the first call has been made.

 

Ref

Name

Bytes/
Length

Position

Alpha/
Numeric

Format & Description

1

Origin

20

1

N

Originating CLI with leading  0. Filler spaces must be added to fill in the spaces designated for a field.  In the case of IN, the last 4 digits are replaced with ‘x’.

In the case of Czech Republic (CZ), Poland (PL), Romania (RO) ,Slovakia (SK), Luxembourg (LUX), Finland (FI) ,Norway (NO),  Japan (JP) for SIP Trunking, the Originating CLI starts with the country code

In the case of Global IN for Resellers ordered through the UK, the caller’s number will be in the international format, starting with 00 + the country code + the number (omitting the leading zero) e.g. caller calling from a mobile in Romania: 004074582xxxx

2

Destination (Terminating)

20

21

N

Destination 0    = Domestic and National, Destination 00 =  International

In the case of Czech Republic (CZ), Poland (PL), Romania (RO) ,Slovakia (SK), Luxembourg (LUX), Finland (FI) ,Norway (NO),  Japan (JP) for SIP Trunking, the destination starts with the country code

3

Product Type

2

41

N

‘01’=Indirect Service

‘00’ = Direct Service
'04' = Direct Service

’06‘=NH Geo Premium

‘07’=NH Geo Wholesale

'08'=NH Geo Retail

'09'=NH Geo Incoming

'10'=NH IN Incoming
'79' = SIP Trunking

‘80’ = IP Voice Line (Voice Line (v))

CIC for Reseller is SIP trunk reseller, so cdr format will have product code as ‘79’

4

Date

8

43

N

YYYYMMDD

5

Time

8

51

N

HHMMSSss . Time duration is broken up into tenths of a second. Fractions of a second will be ignored.

6

Duration

8

59

N

Duration of the call to the nearest 1/10th of a second SSSSSSSs

7

Continuation

1

67

N

‘0’, ‘1’, ‘2’, ‘3’ or ‘5’ – normally a 0. To be used only if calls are greater than 6 hours

8

Switch ID

25

68

N

Unique switch identifier

9

Trunk incoming

25

93

N

Internal use only

10

Trunk outgoing

25

118

N

Internal use only

11

Account Code

20

143

A

Not in use

12

Pulses in

6

163

N

Not in use

13

Pulses generated

6

169

N

Not in use

14

Pulses sent

6

175

A

In use for all IN, Voice & VoIP services in UK & France: Charge Band defined by Regulator(Ofcom UK/Arcep FR) for calls to non-geographic numbers. If no Charge Band is available, the value is 000000 or blank.

15

Service Indicator

4

181

N

0000 for standard calls, 0001 for ISDN calls

16

Charged (C-Num)

20

185

N

Trunk ID shown here for IP Voice Line (Voice Line (v)) and for SIP Trunking

In use for IN services – the number to which the IN service number is translated.

In the case of Global IN for Resellers ordered through the UK, this number will be in the international format, starting with 00 + the country code + the number (omitting the leading zero)

17

Dialled (D-Num)

20

205

N

In use for IN services (IN service number)

In the case of Global IN for Resellers ordered through the UK, the IN service number will be in the international format, starting with 00 + the country code + the number (omitting the leading zero) e.g. Romania freephone number: 0040800890123

18

Carrier

3

225

A

The Reseller profile of up to 3 alphanumerics

19

End of Record

1

228

A

Value of zero is shown

20

Line Feed

1

229

ASCII Control Character

Line Feed (ASCII Control Character not visible in plain text editors

 

Sample unrated CDRs for Voice Line:-

06971041234          0368751234002011093007235400000007301                    00063                                           OF3XBN33687512340                0000010000010000                              0368751234 SV0

06971041234        038203731234002011093007225600000013201                    00063                                           OF3XBN33855523484                0000010000010000                            038203731234 SV0

06971041234           066311234002011093007250000000001101                    00063                                           OF3EZLA663121234                 0000010000010000                               066311234 SV0

 

Sample unrated CDRs for Voice Line (FR):-

0982406525          0841118663002015082009134390000074070                    03300                                 1088                     1062                    000000000000  A0050010                           0033899108018PBW0 PBW2S

0494270512          0494107021002015082011415520000000540                    03302                     1503                     1503                    000000000000  A0050010                           0033826106714PAC0 PAC2S

 

Sample unrated CDRs for SIP Trunking:-

038422001234        081010251234792011060314221108000000000                      ZHA                                          CXVIE013038422001234                          0000                                        ABC0

038422001234          0517661234792011060314222708000022440                      ZHA                                          CXVIE013038422001234                          0000                                        ABC0

0732388824321          0732771234792011060314261409000013790                      ZHA                                          CXVIE0130732388824321                         0000                                        ABC0

0158031234      00351913231234792011060314323700000000210                      ZHA                                          CXMAD0130158031234                            0000                                        ABC0

 

Sample unrated CDRs for SIP Trunking (CZ, FI, JP, LU, NO, RO & SK):-

 352206099        442033535570792015091610405600      170                                                                                                                 0000                                        ALB0

420296180311        442033535475792015100911120200      550                                                                                                                 0000                                        AAX0

40312200237         40753086507792015070215113800     1480                                                                                                                 0000                                        BKD0

421232335698        390321393652792015092110045300       90                                                                                                                 0000                                        BKE0

 

Sample unrated CDRs for IN for Resellers (Freephone & shared cost):-

0129356xxxx         08003581234002011101923483510000008300                    01001                     3059                         0129356xxxx         0000000000000000000000         01618361234         08003581234ADC0

0773777xxxx         08003581234002011101923455270000068380                    01001                     2702                         0773777xxxx         0000000000000000000000         01618361234         08003581234ADC0

0755747xxxx         08003581234002011101923580620000008090                    01001                     2042                         0755747xxxx         0000000000000000000000         01618361234         08003581234ADC0

 

Sample unrated CDRs for Wholesale SIP:-

0307870098          0230333517082012110610363380000005050                      MIA                 SNCB0103                 CXMIT0130307870098                            0000                                        AJC0

0230333517          0307870098092012110610401400000002570                      MIA                 CXMIT013                 SNCB01010230333517                            0000                                        AJC0

 

Sample unrated CDRs for IN Number Hosting:-

0230329xxx           800909395002012102610530410000000730                    00225                                              10270230329xxx          0000000000000000000010          3483954697         39800909395AJB0

 

Sample unrated CDR for Global IN for reseller (CA, CZ, FI, HK, JP, NO, RO & US):-

004074582xxxx       0040800890020002018032308352100000000240                    00000                                                  004074582xxxx                         0000                  00       0040800890020DMP0

004074582xxxx       0040800890020002018032308394500000000240                    00000                                                  004074582xxxx                         0000                  00       0040800890020DMP0

Every month Colt will deposit a file of rated Call Detail Records (CDR) on the server which provide further details of the total call usage displayed on your Cotl invoice for our Voice, VoIP & IN products.

This will contain all of the CDRs collected by the Colt network since the last monthly file.

Response Schema

string($binary)

Every month Colt will deposit a file of non-usage charges on the server which provide further details of the total transactional charges displayed on your Colt invoice primarily for our Number Hosting service such as number reservation & activation & port-in activation charges.

This will contain all of the non-usage charges collected by the Colt network since the last monthly file.

Response Schema

string($binary)