XC5-XS API documentation

/api-sys/Account

Manage Accounts

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

Name	type	default	description
dump-config	boolean		Output flat dump of account
filter	string	%	A LIKE clause as a filter for GET
horizontal	boolean	false	false: Will show only child accounts, true: Show all descendant accounts

Fields

Name	type	description
guid	string/uniqueidentifier	Unique identifier for this account
username	string	Username used for authorization
password	string	Authorization password.
description	string	Free flow description/notes
enabled	boolean	Activate/Deactivate the account
parent	string	If set, refers to the parent this user is a child of. Users with the same parent have collective virtual PBX features. Users also inherit Location/Registration information, SpeedDials, Extension Dials, Recording, Menus etc of their immediate parent.
parentguid	string/uniqueidentifier	As per parent but optionally accessed uniqueidentifier
pin_reference	boolean	Every call is asked for a call reference for billing purposes. The reference is unvalidated and stored in the CDR
dnd	boolean	Do not disturb. The account will act as if unregistered and proceed to any diversions
private	boolean	Mark all outgoing calls as private. Smart codes can be used to change this setting or override on a per call basis
block_privacy	boolean	Do not allow private calls to this user
callerid	boolean	Present caller detail for calls to this user
cfna_duration	integer	The number of seconds to ring before proceeding to diversions
reg_status	string/read-only	Provides the current registered status
trunking	boolean	Enable SIP trunking. Trunking devices allow an INVITE containing a varying DDI in the request line
concurrent_call_limit	integer	Restricts the maximum number of concurrent calls to/from this user
pickup_group	string	Users can pickup calls from other ringing phones if they share the same pickup group name
pilot	string	The DDI to present on outgoing calls when a user invites with a number outside their set of valid numbers. Use Account/*/Pilot for available pilots
api_user	boolean	Allows this user api access
pin	text/numeric	Manages singular account PIN
moh	string	A SHOUTCast stream for Music on Hold
menu_active	boolean/readonly	Indicates if a menu is active
numbers	[] or [{}]	e164 numbers to assign to this account. Numbers specifies either an array of numbers or and array of objects {"number":"",alert_info:"",account_code:""}. Requires system level access
pins	[] or [{}]	PIN numbers to assign to this account. PINS specifies either an array of PINS or and array of objects {"pin":"1234",pinuser:"user-data"}
child_count	integer/readonly	Identifies number of child accounts

/api-sys/Account/<account>/AllNumbers

View Numbers belonging to this and all descendant accounts

Methods

: [GET,OPTIONS]

Request Parameters

Name	type	default	description
filter	string	%	A LIKE clause to filter for specific numbers

Fields

Name	type	description
guid	string/uniqueidentifier	Uniqueidentifier of the number entry
assigned	string	Username of the account owning the number
number	string	The phone number

/api-sys/Account/<account>/BlockLocations

Lists available locations to use for account blockscope. Taken from LocationName=<CallRule-%>

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
location	string		A location

/api-sys/Account/<account>/BlockScope

Manage prohibited calling destinations

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
location	string		The location to block. Use /api-sys/account/<account>/blocklocations to list available locations

/api-sys/Account/<account>/CallerBlock

Manage prohibited callers

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
caller	string		The e.164 number of prohibited caller
active	boolean		Activate/deactivate this entry

/api-sys/Account/<account>/CallRule

Manage Call rules, extension dialplan, number translations, blocking, PIN features, Speedials etc

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
order	integer	Call rules are applied in sequential order. The lower order rules are processed first
early_rule	boolean	Early rules are processed before smartphone features. An early rule can remap/prohibit smartphone features. Using impersonation can allow the caller to perform smartphone operations on behalf of other users
prefix	string	A pattern to match against the translated dialed number
prefix_raw	string	A pattern to match against the raw dialed number
called_pattern	string	As per prefix, but accepts inversion, I.e. !64%
location	string	Applies this rule if calling to this location. Use api-sys/Account/../Location
bypass_condition	string	Applies this rule if a previous rule has set the bypass value to something matching this condition
bypass_value	string	Sets a bypass value. The bypass value can be tested in subsequent rules using bypass_condition
destination	string	The new number to translate to
username	string	A username to forward this call to
impersonate	string	An optional user to impersonate when this rule applies
pin	string	Control PIN collection. M will require validation against the accounts Multiple PIN table. A specific PIN may also be supplied here.
record_email	string	The call shall be recorded and eMailed to the specified address

/api-sys/Account/<account>/CDR

Extract Account CDR

Methods

: [GET,OPTIONS]

Request Parameters

Name	type	default	description
rows	string	1000	The maximum number of rows to fetch
calldate	datetime	today	The date to fetch CDR from

Fields

Name	type	description
cdrid	integer	Unique cdr identifier
hop_type	string	from_user,diversion. Indicates the reason for this hop
calldate	datetime	Date call was initiated in localtime
caller	string	The E.164 phone number representing this caller
caller_area	string	The calling area determined by access to local numbering plans. I.e. nad.org.nz
caller_private	boolean	This call requested privacy, or privacy was imposed by the system
caller_owning_carrier	string	The callers owning carrier determined by access to local carrier data. I.e. ipms-prod.tcf.org.nz
caller_addr	string	The source IP address this call entered the system from
caller_user	string	The XC5 username of the caller if available
local_user	string	The XC5 entity responsible for this call. This may be the caller, or may be a diverting user
local_accountguid	string	The accountguid of the XC5 entity responsible for this call.
local_number	string	The XC5 entity's number responsible for this call. This may be the diverting number
called	string	The E.164 destination
called_area	string	The called area determined by access to local numbering plans. I.e. nad.org.nz
called_owning_carrier	string	The called numbers owning carrier determined by access to local carrier data. I.e. ipms-prod.tcf.org.nz
called_accountguid	string	The accountguid if available of the XC5 entity called.
called_user	string	The username if available of the XC5 entity called.
duration_setup	integer	The number of seconds elapsed before the call was connected
duration	integer	The number of seconds the call was connected for
error	string	The calls SIP response
reason	string	Verbose error reason
cdr_pin	string	Contains validated or invalidated PIN if a PIN was requested
sessionguid	string	Diagnostic GUID to the paths of this call

/api-sys/Account/<account>/Child

Manage Child Accounts. Supplies ParentGUID to /api-sys/Account. Refer to /api-sys/Account for fields and usage.

Methods

: [GET,PUT,DELETE,OPTIONS]

Request Parameters

: None

Fields

: None

/api-sys/Account/<account>/Fork

Configure secondary destinations to ring. Note the destinations are offnet.

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
destination	string		The e.164 destination to fork the call to
active	boolean		Activate/deactivate this entry

/api-sys/Account/<account>/Graph

Get account graph data

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
type	string	The type of graph
graph	array	Array of sample magnitudes
endts	string	current UTC/epoch timestamp
last	real	The last/most recent sample value

/api-sys/Account/<account>/HoldSource

List configured MOH sources

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
name	string		The name of the feed
url			The URL of a SHOUTCast feed

/api-sys/Account/<account>/Location

Retrieves a subset of locationnames for self management

Methods

: [GET]

Request Parameters

: None

Fields

Name	type	default	description
location	string		The location

/api-sys/Account/<account>/Number

Manage account phone numbers

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
guid	string	Unique identifier for each entry. A PUT by GUID can move a Number (I.e. from Account/*/NumAllocate into a new account
number	string	The e.164 phone number. Numbers must be unique, or prefixed with a: if outgoing rewrite is allowed
is_pilot	boolean	Indicates to use this number a a default for invalid presented caller number
cfa	string	An e.164 destination. Creates a call-forward-all for calls to this number. This number based CFA will take place before any account CFA.
cfa_active	boolean	Enables or disables the call forward all
cfa_prompt	string	A prompt to play on the call forward. Prompts must be loaded onto XS_Nodes. I.e. XC5_BEEP or >XC5_BEEP to play remote tone
alert_info	string	Assigns a value to the sip Alert-Info header for distinctive ring
account_code	string	Free for use associated data

