TTNC API Functions index

Authenticate with the API in order to perform requests on your account. Returns a SessionId which can be used to authenticate future requests for a period of 30 minutes, primarily used for storing your basket.

Retrieve details of the user account associated with the current API session login.

List all saved cards on the account associated with the current API session. The TokenId can be passed to Order::PlaceOrder in order to pay for items.

Adds a saved card to the account associated with the current API session. Returns a TokenId for use with Order::PlaceOrder.

Retrieve a list of numbers in the account associated with the current API session.

Suspend a number from receiving calls. This will turn the number off on the switch, but keep the number allocated to your account.

Unsuspend a number so that it will return to its previous state.

Removes a specified number from your account. This will prevent the number from receiving calls, and remove any billing commitment from your account associated to this number.

Retrieve configuration data for a specific number.

Retrieve current call rates for the number types found in the account associated with the current API session.

Set up a new destination for the requested number.

Set the duration between destinations for the requested number.

Change or set up the Alias (nickname) of a TTNC number. Use an Alias to quickly identify numbers.

Set up Call Whisper on a particular number.

Turn off Call Whisper on the specified number.

Turn on Call Screening (CLI mode) on the specified number.

Turn off Call Screening (CLI mode) on the specified number.

Turn on Call Screening (Dialled number mode) on the specified number.

Turn off Call Screening (Dialled Number mode) on the specified number.

Turn on Call Greeting on the specified number.

Turn off Call Greeting on the specified number.

Turn on Call Recording on the specified number. This will play a recording disclaimer to the caller, unless a Call Greeting has been set.

Turn off Call Recording on the specified number.

Turn on Dialled Number Presentation on the specified number.

Turn off Dialled Number Presentation on the specified number.

Turn on UK Ringtone on the specified number.

Turn off UK Ringtone on the specified number.

Turn on Forward to All on the specified number.

Turn on Voicemail on the specified number.

Set the Voicemail destination of a number.

Turn on Voicemail on the specified number.

Turn off Voicemail on the specified number.

Turn on Payphone Access on the specified freephone number. This function can only be used on freephone numbers (starting 080). Calls from BT public payphones incur a surcharge. Enabling Payphone access will allow these calls to come in and connect.

Turn off Payphone Access on the specified freephone number. This function can only be used on freephone numbers (starting 080). Calls from BT public payphones incur a surcharge. Disabling Payphone access will prevent these calls from coming in and connecting.

Turn on Missed Call Alert for the specified number.

Turn off Missed Call Alert for the specified number.

Get the current settings for Missed Call Alert for the specified number.

Turn on Call Queuing for the specified number.

Turn off Call Queueing for the specified number.

Add a new Call Blocking rule from a number.

Remove an existing Call Blocking rule from a number.

Get a list of existing Call Blocking rules from a number.

Add a tag to a number for descriptive and filtering purposes.

Remove a specific tag form a number.

Get a list of tags which are on a specific number.

Retrieve the summarised call data totals for number(s) in the account associated with the current API session.

Retrieve call data records for the account associated with the current API session.

Retrieve a single call data record from a CDRUID or CDRRef.

Download CDRs from the API for storage and processing locally.

Search for numbers available to purchase.

Retrieve a list of all available ranges.

How to buy a number.

Used to make a call. Creates two channels and bridges them together. This can be used to present your TTNC number as the CLI on the callee's phone.

Retrieve summarised totals of notifications for the account associated with the current API session.

Adds an item to your basket.

Display items currently in your basket.

Removes a specified item from your basket.

Places an order for the items in the current basket.

Retrieve a list of available system recordings on the account associated to the current API session. These recordings can be used when setting up Call Services which require voice recordings to be played to the caller or receiver.

Download a specified Voicemail message. The voicemails are WAVE audio, Microsoft PCM, 16 bit, mono and 8000 Hz. They are encapsulated XML CDATA and are base64 encoded.

Download a Fax message. The faxes are saved either TIFF or PDF depending on the number configuration. They are encapsulated XML CDATA and are base64 encoded.

Download a Call Recording. The recordings are WAVE audio, Microsoft PCM, 16 bit, mono and 8000 Hz. They are encapsulated XML CDATA and are base64 encoded.

This function enables you to send SMS messages using the TTNC network. You can display any of your TTNC numbers as the sender of the SMS.

This allows you to obtain a list of the myTTNC Applications set up on your account and their associated information.