NTS Telephony Function Reference
Sub-sections
Functions for allocating and deallocating numbers to and from an account.
telecoms.num.browse | fetch a list of sample numbers available for allocation (useful in conjunction with the shopping cart functions in the next section) |
| |
telecoms.num.reservation.list | fetch a list of numbers that you have temporarily reserved but not yet subscribed to (allocated to an account) |
| |
telecoms.num.reserve | put a temporary reservation on a number that is available for use (eg while building the contents of a shopping cart) |
telecoms.num.unreserve | remove the temporary reservation on a number (eg if removing a number from a shopping cart before checking out) |
Functions for creating and managing a shopping cart for buying numbers and adding to your account.
Functions for checking/testing the validity of remote phone numbers
telecoms.num.validate | check whether a phone number is in a valid number range and optionally check whether routing to it as a destination is allowed |
| |
telecoms.ddi.check | check whether a phone number is in service (ie actually belongs to someone) |
| |
telecoms.telecaptcha.create | check whether a phone number is in service and is owned/allocated to a specific person by calling them and exchanging a PIN |
telecoms.num.svcopt.list | List the service packages available on a number or number type |
Manage the routing of your numbers.
telecoms.num.list | list your numbers and where they currently point |
telecoms.num.route | point a number somewhere (to another number, a route plan, a day parting, etc) |
| |
telecoms.num.note.add | add a short note to a number |
| |
telecoms.num.ref.del | delete the ref string for a number |
telecoms.num.ref.set | set a ref string for a number (max 45 chars); the cust ref string can optionally be fetched with the call data |
Manage call hunt groups.
Manage your time of day routing setup.
Manage your IVR menus.
Manage your voicemail mailboxes.
telecoms.voicemail.mailbox.create | create a voicemail mailbox |
telecoms.voicemail.mailbox.delete | delete a mailbox |
telecoms.voicemail.mailbox.edit | edit a mailbox |
telecoms.voicemail.mailbox.list | list your mailboxes |
Manage soundclips for use in in-call features.
Manage in call features such as call recording, whispers, caller announcements etc.
telecoms.facility.attr.del | delete a facility attribute |
telecoms.facility.attr.list | lists attributes applicable to a facility (eg for announcements, an attribute defines which announcement is tied to a number) |
telecoms.facility.attr.set | set a facility attribute |
| |
telecoms.facility.attr.type.list | list facility attribute types |
Manage the facilities available on a number or account; facilies are required for the in-call features to work.
telecoms.facility.cancel | cancel a facility (a facility being mobile routing, day parting, voicemail, etc) |
telecoms.facility.check | checks what facilities are available on a specific number |
telecoms.facility.listall | allows you to list all facility types available |
telecoms.facility.list | lists your facilities |
telecoms.rates.ingress | get ingress rates for calls in to particular number types |
telecoms.rates.egress | get egress rates for a given destination number |
| |
telecoms.location.egress.list | returns a list of different egress types/locations |
| |
telecoms.location.info | get info on a location (eg you give it a number and it tells you it's a french mobile, etc) |
For summarising call patterns, call centre performance etc.
telecoms.calldata.cliprofile.generate | for advanced stats (feature not currrently available via skycom site but the API calls are available) |
| |
telecoms.calldata.cliprofile.selgroup.create | create a selector group for advanced stats |
telecoms.calldata.cliprofile.selgroup.delete | delete a selector group |
telecoms.calldata.cliprofile.selgroup.edit | edit a selector group |
telecoms.calldata.cliprofile.selgroup.get | get the detail of a selector group |
telecoms.calldata.cliprofile.selgroup.list | list your selector group |
Functions for allocating and deallocating numbers to and from an account.
telecoms.num.alloc | add a number to your account or sub-account (will only let you do this if you have your own Ofcom-supplied number ranges registered on our system) |
telecoms.num.dealloc | remove a number from your account or sub-account (will only let you do this if the number you are removing is in one of your own Ofcom-supplied number ranges registered on our system) |
telecoms.num.edit | change how a number is allocated to an account (change package, service type, supported inbound transport types) |
telecoms.num.resume | undo the suspension of a number |
telecoms.num.suspend | suspend a number; this stops a number from working, stops the end user from being able to do anything with it and stops any further standing charges |
Functions for creating and managing a shopping cart for buying numbers and adding to your account.
telecoms.cart.assign | assigns a current un-checked-out shopping cart from your master account to a customer account to allow the checkout process to be completed by the newly signed up customer |