/api-sys/Account/<account>/NumberAllocate

Allocate a number from the _unassigned.pool

Methods

: [GET,OPTIONS]

Request Parameters

Name	type	default	description
filter	string	%	A LIKE clause as a filter for GET

Fields

Name	type	default	description
number	string		A free number to allocate. Use the allocate link

/api-sys/Account/<account>/ParentNumber

Show Numbers owned by the parent account that may be reassigned to this account

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
number	string		A free number to allocate. Use the allocate link

/api-sys/Account/<account>/Pilot

View assignable pilot numbers

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
number	string		Username of the child account
assigned	string		The username the number is currently assigned to

/api-sys/Account/<account>/PIN

Manage Account PINs

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
guid	string	Uniquely identifies this record
pin	string	Numeric PIN code
pinuser	string	Optional associated data
secure	boolean	Defines the PIN as secure PIN, allowing access to the administrative IVR

/api-sys/Account/<account>/PINLocations

Lists available locations to use for account pin rules. Taken from LocationName=<CallRule-%>

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
location	string		A location

/api-sys/Account/<account>/PINScope

Manage destinations that require a PIN

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
location	string		The location. Use /api-sys/account/<account>/pinlocations to list available locations

/api-sys/Account/<account>/Prompt

Manage IVR Prompts

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
description	string	Optional description
group_access	string/read-only	Provides the access number for members of the organization to use to record the prompt for this menu
user_access	string/read-only	Provides the access number for the owning account to record the prompt for this menu
date_recorded	string/read-only	The last date the prompt was recorded or uploaded
recorded	boolean/read-only	Is the prompt recorded
owned	boolean/read-only	True if the prompt is owned by this account
owner	string/read-only	The owner of the prompt
prompt_length	integer	length of recorded data in seconds.
prompt_data	base64	Prompt to upload. Can also use attached .wav or .mp3 in multipart/form-data <input type="file" id="prompt_data">. Will only be returned to client for request with ?format=file

