Search this site

Recent site activity
API‎ > ‎

4 - Commands

The following are the currently available commands within the API. Use of the word 'number' in a command description refers to both non-geographic numbers (NGN) and DDI / DID numbers where the number range supports the feature concerned.
Showing 27 items
TypeUsual sequenceMethodDescription
Sort 
 
Sort 
 
Sort 
 
Sort 
 
Access 1 MYIP To assist with AUTH, returns the customer's IP address as seen by the API. 
Access 2 TIME To assist with AUTH, this returns the system time in a variety of formats. 
Access 3 AUTH Generate a token to allow access, including authorising a remote IP address. 
Access 4 DEAUTH Revoke a token immediately. 
FAX 1 FAXIN Configures a number for FAX receipt (disables voice service) 
FAXSEND 2 FAXSEND Sends a fax. 
Finance 1 BALAS Return individual balance of parent and sub-accounts (if any) 
Finance 1 BALA Return balance of account or net balance if there are sub-accounts.. 
Finance 2 CDR Return call related charge details. 
Finance 3 BNUM Return the b number for a call, i.e. the number that actually received the call where it was forwarded to the PSTN. 
Finance 4 DDR Return SMS related charge details. 
Finance 5 CHARGE Return non-call/SMS related charges such as number rentals. 
Finance 6 SUMMARY Returns a human readable summary of billed traffic (either inbound or outbound) for the current day. Used to an overview or graph generation etc. 
NOC 1 CHANNELS Monitor current or historic channel usage 
Number allocations 1 ALLO Query for available numbers. 
Number allocations 2 INFO Describe a number block returned by the ALLO command. 
Number allocations 3 ACTI 'Buys' a number on your account. 
Number allocations 4 NLIST List numbers assigned to account. 
Number allocations 5 DEAC Permanently delete a number. 
Number routing 1 SMSIN Configure handling of received SMS (Carrier numbers only) 
Number routing 2 VOICEMAIL Create a mailbox for a number or configure voicemail to email options 
Number routing 3 FAXIN Configure a number for FAX service (disables voice service). 
Number routing 3 ROUTE Configure voice handling for a number. 
Regulatory 1 999 Manage 999 address information for a number. 
Regulatory 2 999LIST List numbers with submitted 999 data along with the status of submission. 
SMS 1 SMSIN Configure handling of received SMS (Carrier numbers only) 
SMS 2 SMSSEND Send an SMS. 
Showing 27 items

Sign in|Recent Site Activity|Report Abuse|Print Page|Remove Access|Powered By Google Sites