/api-sys/Account/<account>/Reg

View registration status

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
registered_contact_list	string	The registration contact information
expiry_time	datetime	The date of when the registration is due to expire - in localtime
user_agent	string	The user-agent named supplied on registration
when	datetime	The time to registration occured - in localtime
node	string	The node that the registration was made against

/api-sys/Account/<account>/Resource

Auxilary account settings. Note: some of these settings are also controlled through other API calls. These fields are dynamic. Fields may be created or removed in accordance with features and upgrades.

Methods

: [GET,PATCH,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
alarm_asr_min	string	Minimum ASR alarm threshold
alert_info	string	Provides a value in the SIP alert-info header
api_access	string	Grants this user access to the api as System, User (Multi-tenant owner
api_incoming	string	Specifies http url for incoming call notification. Use ${TAN} ${TBN} as placeholders
billing_carrier	string	Specifies the billing carrier for this account
billing_location	string	Specifies the billing location for this account
caller_control	string	asserted,invalid_pan:nnnn,*,forced:nnnn
carrier_lmnp_nad_route_identities	string	Specifies LMNP_HOC, and NAD/TNAS locations for route qualification
codec_policy	string	force:alaw,mulaw - The force prefix forces the following codec list on calls to the user. Native codecs are alaw,mulaw,g729,iLBC. expand:g729 - Expanding will add the codec list to the codecs offered by the caller
concurrent_alarm_limit	string	Specifies threshold of active calls at which alarm is generated
concurrent_call_group	string
concurrent_call_limit	string
default_resolver	string	Indicates the account that will be delegated to in case the dialed number is not within the local system. The default resolver is _route.default.
endpoint_auth_password	string	SIP connect password
endpoint_auth_username	string	SIP connect/send username/auth for 401 from destination
endpoint_bind	string	ysipchan listener to bind to
endpoint_discovery_method	string	Sends an OPTION probe to a non-Infrastructure endpoint addresses. Maintains AccountReg with results
endpoint_domain	string	The domain to present when INVITING to this endpoint
endpoint_in_addr_mask	string	Specifies an IPV4 Mask/CIDR for ingress IP range authentication
endpoint_ip_address	string
endpoint_node	string	For static endpoints, the specifies the hostname that calls to the endpoint must be made from
endpoint_node_group	string	The name of a group used to partition OPTION probes
follow_on_codes	string	SIP codes regular expression to re-route on when calling this user. Defaules to ^[456]
fork_method	string	Default:parallel. When multiple registrations exist, parallel will ring all devices, sequential will ring only one device
fs_data	string	alert-info=tone,no_caller_id,divert_cac,dumpcap,
inherit_account	string	AccountResources, CallRules and AccountRoutes are merged from inherited accounts
invite_queue_size	string	Maximum allowable invites before queuing
ivr_account	string	Indicates the subscribers unique code for ivr management
lawful_intercept	string	format as: <destination>,<liid>
lmnp_destination	string	If the called number is lmnp ported to the named network, the LMNP_IS_DESTN 1 flag will be set for number translation
maintenance_redirect	string	For _node entries, specifies the redirection node of all traffic. OPTIONS will not be responded to
media_latch	string	Sends RTP to received address - autoaddr
media_timeout	string	Default:true. Set to false to deactivate RTP Inactivity detector. USE ONLY FOR DEVICES THAT DO NOT SUPPORT reINVITE
moh	string	Specifies the music on hold for this account
nature_of_address	string
note	string	Internal Comment
pickup_group	string
pin_force_local	string	If a PIN is set, setting pin_force_local will ask for a PIN even on local calls
rate_limits	string	Working data if rate limited
rateplan_o	string	Specifies the rateplan to use for this account
record_local	string
registered_state	string	Indicates active/expired
response_prompt_map	string	Maps final response to prompts for ingress/no media. I.e. 404=XC5_INVALID,403=...
route_criteria	string	The route_criteria value is carried through delegation and can be tested within AccountRoute:RequiredPack to provide an equivalent of class of service routing
ruri_method	string	For sip trunking, setting to called will force the called number into the registered URI
send_privacy_policy	string	Only set trusted for carriers that will not disclose private numbers to the end user, trusted_rpid=Remote-Party-ID, trusted=P-Asserted-ID, trusted_id_only=From+Privacy:id
short_duration_trigger	string
stat_name	string
translation_map	string	Inline Number translation packs for ia_map, ib_map, id_map
trunk_identifier	string	tgrp:xyz or x-nortel-profile:xyz or x-route:xyz to present outgoing trunk

/api-sys/Account/<account>/Route

Applies to calls targeting this account. Manage Diversion, Call forwarding, Caller blocking, IVR Menus, Hunt groups

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
description	string	Optional description
order	integer	Members are attempted in order. Equal orders are load shared. Negative orders are applied before calling the user, positive orders are applied after calling the user. (The user has an implied route at 0)
menu_level	integer	Optional menu this rule belongs to. 1 is the root menu.
caller_private	boolean	Applies this rule if the caller's privacy condition is met
user_registered	boolean	Applies this rule of the user_registered condition is met
caller_location	string	Applies this rule if the caller is from the specified location. Use api-sys/Account/../Location
called_location	string	Applies this rule if the called number is from the specified location. Use api-sys/Account/../Location
caller_number	string	Applies this rule if the call is from the specific caller_number (e.164)
called_number	string	Applies this rule if the call is to the specific called_number (e.164)
time_definition	string	Specify time-of-day rules for when this rule will apply. I.e. business hours can be defined as: !nz_holidays,Mon-Fri 08:30-17:00
response_code	string	Applies if the response_code for the call attempt matches. Note: This rule must be at order greater than 0. Use response_code(486) to implement a call-forward-busy
active	boolean	Activates/deactives this route
hit_weight	int	This weight is added everytime this route is chosen. For routes of the same order, Routes with lower hit counts are attempted first
digit_map	string	A string mapping DTMF or time values to actions. See documentation
promptguid	uniqueidentifier	A recorded prompt identifier from /api-sys/account/.../prompt
prompt_retry_guid	uniqueidentifier	A recorded prompt identifier from /api-sys/account/.../prompt
record_email	string	Specifies an eMail address to forward a call recording
username	string	Divert to another user
ring_seconds	integer	Specifies the number of seconds to attempt calling this destination
hunt_user	boolean	The username will be called if not busy. The routes for the called username will also not apply
queue_size	integer	Specify the maximum number of calls that can flow past this point. Additional calls will be queued and periodically subjected to digit_map
destination	string	An e164 destination or service to divert to

/api-sys/Account/<account>/SpeedDial

Manage Speeddial numbers and number translations

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
prefix	string	A dial pattern to match
destination	string	The new number to translate to
unblock	boolean	Allow calling to a blocked destination
pin	boolean	Force a PIN for this rule
record_email	string	An Email address to record to

/api-sys/CallVerify

Generates a call out the specified Account/Carrier. The call is made from the _service.outdial account. Use for loopback call activation testing

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
caller	string	E.164 formatted calling party number / from
called	string	E.164 formatted called party number /to
account	string	An XC5 account to send the call to
maxtime	integer	Max time is milliseconds to ring destination.. Default 5000ms

/api-sys/CDR

Extract CDR

Methods

: [GET,OPTIONS]

Request Parameters

Name	type	default	description
rows	string	1000	The number of session rows to fetch. Note: each cdrid can contain multiple records. Fetching 1 row can result in multiple records returned
cdrid	integer	0	The cdrid to start fetching rows from. A negative cdrid will seek back from the last cdr. I.e. -100 will return the last 100 records.

Fields

Name	type	description
cdrid	integer	Incrementing identifier for collection. Note: This is not unique. A single call may generate multiple CDR
cdr_hop	string	A diversion may cause a multi-leg call. The hop identifies the call leg within the cdrid
hop_type	string	from_user,diversion. Indicates the reason for this hop
calldate	datetime	Date call was initiated in localtime
calldate_utc	datetime	Date call was initiated in UTC
caller	string	The E.164 phone number representing this caller
caller_display	stirng	The displayed caller name
caller_area	string	The calling area determined by access to local numbering plans. I.e. nad.org.nz
caller_private	boolean	This call requested privacy, or privacy was imposed by the system
caller_owning_carrier	string	The callers owning carrier determined by access to local carrier data. I.e. ipms-prod.tcf.org.nz
caller_addr	string	The source IP address this call entered the system from
caller_user	string	The XC5 username of the caller if available
local_user	string	The XC5 entity responsible for this call. This may be the caller, or may be a diverting user
local_accountguid	string	The accountguid of the XC5 entity responsible for this call.
local_parent_user	string	The parent account of the local_user
local_number	string	The XC5 entity's number responsible for this call. This may be the diverting number
called	string	The E.164 destination
called_area	string	The called area determined by access to local numbering plans. I.e. nad.org.nz
called_owning_carrier	string	The called numbers owning carrier determined by access to local carrier data. I.e. ipms-prod.tcf.org.nz
called_accountguid	string	The accountguid if available of the XC5 entity called.
called_user	string	The username if available of the XC5 entity called.
duration_setup	integer	The number of seconds elapsed before the call was connected
duration	integer	The number of seconds the call was connected for
error	string	The calls SIP response
reason	string	Verbose error reason
cdr_pin	string	Contains validated or invalidated PIN if a PIN was requested
sessionguid	string	Diagnostic GUID to the paths of this call
native_cdrid	integer	The native cdrid of this hop. Note: This is the cdrid used in older versions of cdr extraction
caller_called_nature	string	The On or Off - network status of caller and called respectively. Use this to determine: local (OnOn), transit (OffOff), inbound (OffOn) or outbound(OnOff) call nature
update_reason	string	Contains a reason if the cdr has been manually updated in unforeseen circumstances

/api-sys/CDR_ID

Find the CDRID for a given date

Methods

: [GET,OPTIONS]

Request Parameters

Name	type	default	description
date	date	Supply the date for which the nearest CDRID will be obtained. Note: This is the date of CDR completion for the call session. Associated call legs for the given ID will return their own respective call times

Fields

Name	type	default	description
cdrid	integer		The next CDR identifier from specified date.

/api-sys/CDR_Session

Extract CDR

Methods

: [GET,OPTIONS]

Request Parameters

Name	type	default	description
sessionid	uniqueidentifier		The sessionid to fetch CDR for.

Fields

Name	type	description
cdr_hop	string	A diversion may cause a multi-leg call. The hop identifies the call leg within the cdrid
hop_type	string	from_user,diversion. Indicates the reason for this hop
calldate	datetime	Date call was initiated in localtime
calldate_utc	datetime	Date call was initiated in UTC
caller	string	The E.164 phone number representing this caller
caller_area	string	The calling area determined by access to local numbering plans. I.e. nad.org.nz
caller_private	boolean	This call requested privacy, or privacy was imposed by the system
caller_owning_carrier	string	The callers owning carrier determined by access to local carrier data. I.e. ipms-prod.tcf.org.nz
caller_addr	string	The source IP address this call entered the system from
caller_user	string	The XC5 username of the caller if available
local_user	string	The XC5 entity responsible for this call. This may be the caller, or may be a diverting user
local_accountguid	string	The accountguid of the XC5 entity responsible for this call.
local_number	string	The XC5 entity's number responsible for this call. This may be the diverting number
called	string	The E.164 destination
called_area	string	The called area determined by access to local numbering plans. I.e. nad.org.nz
called_owning_carrier	string	The called numbers owning carrier determined by access to local carrier data. I.e. ipms-prod.tcf.org.nz
called_accountguid	string	The accountguid if available of the XC5 entity called.
called_user	string	The username if available of the XC5 entity called.
duration_setup	integer	The number of seconds elapsed before the call was connected
duration	integer	The number of seconds the call was connected for
error	string	The calls SIP response
reason	string	Verbose error reason
cdr_pin	string	Contains validated or invalidated PIN if a PIN was requested
sessionguid	string	Diagnostic GUID to the paths of this call
native_cdrid	integer	The native cdrid of this hop. Note: This is the cdrid used in older versions of cdr extraction

/api-sys/Graph

Extract Graphs for the specified element

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
element	string	The graph name
display_name	string	A pretty graph name
type	string	The graph type
graph	object	{ .... JSON Formatted Graph Samples}
timestamp_now	integer	The current timestamp
max	integer	If set, contains the known upper limit of the graph. I.e. 100 for percentage graph

/api-sys/GraphDetail

Extract Graphs for the specified element

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
element	string	The graph name
display_name	string	A pretty graph name
type	string	The graph type
graph	object	{ .... JSON Formatted Graph Samples }
timestamp_now	integer	The current timestamp
max	integer	If set, contains the known upper limit of the graph. I.e. 100 for percentage graph

/api-sys/GUID

Get a new GUID

Methods

: [GET,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
guid	string		a new uniqueidentifier

/api-sys/LMNPRoute

Manage LMNP ported table. Note, this is usually imported/overwritten every day.

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

Name	type	default	description
filter	string	%	A t-sql LIKE clause to filter the returned locationnames

Fields

Name	type	description
number	string	The E.164 formatted number, I.e. 64201000007
hoc	string	The new owning carrier HOC. I.e. 011647
carriername	string	The new owning carrier name GC (LMNP network name), I.e. 2DBBAND
networkname	string	The new owning ServiceProvider name from IPMS - SPName / GSP, I.e. Digital Island Local

/api-sys/Location

Manage groups of numbers called 'locations'. These locations are used for routing.

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

Name	type	default	description
filter	string	%	A t-sql LIKE clause to filter the returned locationnames

Fields

Name	type	description
locationname	string	The name of the location / group of numbers
locationtype	integer	Routing can make use of user-defined locationtypes
areacode	string	User data to describe the area this location belongs to

/api-sys/Location/<location>/Code

Manage numbers within a location.

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
locationcode	string		The e.164 number

/api-sys/Number

View Numbers belonging to this and all descendant accounts

Methods

: [GET,OPTIONS]

Request Parameters

Name	type	default	description
filter	string	%	A LIKE clause to filter for specific numbers

Fields

Name	type	description
guid	string/uniqueidentifier	Uniqueidentifier of the number entry
assigned	string	Username of the account owning the number
number	string	The phone number

/api-sys/Org/<org>/Extension

Manage org extension dialplan. The extensions apply to all members of the org

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
prefix	string		A dialed prefix to match. I.e. the extension number.
username	string		The user of this extension

/api-sys/Org/<org>/SpeedDial

Manage org speeddials. The speeddials apply to all members of the org

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	description
prefix	string	A dialed prefix to match. I.e. the speeddial number.
number	string	the new destination number
unblock	boolean	This speeddial can be used to bypass any blocking rules
impersonate	string	A username to impersonate. I.e. this speeddial could enable a smart feature for a different user

/api-sys/ProvisioningHistory

Extract CDR

Methods

: [GET,OPTIONS]

Request Parameters

Name	type	default	description
rows	string	1000	The number of session rows to fetch. Note: each cdrid can contain multiple records. Fetching 1 row can result in multiple records returned
id	integer	0	The id to start fetching rows from. A negative id will seek back from the last history record. I.e. -100 will return the last 100 records.

Fields

Name	type	description
id	integer	Incrementing identifier for collection.
stmt	string	An unformatted raw sql syntax
date	string	Date of action
hostname	string	Source of the request

/api-sys/Query

Perform a dynamic query

Methods

: [GET]

Request Parameters

Name	type	default	description
q	string	User query name

Fields

Name	type	default	description

/api-sys/TimeDefinition

Manage a group of time definitions

Methods

: [GET,PUT,PATCH,DELETE,OPTIONS]

Request Parameters

: None

Fields

Name	type	default	description
description	string		The name of this group of time definitions