index.html

ApplicationServers

GET /rest/application-servers/

GET information about all ApplicationServers

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'ip': '', 
     'name': ''
 },{
     'id': '', 
     'ip': '', 
     'name': ''
 }]

GET /rest/application-servers/{id}

Get information about ApplicationServers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'ip': '', 
     'name': ''
 }

POST /rest/application-servers/

Create's a new ApplicationServers

Headers

Parameters

Name	Type	Required	Description
ip	varchar	Yes
name	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/applicationservers/{id}

{}

PUT /rest/application-servers/

Table ApplicationServers

Headers

Parameters

Name	Type	Required
id	int	Yes
ip	varchar	Yes
name	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/application-servers/

Table ApplicationServers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

AstMusiconhold

GET /rest/ast-musiconhold/

GET information about all AstMusiconhold

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'mode': '', 
     'directory': '', 
     'application': '', 
     'digit': '', 
     'sort': '', 
     'format': '', 
     'stamp': ''
 },{
     'id': '', 
     'name': '', 
     'mode': '', 
     'directory': '', 
     'application': '', 
     'digit': '', 
     'sort': '', 
     'format': '', 
     'stamp': ''
 }]

GET /rest/ast-musiconhold/{id}

Get information about AstMusiconhold

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'mode': '', 
     'directory': '', 
     'application': '', 
     'digit': '', 
     'sort': '', 
     'format': '', 
     'stamp': ''
 }

POST /rest/ast-musiconhold/

Create's a new AstMusiconhold

Headers

Parameters

Name	Type	Required
name	varchar	Yes
mode	enum('custom','files','mp3nb','quietmp3nb','quietmp3'	No
directory	varchar	No
application	varchar	No
digit	varchar	No
sort	varchar	No
format	varchar	No
stamp	datetime	No

Body

Headers

Response

HTTP 201

Location: /rest/astmusiconhold/{id}

{}

PUT /rest/ast-musiconhold/

Table AstMusiconhold

Headers

Parameters

Name	Type	Required
id	int	Yes
name	varchar	Yes
mode	enum('custom','files','mp3nb','quietmp3nb','quietmp3'	No
directory	varchar	No
application	varchar	No
digit	varchar	No
sort	varchar	No
format	varchar	No
stamp	datetime	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/ast-musiconhold/

Table AstMusiconhold

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

AstPsAors

GET /rest/ast-ps-aors/

GET information about all AstPsAors

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'sorcery_id': '', 
     'default_expiration': '', 
     'max_contacts': '', 
     'minimum_expiration': '', 
     'remove_existing': '', 
     'authenticate_qualify': '', 
     'maximum_expiration': '', 
     'support_path': '', 
     'contact': '', 
     'qualify_frequency': ''
 },{
     'id': '', 
     'sorcery_id': '', 
     'default_expiration': '', 
     'max_contacts': '', 
     'minimum_expiration': '', 
     'remove_existing': '', 
     'authenticate_qualify': '', 
     'maximum_expiration': '', 
     'support_path': '', 
     'contact': '', 
     'qualify_frequency': ''
 }]

GET /rest/ast-ps-aors/{id}

Get information about AstPsAors

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'sorcery_id': '', 
     'default_expiration': '', 
     'max_contacts': '', 
     'minimum_expiration': '', 
     'remove_existing': '', 
     'authenticate_qualify': '', 
     'maximum_expiration': '', 
     'support_path': '', 
     'contact': '', 
     'qualify_frequency': ''
 }

POST /rest/ast-ps-aors/

Create's a new AstPsAors

Headers

Parameters

Name	Type	Required
sorcery_id	varchar	Yes
default_expiration	int	No
max_contacts	int	No
minimum_expiration	int	No
remove_existing	enum('yes','no'	No
authenticate_qualify	enum('yes','no'	No
maximum_expiration	int	No
support_path	enum('yes','no'	No
contact	varchar	No
qualify_frequency	int	No

Body

Headers

Response

HTTP 201

Location: /rest/astpsaors/{id}

{}

PUT /rest/ast-ps-aors/

Table AstPsAors

Headers

Parameters

Name	Type	Required
id	int	Yes
sorcery_id	varchar	Yes
default_expiration	int	No
max_contacts	int	No
minimum_expiration	int	No
remove_existing	enum('yes','no'	No
authenticate_qualify	enum('yes','no'	No
maximum_expiration	int	No
support_path	enum('yes','no'	No
contact	varchar	No
qualify_frequency	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/ast-ps-aors/

Table AstPsAors

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

AstPsEndpoints

GET /rest/ast-ps-endpoints/

GET information about all AstPsEndpoints

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'sorcery_id': '', 
     'from_domain': '', 
     'terminalId': '', 
     'friendId': '', 
     'retailAccountId': '', 
     'aors': '', 
     'callerid': '', 
     'context': '', 
     'disallow': '', 
     'allow': '', 
     'direct_media': '', 
     'direct_media_method': '', 
     'mailboxes': '', 
     'named_pickup_group': '', 
     'send_diversion': '', 
     'send_pai': '', 
     '100rel': '', 
     'outbound_proxy': '', 
     'trust_id_inbound': ''
 },{
     'id': '', 
     'sorcery_id': '', 
     'from_domain': '', 
     'terminalId': '', 
     'friendId': '', 
     'retailAccountId': '', 
     'aors': '', 
     'callerid': '', 
     'context': '', 
     'disallow': '', 
     'allow': '', 
     'direct_media': '', 
     'direct_media_method': '', 
     'mailboxes': '', 
     'named_pickup_group': '', 
     'send_diversion': '', 
     'send_pai': '', 
     '100rel': '', 
     'outbound_proxy': '', 
     'trust_id_inbound': ''
 }]

GET /rest/ast-ps-endpoints/{id}

Get information about AstPsEndpoints

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'sorcery_id': '', 
     'from_domain': '', 
     'terminalId': '', 
     'friendId': '', 
     'retailAccountId': '', 
     'aors': '', 
     'callerid': '', 
     'context': '', 
     'disallow': '', 
     'allow': '', 
     'direct_media': '', 
     'direct_media_method': '', 
     'mailboxes': '', 
     'named_pickup_group': '', 
     'send_diversion': '', 
     'send_pai': '', 
     '100rel': '', 
     'outbound_proxy': '', 
     'trust_id_inbound': ''
 }

POST /rest/ast-ps-endpoints/

Create's a new AstPsEndpoints

Headers

Parameters

Name	Type	Required
sorcery_id	varchar	Yes
from_domain	varchar	No
terminalId	int	No
friendId	int	No
retailAccountId	int	No
aors	varchar	No
callerid	varchar	No
context	varchar	Yes
disallow	varchar	Yes
allow	varchar	Yes
direct_media	enum('yes','no'	No
direct_media_method	enum('invite','reinvite','update'	No
mailboxes	varchar	No
named_pickup_group	varchar	No
send_diversion	enum('yes','no'	No
send_pai	enum('yes','no'	No
100rel	enum('no','required','yes'	Yes
outbound_proxy	varchar	No
trust_id_inbound	enum('yes','no'	No

Body

Headers

Response

HTTP 201

Location: /rest/astpsendpoints/{id}

{}

PUT /rest/ast-ps-endpoints/

Table AstPsEndpoints

Headers

Parameters

Name	Type	Required
id	int	Yes
sorcery_id	varchar	Yes
from_domain	varchar	No
terminalId	int	No
friendId	int	No
retailAccountId	int	No
aors	varchar	No
callerid	varchar	No
context	varchar	Yes
disallow	varchar	Yes
allow	varchar	Yes
direct_media	enum('yes','no'	No
direct_media_method	enum('invite','reinvite','update'	No
mailboxes	varchar	No
named_pickup_group	varchar	No
send_diversion	enum('yes','no'	No
send_pai	enum('yes','no'	No
100rel	enum('no','required','yes'	Yes
outbound_proxy	varchar	No
trust_id_inbound	enum('yes','no'	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/ast-ps-endpoints/

Table AstPsEndpoints

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

AstQueueMembers

GET /rest/ast-queue-members/

GET information about all AstQueueMembers

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'queueId': '', 
     'userId': '', 
     'queue_name': '', 
     'interface': '', 
     'membername': '', 
     'state_interface': '', 
     'penalty': '', 
     'paused': '', 
     'uniqueid': ''
 },{
     'id': '', 
     'queueId': '', 
     'userId': '', 
     'queue_name': '', 
     'interface': '', 
     'membername': '', 
     'state_interface': '', 
     'penalty': '', 
     'paused': '', 
     'uniqueid': ''
 }]

GET /rest/ast-queue-members/{id}

Get information about AstQueueMembers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'queueId': '', 
     'userId': '', 
     'queue_name': '', 
     'interface': '', 
     'membername': '', 
     'state_interface': '', 
     'penalty': '', 
     'paused': '', 
     'uniqueid': ''
 }

POST /rest/ast-queue-members/

Create's a new AstQueueMembers

Headers

Parameters

Name	Type	Required
queueId	int	No
userId	int	No
queue_name	varchar	Yes
interface	varchar	Yes
membername	varchar	No
state_interface	varchar	No
penalty	int	No
paused	int	No
uniqueid	int	No

Body

Headers

Response

HTTP 201

Location: /rest/astqueuemembers/{id}

{}

PUT /rest/ast-queue-members/

Table AstQueueMembers

Headers

Parameters

Name	Type	Required
id	int	Yes
queueId	int	No
userId	int	No
queue_name	varchar	Yes
interface	varchar	Yes
membername	varchar	No
state_interface	varchar	No
penalty	int	No
paused	int	No
uniqueid	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/ast-queue-members/

Table AstQueueMembers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

AstQueues

GET /rest/ast-queues/

GET information about all AstQueues

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'queuename': '', 
     'announce': '', 
     'timeout': '', 
     'autopause': '', 
     'maxlen': '', 
     'strategy': '', 
     'weight': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'queuename': '', 
     'announce': '', 
     'timeout': '', 
     'autopause': '', 
     'maxlen': '', 
     'strategy': '', 
     'weight': ''
 }]

GET /rest/ast-queues/{id}

Get information about AstQueues

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'queuename': '', 
     'announce': '', 
     'timeout': '', 
     'autopause': '', 
     'maxlen': '', 
     'strategy': '', 
     'weight': ''
 }

POST /rest/ast-queues/

Create's a new AstQueues

Headers

Parameters

Name	Type	Required
companyId	int	Yes
name	varchar	No
queuename	varchar	Yes
announce	varchar	No
timeout	int	No
autopause	enum('yes','no','all'	No
maxlen	int	No
strategy	enum('ringall','leastrecent','fewestcalls','random','rrmemory','linear','wrandom','rrordered'	No
weight	int	No

Body

Headers

Response

HTTP 201

Location: /rest/astqueues/{id}

{}

PUT /rest/ast-queues/

Table AstQueues

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
name	varchar	No
queuename	varchar	Yes
announce	varchar	No
timeout	int	No
autopause	enum('yes','no','all'	No
maxlen	int	No
strategy	enum('ringall','leastrecent','fewestcalls','random','rrmemory','linear','wrandom','rrordered'	No
weight	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/ast-queues/

Table AstQueues

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

AstVoicemail

GET /rest/ast-voicemail/

GET information about all AstVoicemail

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'uniqueid': '', 
     'context': '', 
     'mailbox': '', 
     'password': '', 
     'fullname': '', 
     'alias': '', 
     'email': '', 
     'pager': '', 
     'attach': '', 
     'attachfmt': '', 
     'serveremail': '', 
     'language': '', 
     'tz': '', 
     'deleteast_voicemail': '', 
     'saycid': '', 
     'sendast_voicemail': '', 
     'review': '', 
     'tempgreetwarn': '', 
     'operator': '', 
     'envelope': '', 
     'sayduration': '', 
     'forcename': '', 
     'forcegreetings': '', 
     'callback': '', 
     'dialout': '', 
     'exitcontext': '', 
     'maxmsg': '', 
     'volgain': '', 
     'imapuser': '', 
     'imappassword': '', 
     'imapserver': '', 
     'imapport': '', 
     'imapflags': '', 
     'stamp': '', 
     'userId': ''
 },{
     'uniqueid': '', 
     'context': '', 
     'mailbox': '', 
     'password': '', 
     'fullname': '', 
     'alias': '', 
     'email': '', 
     'pager': '', 
     'attach': '', 
     'attachfmt': '', 
     'serveremail': '', 
     'language': '', 
     'tz': '', 
     'deleteast_voicemail': '', 
     'saycid': '', 
     'sendast_voicemail': '', 
     'review': '', 
     'tempgreetwarn': '', 
     'operator': '', 
     'envelope': '', 
     'sayduration': '', 
     'forcename': '', 
     'forcegreetings': '', 
     'callback': '', 
     'dialout': '', 
     'exitcontext': '', 
     'maxmsg': '', 
     'volgain': '', 
     'imapuser': '', 
     'imappassword': '', 
     'imapserver': '', 
     'imapport': '', 
     'imapflags': '', 
     'stamp': '', 
     'userId': ''
 }]

GET /rest/ast-voicemail/{uniqueid}

Get information about AstVoicemail

Headers

Parameters

Name	Type	Required	Description
uniqueid	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'uniqueid': '', 
     'context': '', 
     'mailbox': '', 
     'password': '', 
     'fullname': '', 
     'alias': '', 
     'email': '', 
     'pager': '', 
     'attach': '', 
     'attachfmt': '', 
     'serveremail': '', 
     'language': '', 
     'tz': '', 
     'deleteast_voicemail': '', 
     'saycid': '', 
     'sendast_voicemail': '', 
     'review': '', 
     'tempgreetwarn': '', 
     'operator': '', 
     'envelope': '', 
     'sayduration': '', 
     'forcename': '', 
     'forcegreetings': '', 
     'callback': '', 
     'dialout': '', 
     'exitcontext': '', 
     'maxmsg': '', 
     'volgain': '', 
     'imapuser': '', 
     'imappassword': '', 
     'imapserver': '', 
     'imapport': '', 
     'imapflags': '', 
     'stamp': '', 
     'userId': ''
 }

POST /rest/ast-voicemail/

Create's a new AstVoicemail

Headers

Parameters

Name	Type	Required
context	varchar	Yes
mailbox	varchar	Yes
password	varchar	No
fullname	varchar	No
alias	varchar	No
email	varchar	No
pager	varchar	No
attach	enum('yes','no'	No
attachfmt	varchar	No
serveremail	varchar	No
language	varchar	No
tz	varchar	No
deleteast_voicemail	enum('yes','no'	No
saycid	enum('yes','no'	No
sendast_voicemail	enum('yes','no'	No
review	enum('yes','no'	No
tempgreetwarn	enum('yes','no'	No
operator	enum('yes','no'	No
envelope	enum('yes','no'	No
sayduration	int	No
forcename	enum('yes','no'	No
forcegreetings	enum('yes','no'	No
callback	varchar	No
dialout	varchar	No
exitcontext	varchar	No
maxmsg	int	No
volgain	decimal	No
imapuser	varchar	No
imappassword	varchar	No
imapserver	varchar	No
imapport	varchar	No
imapflags	varchar	No
stamp	datetime	No
userId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/astvoicemail/{uniqueid}

{}

PUT /rest/ast-voicemail/

Table AstVoicemail

Headers

Parameters

Name	Type	Required
uniqueid	int	Yes
context	varchar	Yes
mailbox	varchar	Yes
password	varchar	No
fullname	varchar	No
alias	varchar	No
email	varchar	No
pager	varchar	No
attach	enum('yes','no'	No
attachfmt	varchar	No
serveremail	varchar	No
language	varchar	No
tz	varchar	No
deleteast_voicemail	enum('yes','no'	No
saycid	enum('yes','no'	No
sendast_voicemail	enum('yes','no'	No
review	enum('yes','no'	No
tempgreetwarn	enum('yes','no'	No
operator	enum('yes','no'	No
envelope	enum('yes','no'	No
sayduration	int	No
forcename	enum('yes','no'	No
forcegreetings	enum('yes','no'	No
callback	varchar	No
dialout	varchar	No
exitcontext	varchar	No
maxmsg	int	No
volgain	decimal	No
imapuser	varchar	No
imappassword	varchar	No
imapserver	varchar	No
imapport	varchar	No
imapflags	varchar	No
stamp	datetime	No
userId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/ast-voicemail/

Table AstVoicemail

Headers

Parameters

Name	Type	Required	Description
uniqueid	int	Yes

Body

Headers

Response

HTTP 204

{}

BrandOperators

GET /rest/brand-operators/

GET information about all BrandOperators

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'username': '', 
     'pass': '', 
     'email': '', 
     'active': '', 
     'timezoneId': '', 
     'name': '', 
     'lastname': ''
 },{
     'id': '', 
     'brandId': '', 
     'username': '', 
     'pass': '', 
     'email': '', 
     'active': '', 
     'timezoneId': '', 
     'name': '', 
     'lastname': ''
 }]

GET /rest/brand-operators/{id}

Get information about BrandOperators

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'username': '', 
     'pass': '', 
     'email': '', 
     'active': '', 
     'timezoneId': '', 
     'name': '', 
     'lastname': ''
 }

POST /rest/brand-operators/

Create's a new BrandOperators

Headers

Parameters

Name	Type	Required	Description
brandId	int	Yes
username	varchar	Yes
pass	varchar	Yes	[password]
email	varchar	Yes
active	tinyint	Yes
timezoneId	int	No
name	varchar	No
lastname	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/brandoperators/{id}

{}

PUT /rest/brand-operators/

Table BrandOperators

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
brandId	int	Yes
username	varchar	Yes
pass	varchar	Yes	[password]
email	varchar	Yes
active	tinyint	Yes
timezoneId	int	No
name	varchar	No
lastname	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/brand-operators/

Table BrandOperators

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

BrandServices

GET /rest/brand-services/

GET information about all BrandServices

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'serviceId': '', 
     'brandId': '', 
     'code': ''
 },{
     'id': '', 
     'serviceId': '', 
     'brandId': '', 
     'code': ''
 }]

GET /rest/brand-services/{id}

Get information about BrandServices

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'serviceId': '', 
     'brandId': '', 
     'code': ''
 }

POST /rest/brand-services/

Create's a new BrandServices

Headers

Parameters

Name	Type	Required
serviceId	int	Yes
brandId	int	Yes
code	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/brandservices/{id}

{}

PUT /rest/brand-services/

Table BrandServices

Headers

Parameters

Name	Type	Required
id	int	Yes
serviceId	int	Yes
brandId	int	Yes
code	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/brand-services/

Table BrandServices

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

BrandURLs

GET /rest/brand-u-r-ls/

GET information about all BrandURLs

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'url': '', 
     'klearTheme': '', 
     'urlType': '', 
     'name': '', 
     'logo': '', 
     'userTheme': ''
 },{
     'id': '', 
     'brandId': '', 
     'url': '', 
     'klearTheme': '', 
     'urlType': '', 
     'name': '', 
     'logo': '', 
     'userTheme': ''
 }]

GET /rest/brand-u-r-ls/{id}

Get information about BrandURLs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'url': '', 
     'klearTheme': '', 
     'urlType': '', 
     'name': '', 
     'logo': '', 
     'userTheme': ''
 }

POST /rest/brand-u-r-ls/

Create's a new BrandURLs

Headers

Parameters

Name	Type	Required	Description
brandId	int	Yes
url	varchar	Yes
klearTheme	varchar	No
urlType	varchar	Yes	[enum:god\|brand\|admin\|user]
name	varchar	No
logo	int	No	[FSO]
userTheme	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/brandurls/{id}

{}

PUT /rest/brand-u-r-ls/

Table BrandURLs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
brandId	int	Yes
url	varchar	Yes
klearTheme	varchar	No
urlType	varchar	Yes	[enum:god\|brand\|admin\|user]
name	varchar	No
logo	int	No	[FSO]
userTheme	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/brand-u-r-ls/

Table BrandURLs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Brands

GET /rest/brands/

GET information about all Brands

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'nif': '', 
     'domain_users': '', 
     'defaultTimezoneId': '', 
     'logo': '', 
     'postalAddress': '', 
     'postalCode': '', 
     'town': '', 
     'province': '', 
     'country': '', 
     'registryData': '', 
     'languageId': '', 
     'FromName': '', 
     'FromAddress': '', 
     'recordingsLimitMB': '', 
     'recordingsLimitEmail': ''
 },{
     'id': '', 
     'name': '', 
     'nif': '', 
     'domain_users': '', 
     'defaultTimezoneId': '', 
     'logo': '', 
     'postalAddress': '', 
     'postalCode': '', 
     'town': '', 
     'province': '', 
     'country': '', 
     'registryData': '', 
     'languageId': '', 
     'FromName': '', 
     'FromAddress': '', 
     'recordingsLimitMB': '', 
     'recordingsLimitEmail': ''
 }]

GET /rest/brands/{id}

Get information about Brands

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'nif': '', 
     'domain_users': '', 
     'defaultTimezoneId': '', 
     'logo': '', 
     'postalAddress': '', 
     'postalCode': '', 
     'town': '', 
     'province': '', 
     'country': '', 
     'registryData': '', 
     'languageId': '', 
     'FromName': '', 
     'FromAddress': '', 
     'recordingsLimitMB': '', 
     'recordingsLimitEmail': ''
 }

POST /rest/brands/

Create's a new Brands

Headers

Parameters

Name	Type	Required	Description
name	varchar	Yes
nif	varchar	Yes
domain_users	varchar	No
defaultTimezoneId	int	No
logo	int	No	[FSO]
postalAddress	varchar	Yes
postalCode	varchar	Yes
town	varchar	Yes
province	varchar	Yes
country	varchar	Yes
registryData	varchar	No
languageId	int	No
FromName	varchar	No
FromAddress	varchar	No
recordingsLimitMB	int	No
recordingsLimitEmail	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/brands/{id}

{}

PUT /rest/brands/

Table Brands

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
name	varchar	Yes
nif	varchar	Yes
domain_users	varchar	No
defaultTimezoneId	int	No
logo	int	No	[FSO]
postalAddress	varchar	Yes
postalCode	varchar	Yes
town	varchar	Yes
province	varchar	Yes
country	varchar	Yes
registryData	varchar	No
languageId	int	No
FromName	varchar	No
FromAddress	varchar	No
recordingsLimitMB	int	No
recordingsLimitEmail	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/brands/

Table Brands

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Calendars

GET /rest/calendars/

GET information about all Calendars

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': ''
 }]

GET /rest/calendars/{id}

Get information about Calendars

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': ''
 }

POST /rest/calendars/

Create's a new Calendars

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/calendars/{id}

{}

PUT /rest/calendars/

Table Calendars

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
name	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/calendars/

Table Calendars

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

CallACL

GET /rest/call-a-c-l/

GET information about all CallACL

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'defaultPolicy': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'defaultPolicy': ''
 }]

GET /rest/call-a-c-l/{id}

Get information about CallACL

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'defaultPolicy': ''
 }

POST /rest/call-a-c-l/

Create's a new CallACL

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
defaultPolicy	varchar	Yes	[enum:allow\|deny]

Body

Headers

Response

HTTP 201

Location: /rest/callacl/{id}

{}

PUT /rest/call-a-c-l/

Table CallACL

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
defaultPolicy	varchar	Yes	[enum:allow\|deny]

Body

Headers

Response

HTTP 200

{}

DELETE /rest/call-a-c-l/

Table CallACL

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

CallACLPatterns

GET /rest/call-a-c-l-patterns/

GET information about all CallACLPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'regExp': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'regExp': ''
 }]

GET /rest/call-a-c-l-patterns/{id}

Get information about CallACLPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'regExp': ''
 }

POST /rest/call-a-c-l-patterns/

Create's a new CallACLPatterns

Headers

Parameters

Name	Type	Required
companyId	int	Yes
name	varchar	Yes
regExp	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/callaclpatterns/{id}

{}

PUT /rest/call-a-c-l-patterns/

Table CallACLPatterns

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
name	varchar	Yes
regExp	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/call-a-c-l-patterns/

Table CallACLPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

CallACLRelPatterns

GET /rest/call-a-c-l-rel-patterns/

GET information about all CallACLRelPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'CallACLId': '', 
     'CallACLPatternId': '', 
     'priority': '', 
     'policy': ''
 },{
     'id': '', 
     'CallACLId': '', 
     'CallACLPatternId': '', 
     'priority': '', 
     'policy': ''
 }]

GET /rest/call-a-c-l-rel-patterns/{id}

Get information about CallACLRelPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'CallACLId': '', 
     'CallACLPatternId': '', 
     'priority': '', 
     'policy': ''
 }

POST /rest/call-a-c-l-rel-patterns/

Create's a new CallACLRelPatterns

Headers

Parameters

Name	Type	Required	Description
CallACLId	int	Yes
CallACLPatternId	int	Yes
priority	smallint	Yes
policy	varchar	Yes	[enum:allow\|deny]

Body

Headers

Response

HTTP 201

Location: /rest/callaclrelpatterns/{id}

{}

PUT /rest/call-a-c-l-rel-patterns/

Table CallACLRelPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
CallACLId	int	Yes
CallACLPatternId	int	Yes
priority	smallint	Yes
policy	varchar	Yes	[enum:allow\|deny]

Body

Headers

Response

HTTP 200

{}

DELETE /rest/call-a-c-l-rel-patterns/

Table CallACLRelPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

CallForwardSettings

GET /rest/call-forward-settings/

GET information about all CallForwardSettings

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'userId': '', 
     'callTypeFilter': '', 
     'callForwardType': '', 
     'targetType': '', 
     'numberValue': '', 
     'extensionId': '', 
     'voiceMailUserId': '', 
     'noAnswerTimeout': ''
 },{
     'id': '', 
     'userId': '', 
     'callTypeFilter': '', 
     'callForwardType': '', 
     'targetType': '', 
     'numberValue': '', 
     'extensionId': '', 
     'voiceMailUserId': '', 
     'noAnswerTimeout': ''
 }]

GET /rest/call-forward-settings/{id}

Get information about CallForwardSettings

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'userId': '', 
     'callTypeFilter': '', 
     'callForwardType': '', 
     'targetType': '', 
     'numberValue': '', 
     'extensionId': '', 
     'voiceMailUserId': '', 
     'noAnswerTimeout': ''
 }

POST /rest/call-forward-settings/

Create's a new CallForwardSettings

Headers

Parameters

Name	Type	Required	Description
userId	int	Yes
callTypeFilter	varchar	Yes	[enum:internal\|external\|both]
callForwardType	varchar	Yes	[enum:inconditional\|noAnswer\|busy\|userNotRegistered]
targetType	varchar	Yes	[enum:number\|extension\|voicemail]
numberValue	varchar	No
extensionId	int	No
voiceMailUserId	int	No
noAnswerTimeout	smallint	Yes

Body

Headers

Response

HTTP 201

Location: /rest/callforwardsettings/{id}

{}

PUT /rest/call-forward-settings/

Table CallForwardSettings

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
userId	int	Yes
callTypeFilter	varchar	Yes	[enum:internal\|external\|both]
callForwardType	varchar	Yes	[enum:inconditional\|noAnswer\|busy\|userNotRegistered]
targetType	varchar	Yes	[enum:number\|extension\|voicemail]
numberValue	varchar	No
extensionId	int	No
voiceMailUserId	int	No
noAnswerTimeout	smallint	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/call-forward-settings/

Table CallForwardSettings

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Companies

GET /rest/companies/

GET information about all Companies

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'type': '', 
     'name': '', 
     'domain_users': '', 
     'nif': '', 
     'defaultTimezoneId': '', 
     'distributeMethod': '', 
     'applicationServerId': '', 
     'externalMaxCalls': '', 
     'postalAddress': '', 
     'postalCode': '', 
     'town': '', 
     'province': '', 
     'country': '', 
     'outbound_prefix': '', 
     'countryId': '', 
     'languageId': '', 
     'mediaRelaySetsId': '', 
     'ipFilter': '', 
     'onDemandRecord': '', 
     'onDemandRecordCode': '', 
     'areaCode': '', 
     'externallyExtraOpts': '', 
     'recordingsLimitMB': '', 
     'recordingsLimitEmail': '', 
     'outgoingDDIId': '', 
     'outgoingDDIRuleId': ''
 },{
     'id': '', 
     'brandId': '', 
     'type': '', 
     'name': '', 
     'domain_users': '', 
     'nif': '', 
     'defaultTimezoneId': '', 
     'distributeMethod': '', 
     'applicationServerId': '', 
     'externalMaxCalls': '', 
     'postalAddress': '', 
     'postalCode': '', 
     'town': '', 
     'province': '', 
     'country': '', 
     'outbound_prefix': '', 
     'countryId': '', 
     'languageId': '', 
     'mediaRelaySetsId': '', 
     'ipFilter': '', 
     'onDemandRecord': '', 
     'onDemandRecordCode': '', 
     'areaCode': '', 
     'externallyExtraOpts': '', 
     'recordingsLimitMB': '', 
     'recordingsLimitEmail': '', 
     'outgoingDDIId': '', 
     'outgoingDDIRuleId': ''
 }]

GET /rest/companies/{id}

Get information about Companies

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'type': '', 
     'name': '', 
     'domain_users': '', 
     'nif': '', 
     'defaultTimezoneId': '', 
     'distributeMethod': '', 
     'applicationServerId': '', 
     'externalMaxCalls': '', 
     'postalAddress': '', 
     'postalCode': '', 
     'town': '', 
     'province': '', 
     'country': '', 
     'outbound_prefix': '', 
     'countryId': '', 
     'languageId': '', 
     'mediaRelaySetsId': '', 
     'ipFilter': '', 
     'onDemandRecord': '', 
     'onDemandRecordCode': '', 
     'areaCode': '', 
     'externallyExtraOpts': '', 
     'recordingsLimitMB': '', 
     'recordingsLimitEmail': '', 
     'outgoingDDIId': '', 
     'outgoingDDIRuleId': ''
 }

POST /rest/companies/

Create's a new Companies

Headers

Parameters

Name	Type	Required	Description
brandId	int	Yes
type	varchar	Yes	[enum:vpbx\|retail]
name	varchar	Yes
domain_users	varchar	No
nif	varchar	Yes
defaultTimezoneId	int	No
distributeMethod	varchar	Yes	[enum:static\|rr\|hash]
applicationServerId	int	No
externalMaxCalls	int	Yes
postalAddress	varchar	Yes
postalCode	varchar	Yes
town	varchar	Yes
province	varchar	Yes
country	varchar	Yes
outbound_prefix	varchar	No
countryId	int	No
languageId	int	No
mediaRelaySetsId	int	No
ipFilter	tinyint	No
onDemandRecord	tinyint	No
onDemandRecordCode	varchar	No
areaCode	varchar	No
externallyExtraOpts	text	No
recordingsLimitMB	int	No
recordingsLimitEmail	varchar	No
outgoingDDIId	int	No
outgoingDDIRuleId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/companies/{id}

{}

PUT /rest/companies/

Table Companies

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
brandId	int	Yes
type	varchar	Yes	[enum:vpbx\|retail]
name	varchar	Yes
domain_users	varchar	No
nif	varchar	Yes
defaultTimezoneId	int	No
distributeMethod	varchar	Yes	[enum:static\|rr\|hash]
applicationServerId	int	No
externalMaxCalls	int	Yes
postalAddress	varchar	Yes
postalCode	varchar	Yes
town	varchar	Yes
province	varchar	Yes
country	varchar	Yes
outbound_prefix	varchar	No
countryId	int	No
languageId	int	No
mediaRelaySetsId	int	No
ipFilter	tinyint	No
onDemandRecord	tinyint	No
onDemandRecordCode	varchar	No
areaCode	varchar	No
externallyExtraOpts	text	No
recordingsLimitMB	int	No
recordingsLimitEmail	varchar	No
outgoingDDIId	int	No
outgoingDDIRuleId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/companies/

Table Companies

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

CompanyAdmins

GET /rest/company-admins/

GET information about all CompanyAdmins

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'username': '', 
     'pass': '', 
     'email': '', 
     'active': '', 
     'timezoneId': '', 
     'name': '', 
     'lastname': ''
 },{
     'id': '', 
     'companyId': '', 
     'username': '', 
     'pass': '', 
     'email': '', 
     'active': '', 
     'timezoneId': '', 
     'name': '', 
     'lastname': ''
 }]

GET /rest/company-admins/{id}

Get information about CompanyAdmins

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'username': '', 
     'pass': '', 
     'email': '', 
     'active': '', 
     'timezoneId': '', 
     'name': '', 
     'lastname': ''
 }

POST /rest/company-admins/

Create's a new CompanyAdmins

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
username	varchar	Yes
pass	varchar	Yes	[password]
email	varchar	Yes
active	tinyint	Yes
timezoneId	int	No
name	varchar	No
lastname	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/companyadmins/{id}

{}

PUT /rest/company-admins/

Table CompanyAdmins

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
username	varchar	Yes
pass	varchar	Yes	[password]
email	varchar	Yes
active	tinyint	Yes
timezoneId	int	No
name	varchar	No
lastname	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/company-admins/

Table CompanyAdmins

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

CompanyServices

GET /rest/company-services/

GET information about all CompanyServices

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'serviceId': '', 
     'companyId': '', 
     'code': ''
 },{
     'id': '', 
     'serviceId': '', 
     'companyId': '', 
     'code': ''
 }]

GET /rest/company-services/{id}

Get information about CompanyServices

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'serviceId': '', 
     'companyId': '', 
     'code': ''
 }

POST /rest/company-services/

Create's a new CompanyServices

Headers

Parameters

Name	Type	Required
serviceId	int	Yes
companyId	int	Yes
code	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/companyservices/{id}

{}

PUT /rest/company-services/

Table CompanyServices

Headers

Parameters

Name	Type	Required
id	int	Yes
serviceId	int	Yes
companyId	int	Yes
code	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/company-services/

Table CompanyServices

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ConditionalRoutesConditions

GET /rest/conditional-routes-conditions/

GET information about all ConditionalRoutesConditions

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'conditionalRouteId': '', 
     'priority': '', 
     'locutionId': '', 
     'routeType': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'voiceMailUserId': '', 
     'userId': '', 
     'numberValue': '', 
     'friendValue': '', 
     'queueId': '', 
     'conferenceRoomId': '', 
     'extensionId': ''
 },{
     'id': '', 
     'conditionalRouteId': '', 
     'priority': '', 
     'locutionId': '', 
     'routeType': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'voiceMailUserId': '', 
     'userId': '', 
     'numberValue': '', 
     'friendValue': '', 
     'queueId': '', 
     'conferenceRoomId': '', 
     'extensionId': ''
 }]

GET /rest/conditional-routes-conditions/{id}

Get information about ConditionalRoutesConditions

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'conditionalRouteId': '', 
     'priority': '', 
     'locutionId': '', 
     'routeType': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'voiceMailUserId': '', 
     'userId': '', 
     'numberValue': '', 
     'friendValue': '', 
     'queueId': '', 
     'conferenceRoomId': '', 
     'extensionId': ''
 }

POST /rest/conditional-routes-conditions/

Create's a new ConditionalRoutesConditions

Headers

Parameters

Name	Type	Required	Description
conditionalRouteId	int	Yes
priority	smallint	Yes
locutionId	int	No
routeType	varchar	No	[enum:user\|number\|IVRCommon\|IVRCustom\|huntGroup\|voicemail\|friend\|queue\|conferenceRoom\|extension]
IVRCommonId	int	No
IVRCustomId	int	No
huntGroupId	int	No
voiceMailUserId	int	No
userId	int	No
numberValue	varchar	No
friendValue	varchar	No
queueId	int	No
conferenceRoomId	int	No
extensionId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/conditionalroutesconditions/{id}

{}

PUT /rest/conditional-routes-conditions/

Table ConditionalRoutesConditions

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
conditionalRouteId	int	Yes
priority	smallint	Yes
locutionId	int	No
routeType	varchar	No	[enum:user\|number\|IVRCommon\|IVRCustom\|huntGroup\|voicemail\|friend\|queue\|conferenceRoom\|extension]
IVRCommonId	int	No
IVRCustomId	int	No
huntGroupId	int	No
voiceMailUserId	int	No
userId	int	No
numberValue	varchar	No
friendValue	varchar	No
queueId	int	No
conferenceRoomId	int	No
extensionId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/conditional-routes-conditions/

Table ConditionalRoutesConditions

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ConditionalRoutesConditionsRelCalendars

GET /rest/conditional-routes-conditions-rel-calendars/

GET information about all ConditionalRoutesConditionsRelCalendars

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'conditionId': '', 
     'calendarId': ''
 },{
     'id': '', 
     'conditionId': '', 
     'calendarId': ''
 }]

GET /rest/conditional-routes-conditions-rel-calendars/{id}

Get information about ConditionalRoutesConditionsRelCalendars

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'conditionId': '', 
     'calendarId': ''
 }

POST /rest/conditional-routes-conditions-rel-calendars/

Create's a new ConditionalRoutesConditionsRelCalendars

Headers

Parameters

Name	Type	Required	Description
conditionId	int	Yes
calendarId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/conditionalroutesconditionsrelcalendars/{id}

{}

PUT /rest/conditional-routes-conditions-rel-calendars/

Table ConditionalRoutesConditionsRelCalendars

Headers

Parameters

Name	Type	Required
id	int	Yes
conditionId	int	Yes
calendarId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/conditional-routes-conditions-rel-calendars/

Table ConditionalRoutesConditionsRelCalendars

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ConditionalRoutesConditionsRelMatchLists

GET /rest/conditional-routes-conditions-rel-match-lists/

GET information about all ConditionalRoutesConditionsRelMatchLists

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'conditionId': '', 
     'matchListId': ''
 },{
     'id': '', 
     'conditionId': '', 
     'matchListId': ''
 }]

GET /rest/conditional-routes-conditions-rel-match-lists/{id}

Get information about ConditionalRoutesConditionsRelMatchLists

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'conditionId': '', 
     'matchListId': ''
 }

POST /rest/conditional-routes-conditions-rel-match-lists/

Create's a new ConditionalRoutesConditionsRelMatchLists

Headers

Parameters

Name	Type	Required	Description
conditionId	int	Yes
matchListId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/conditionalroutesconditionsrelmatchlists/{id}

{}

PUT /rest/conditional-routes-conditions-rel-match-lists/

Table ConditionalRoutesConditionsRelMatchLists

Headers

Parameters

Name	Type	Required
id	int	Yes
conditionId	int	Yes
matchListId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/conditional-routes-conditions-rel-match-lists/

Table ConditionalRoutesConditionsRelMatchLists

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ConditionalRoutesConditionsRelRouteLocks

GET /rest/conditional-routes-conditions-rel-route-locks/

GET information about all ConditionalRoutesConditionsRelRouteLocks

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'conditionId': '', 
     'routeLockId': ''
 },{
     'id': '', 
     'conditionId': '', 
     'routeLockId': ''
 }]

GET /rest/conditional-routes-conditions-rel-route-locks/{id}

Get information about ConditionalRoutesConditionsRelRouteLocks

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'conditionId': '', 
     'routeLockId': ''
 }

POST /rest/conditional-routes-conditions-rel-route-locks/

Create's a new ConditionalRoutesConditionsRelRouteLocks

Headers

Parameters

Name	Type	Required	Description
conditionId	int	Yes
routeLockId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/conditionalroutesconditionsrelroutelocks/{id}

{}

PUT /rest/conditional-routes-conditions-rel-route-locks/

Table ConditionalRoutesConditionsRelRouteLocks

Headers

Parameters

Name	Type	Required
id	int	Yes
conditionId	int	Yes
routeLockId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/conditional-routes-conditions-rel-route-locks/

Table ConditionalRoutesConditionsRelRouteLocks

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ConditionalRoutesConditionsRelSchedules

GET /rest/conditional-routes-conditions-rel-schedules/

GET information about all ConditionalRoutesConditionsRelSchedules

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'conditionId': '', 
     'scheduleId': ''
 },{
     'id': '', 
     'conditionId': '', 
     'scheduleId': ''
 }]

GET /rest/conditional-routes-conditions-rel-schedules/{id}

Get information about ConditionalRoutesConditionsRelSchedules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'conditionId': '', 
     'scheduleId': ''
 }

POST /rest/conditional-routes-conditions-rel-schedules/

Create's a new ConditionalRoutesConditionsRelSchedules

Headers

Parameters

Name	Type	Required	Description
conditionId	int	Yes
scheduleId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/conditionalroutesconditionsrelschedules/{id}

{}

PUT /rest/conditional-routes-conditions-rel-schedules/

Table ConditionalRoutesConditionsRelSchedules

Headers

Parameters

Name	Type	Required
id	int	Yes
conditionId	int	Yes
scheduleId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/conditional-routes-conditions-rel-schedules/

Table ConditionalRoutesConditionsRelSchedules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ConditionalRoutes

GET /rest/conditional-routes/

GET information about all ConditionalRoutes

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'locutionId': '', 
     'routeType': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'voiceMailUserId': '', 
     'userId': '', 
     'numberValue': '', 
     'friendValue': '', 
     'queueId': '', 
     'conferenceRoomId': '', 
     'extensionId': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'locutionId': '', 
     'routeType': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'voiceMailUserId': '', 
     'userId': '', 
     'numberValue': '', 
     'friendValue': '', 
     'queueId': '', 
     'conferenceRoomId': '', 
     'extensionId': ''
 }]

GET /rest/conditional-routes/{id}

Get information about ConditionalRoutes

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'locutionId': '', 
     'routeType': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'voiceMailUserId': '', 
     'userId': '', 
     'numberValue': '', 
     'friendValue': '', 
     'queueId': '', 
     'conferenceRoomId': '', 
     'extensionId': ''
 }

POST /rest/conditional-routes/

Create's a new ConditionalRoutes

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
locutionId	int	No
routeType	varchar	No	[enum:user\|number\|IVRCommon\|IVRCustom\|huntGroup\|voicemail\|friend\|queue\|conferenceRoom\|extension]
IVRCommonId	int	No
IVRCustomId	int	No
huntGroupId	int	No
voiceMailUserId	int	No
userId	int	No
numberValue	varchar	No
friendValue	varchar	No
queueId	int	No
conferenceRoomId	int	No
extensionId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/conditionalroutes/{id}

{}

PUT /rest/conditional-routes/

Table ConditionalRoutes

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
locutionId	int	No
routeType	varchar	No	[enum:user\|number\|IVRCommon\|IVRCustom\|huntGroup\|voicemail\|friend\|queue\|conferenceRoom\|extension]
IVRCommonId	int	No
IVRCustomId	int	No
huntGroupId	int	No
voiceMailUserId	int	No
userId	int	No
numberValue	varchar	No
friendValue	varchar	No
queueId	int	No
conferenceRoomId	int	No
extensionId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/conditional-routes/

Table ConditionalRoutes

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ConferenceRooms

GET /rest/conference-rooms/

GET information about all ConferenceRooms

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'pinProtected': '', 
     'pinCode': '', 
     'maxMembers': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'pinProtected': '', 
     'pinCode': '', 
     'maxMembers': ''
 }]

GET /rest/conference-rooms/{id}

Get information about ConferenceRooms

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'pinProtected': '', 
     'pinCode': '', 
     'maxMembers': ''
 }

POST /rest/conference-rooms/

Create's a new ConferenceRooms

Headers

Parameters

Name	Type	Required
companyId	int	Yes
name	varchar	Yes
pinProtected	tinyint	Yes
pinCode	varchar	No
maxMembers	tinyint	Yes

Body

Headers

Response

HTTP 201

Location: /rest/conferencerooms/{id}

{}

PUT /rest/conference-rooms/

Table ConferenceRooms

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
name	varchar	Yes
pinProtected	tinyint	Yes
pinCode	varchar	No
maxMembers	tinyint	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/conference-rooms/

Table ConferenceRooms

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Countries

GET /rest/countries/

GET information about all Countries

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'code': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'zone': '', 
     'zone_en': '', 
     'zone_es': '', 
     'calling_code': '', 
     'intCode': '', 
     'e164Pattern': '', 
     'nationalCC': ''
 },{
     'id': '', 
     'code': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'zone': '', 
     'zone_en': '', 
     'zone_es': '', 
     'calling_code': '', 
     'intCode': '', 
     'e164Pattern': '', 
     'nationalCC': ''
 }]

GET /rest/countries/{id}

Get information about Countries

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'code': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'zone': '', 
     'zone_en': '', 
     'zone_es': '', 
     'calling_code': '', 
     'intCode': '', 
     'e164Pattern': '', 
     'nationalCC': ''
 }

POST /rest/countries/

Create's a new Countries

Headers

Parameters

Name	Type	Required	Description
code	varchar	Yes
name	varchar	No	[ml]
name_en	varchar	No
name_es	varchar	No
zone	varchar	No	[ml]
zone_en	varchar	Yes
zone_es	varchar	Yes
calling_code	int	No
intCode	varchar	No
e164Pattern	varchar	No
nationalCC	tinyint	Yes

Body

Headers

Response

HTTP 201

Location: /rest/countries/{id}

{}

PUT /rest/countries/

Table Countries

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
code	varchar	Yes
name	varchar	No	[ml]
name_en	varchar	No
name_es	varchar	No
zone	varchar	No	[ml]
zone_en	varchar	Yes
zone_es	varchar	Yes
calling_code	int	No
intCode	varchar	No
e164Pattern	varchar	No
nationalCC	tinyint	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/countries/

Table Countries

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

DDIs

GET /rest/d-d-is/

GET information about all DDIs

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'companyId': '', 
     'DDI': '', 
     'DDIE164': '', 
     'externalCallFilterId': '', 
     'recordCalls': '', 
     'displayName': '', 
     'routeType': '', 
     'userId': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'faxId': '', 
     'conferenceRoomId': '', 
     'retailAccountId': '', 
     'peeringContractId': '', 
     'countryId': '', 
     'billInboundCalls': '', 
     'friendValue': '', 
     'languageId': '', 
     'queueId': '', 
     'conditionalRouteId': ''
 },{
     'id': '', 
     'brandId': '', 
     'companyId': '', 
     'DDI': '', 
     'DDIE164': '', 
     'externalCallFilterId': '', 
     'recordCalls': '', 
     'displayName': '', 
     'routeType': '', 
     'userId': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'faxId': '', 
     'conferenceRoomId': '', 
     'retailAccountId': '', 
     'peeringContractId': '', 
     'countryId': '', 
     'billInboundCalls': '', 
     'friendValue': '', 
     'languageId': '', 
     'queueId': '', 
     'conditionalRouteId': ''
 }]

GET /rest/d-d-is/{id}

Get information about DDIs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'companyId': '', 
     'DDI': '', 
     'DDIE164': '', 
     'externalCallFilterId': '', 
     'recordCalls': '', 
     'displayName': '', 
     'routeType': '', 
     'userId': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'faxId': '', 
     'conferenceRoomId': '', 
     'retailAccountId': '', 
     'peeringContractId': '', 
     'countryId': '', 
     'billInboundCalls': '', 
     'friendValue': '', 
     'languageId': '', 
     'queueId': '', 
     'conditionalRouteId': ''
 }

POST /rest/d-d-is/

Create's a new DDIs

Headers

Parameters

Name	Type	Required	Description
brandId	int	Yes
companyId	int	Yes
DDI	varchar	Yes
DDIE164	varchar	No
externalCallFilterId	int	No
recordCalls	varchar	Yes	[enum:none\|all\|inbound\|outbound]
displayName	varchar	No
routeType	varchar	No	[enum:user\|IVRCommon\|IVRCustom\|huntGroup\|fax\|conferenceRoom\|friend\|queue\|retailAccount\|conditional]
userId	int	No
IVRCommonId	int	No
IVRCustomId	int	No
huntGroupId	int	No
faxId	int	No
conferenceRoomId	int	No
retailAccountId	int	No
peeringContractId	int	No
countryId	int	No
billInboundCalls	tinyint	Yes
friendValue	varchar	No
languageId	int	No
queueId	int	No
conditionalRouteId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/ddis/{id}

{}

PUT /rest/d-d-is/

Table DDIs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
brandId	int	Yes
companyId	int	Yes
DDI	varchar	Yes
DDIE164	varchar	No
externalCallFilterId	int	No
recordCalls	varchar	Yes	[enum:none\|all\|inbound\|outbound]
displayName	varchar	No
routeType	varchar	No	[enum:user\|IVRCommon\|IVRCustom\|huntGroup\|fax\|conferenceRoom\|friend\|queue\|retailAccount\|conditional]
userId	int	No
IVRCommonId	int	No
IVRCustomId	int	No
huntGroupId	int	No
faxId	int	No
conferenceRoomId	int	No
retailAccountId	int	No
peeringContractId	int	No
countryId	int	No
billInboundCalls	tinyint	Yes
friendValue	varchar	No
languageId	int	No
queueId	int	No
conditionalRouteId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/d-d-is/

Table DDIs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Domains

GET /rest/domains/

GET information about all Domains

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'domain': '', 
     'scope': '', 
     'pointsTo': '', 
     'brandId': '', 
     'companyId': '', 
     'description': ''
 },{
     'id': '', 
     'domain': '', 
     'scope': '', 
     'pointsTo': '', 
     'brandId': '', 
     'companyId': '', 
     'description': ''
 }]

GET /rest/domains/{id}

Get information about Domains

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'domain': '', 
     'scope': '', 
     'pointsTo': '', 
     'brandId': '', 
     'companyId': '', 
     'description': ''
 }

POST /rest/domains/

Create's a new Domains

Headers

Parameters

Name	Type	Required
domain	varchar	Yes
scope	enum('global','company','brand'	Yes
pointsTo	enum('proxyusers','proxytrunks'	Yes
brandId	int	No
companyId	int	No
description	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/domains/{id}

{}

PUT /rest/domains/

Table Domains

Headers

Parameters

Name	Type	Required
id	int	Yes
domain	varchar	Yes
scope	enum('global','company','brand'	Yes
pointsTo	enum('proxyusers','proxytrunks'	Yes
brandId	int	No
companyId	int	No
description	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/domains/

Table Domains

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

EtagVersions

GET /rest/etag-versions/

GET information about all EtagVersions

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'table': '', 
     'etag': '', 
     'lastChange': ''
 },{
     'id': '', 
     'table': '', 
     'etag': '', 
     'lastChange': ''
 }]

GET /rest/etag-versions/{id}

Get information about EtagVersions

Headers

Parameters

Name	Type	Required	Description
id	mediumint	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'table': '', 
     'etag': '', 
     'lastChange': ''
 }

POST /rest/etag-versions/

Create's a new EtagVersions

Headers

Parameters

Name	Type	Required
table	varchar	No
etag	varchar	No
lastChange	timestamp	No

Body

Headers

Response

HTTP 201

Location: /rest/etagversions/{id}

{}

PUT /rest/etag-versions/

Table EtagVersions

Headers

Parameters

Name	Type	Required
id	mediumint	Yes
table	varchar	No
etag	varchar	No
lastChange	timestamp	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/etag-versions/

Table EtagVersions

Headers

Parameters

Name	Type	Required	Description
id	mediumint	Yes

Body

Headers

Response

HTTP 204

{}

Extensions

GET /rest/extensions/

GET information about all Extensions

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'number': '', 
     'routeType': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'conferenceRoomId': '', 
     'userId': '', 
     'numberValue': '', 
     'friendValue': '', 
     'queueId': '', 
     'conditionalRouteId': ''
 },{
     'id': '', 
     'companyId': '', 
     'number': '', 
     'routeType': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'conferenceRoomId': '', 
     'userId': '', 
     'numberValue': '', 
     'friendValue': '', 
     'queueId': '', 
     'conditionalRouteId': ''
 }]

GET /rest/extensions/{id}

Get information about Extensions

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'number': '', 
     'routeType': '', 
     'IVRCommonId': '', 
     'IVRCustomId': '', 
     'huntGroupId': '', 
     'conferenceRoomId': '', 
     'userId': '', 
     'numberValue': '', 
     'friendValue': '', 
     'queueId': '', 
     'conditionalRouteId': ''
 }

POST /rest/extensions/

Create's a new Extensions

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
number	varchar	Yes
routeType	varchar	No	[enum:user\|number\|IVRCommon\|IVRCustom\|huntGroup\|conferenceRoom\|friend\|queue\|retailAccount\|conditional]
IVRCommonId	int	No
IVRCustomId	int	No
huntGroupId	int	No
conferenceRoomId	int	No
userId	int	No
numberValue	varchar	No
friendValue	varchar	No
queueId	int	No
conditionalRouteId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/extensions/{id}

{}

PUT /rest/extensions/

Table Extensions

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
number	varchar	Yes
routeType	varchar	No	[enum:user\|number\|IVRCommon\|IVRCustom\|huntGroup\|conferenceRoom\|friend\|queue\|retailAccount\|conditional]
IVRCommonId	int	No
IVRCustomId	int	No
huntGroupId	int	No
conferenceRoomId	int	No
userId	int	No
numberValue	varchar	No
friendValue	varchar	No
queueId	int	No
conditionalRouteId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/extensions/

Table Extensions

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ExternalCallFilterBlackLists

GET /rest/external-call-filter-black-lists/

GET information about all ExternalCallFilterBlackLists

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'filterId': '', 
     'matchListId': ''
 },{
     'id': '', 
     'filterId': '', 
     'matchListId': ''
 }]

GET /rest/external-call-filter-black-lists/{id}

Get information about ExternalCallFilterBlackLists

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'filterId': '', 
     'matchListId': ''
 }

POST /rest/external-call-filter-black-lists/

Create's a new ExternalCallFilterBlackLists

Headers

Parameters

Name	Type	Required	Description
filterId	int	Yes
matchListId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/externalcallfilterblacklists/{id}

{}

PUT /rest/external-call-filter-black-lists/

Table ExternalCallFilterBlackLists

Headers

Parameters

Name	Type	Required
id	int	Yes
filterId	int	Yes
matchListId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/external-call-filter-black-lists/

Table ExternalCallFilterBlackLists

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ExternalCallFilterRelCalendars

GET /rest/external-call-filter-rel-calendars/

GET information about all ExternalCallFilterRelCalendars

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'filterId': '', 
     'calendarId': ''
 },{
     'id': '', 
     'filterId': '', 
     'calendarId': ''
 }]

GET /rest/external-call-filter-rel-calendars/{id}

Get information about ExternalCallFilterRelCalendars

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'filterId': '', 
     'calendarId': ''
 }

POST /rest/external-call-filter-rel-calendars/

Create's a new ExternalCallFilterRelCalendars

Headers

Parameters

Name	Type	Required	Description
filterId	int	Yes
calendarId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/externalcallfilterrelcalendars/{id}

{}

PUT /rest/external-call-filter-rel-calendars/

Table ExternalCallFilterRelCalendars

Headers

Parameters

Name	Type	Required
id	int	Yes
filterId	int	Yes
calendarId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/external-call-filter-rel-calendars/

Table ExternalCallFilterRelCalendars

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ExternalCallFilterRelSchedules

GET /rest/external-call-filter-rel-schedules/

GET information about all ExternalCallFilterRelSchedules

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'filterId': '', 
     'scheduleId': ''
 },{
     'id': '', 
     'filterId': '', 
     'scheduleId': ''
 }]

GET /rest/external-call-filter-rel-schedules/{id}

Get information about ExternalCallFilterRelSchedules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'filterId': '', 
     'scheduleId': ''
 }

POST /rest/external-call-filter-rel-schedules/

Create's a new ExternalCallFilterRelSchedules

Headers

Parameters

Name	Type	Required	Description
filterId	int	Yes
scheduleId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/externalcallfilterrelschedules/{id}

{}

PUT /rest/external-call-filter-rel-schedules/

Table ExternalCallFilterRelSchedules

Headers

Parameters

Name	Type	Required
id	int	Yes
filterId	int	Yes
scheduleId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/external-call-filter-rel-schedules/

Table ExternalCallFilterRelSchedules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ExternalCallFilterWhiteLists

GET /rest/external-call-filter-white-lists/

GET information about all ExternalCallFilterWhiteLists

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'filterId': '', 
     'matchListId': ''
 },{
     'id': '', 
     'filterId': '', 
     'matchListId': ''
 }]

GET /rest/external-call-filter-white-lists/{id}

Get information about ExternalCallFilterWhiteLists

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'filterId': '', 
     'matchListId': ''
 }

POST /rest/external-call-filter-white-lists/

Create's a new ExternalCallFilterWhiteLists

Headers

Parameters

Name	Type	Required	Description
filterId	int	Yes
matchListId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/externalcallfilterwhitelists/{id}

{}

PUT /rest/external-call-filter-white-lists/

Table ExternalCallFilterWhiteLists

Headers

Parameters

Name	Type	Required
id	int	Yes
filterId	int	Yes
matchListId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/external-call-filter-white-lists/

Table ExternalCallFilterWhiteLists

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ExternalCallFilters

GET /rest/external-call-filters/

GET information about all ExternalCallFilters

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'welcomeLocutionId': '', 
     'holidayLocutionId': '', 
     'outOfScheduleLocutionId': '', 
     'holidayTargetType': '', 
     'holidayNumberValue': '', 
     'holidayExtensionId': '', 
     'holidayVoiceMailUserId': '', 
     'outOfScheduleTargetType': '', 
     'outOfScheduleNumberValue': '', 
     'outOfScheduleExtensionId': '', 
     'outOfScheduleVoiceMailUserId': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'welcomeLocutionId': '', 
     'holidayLocutionId': '', 
     'outOfScheduleLocutionId': '', 
     'holidayTargetType': '', 
     'holidayNumberValue': '', 
     'holidayExtensionId': '', 
     'holidayVoiceMailUserId': '', 
     'outOfScheduleTargetType': '', 
     'outOfScheduleNumberValue': '', 
     'outOfScheduleExtensionId': '', 
     'outOfScheduleVoiceMailUserId': ''
 }]

GET /rest/external-call-filters/{id}

Get information about ExternalCallFilters

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'welcomeLocutionId': '', 
     'holidayLocutionId': '', 
     'outOfScheduleLocutionId': '', 
     'holidayTargetType': '', 
     'holidayNumberValue': '', 
     'holidayExtensionId': '', 
     'holidayVoiceMailUserId': '', 
     'outOfScheduleTargetType': '', 
     'outOfScheduleNumberValue': '', 
     'outOfScheduleExtensionId': '', 
     'outOfScheduleVoiceMailUserId': ''
 }

POST /rest/external-call-filters/

Create's a new ExternalCallFilters

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
welcomeLocutionId	int	No
holidayLocutionId	int	No
outOfScheduleLocutionId	int	No
holidayTargetType	varchar	No	[enum:number\|extension\|voicemail]
holidayNumberValue	varchar	No
holidayExtensionId	int	No
holidayVoiceMailUserId	int	No
outOfScheduleTargetType	varchar	No	[enum:number\|extension\|voicemail]
outOfScheduleNumberValue	varchar	No
outOfScheduleExtensionId	int	No
outOfScheduleVoiceMailUserId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/externalcallfilters/{id}

{}

PUT /rest/external-call-filters/

Table ExternalCallFilters

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
welcomeLocutionId	int	No
holidayLocutionId	int	No
outOfScheduleLocutionId	int	No
holidayTargetType	varchar	No	[enum:number\|extension\|voicemail]
holidayNumberValue	varchar	No
holidayExtensionId	int	No
holidayVoiceMailUserId	int	No
outOfScheduleTargetType	varchar	No	[enum:number\|extension\|voicemail]
outOfScheduleNumberValue	varchar	No
outOfScheduleExtensionId	int	No
outOfScheduleVoiceMailUserId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/external-call-filters/

Table ExternalCallFilters

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Faxes

GET /rest/faxes/

GET information about all Faxes

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'email': '', 
     'sendByEmail': '', 
     'outgoingDDIId': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'email': '', 
     'sendByEmail': '', 
     'outgoingDDIId': ''
 }]

GET /rest/faxes/{id}

Get information about Faxes

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'email': '', 
     'sendByEmail': '', 
     'outgoingDDIId': ''
 }

POST /rest/faxes/

Create's a new Faxes

Headers

Parameters

Name	Type	Required
companyId	int	Yes
name	varchar	Yes
email	varchar	No
sendByEmail	tinyint	Yes
outgoingDDIId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/faxes/{id}

{}

PUT /rest/faxes/

Table Faxes

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
name	varchar	Yes
email	varchar	No
sendByEmail	tinyint	Yes
outgoingDDIId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/faxes/

Table Faxes

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

FaxesInOut

GET /rest/faxes-in-out/

GET information about all FaxesInOut

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'calldate': '', 
     'faxId': '', 
     'src': '', 
     'dst': '', 
     'type': '', 
     'pages': '', 
     'status': '', 
     'file': ''
 },{
     'id': '', 
     'calldate': '', 
     'faxId': '', 
     'src': '', 
     'dst': '', 
     'type': '', 
     'pages': '', 
     'status': '', 
     'file': ''
 }]

GET /rest/faxes-in-out/{id}

Get information about FaxesInOut

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'calldate': '', 
     'faxId': '', 
     'src': '', 
     'dst': '', 
     'type': '', 
     'pages': '', 
     'status': '', 
     'file': ''
 }

POST /rest/faxes-in-out/

Create's a new FaxesInOut

Headers

Parameters

Name	Type	Required	Description
calldate	timestamp	Yes	Hora de recepcion del fax
faxId	int	Yes
src	varchar	No
dst	varchar	No
type	varchar	No	[enum:In\|Out]
pages	varchar	No
status	enum('error','pending','inprogress','completed'	No
file	int	No	[FSO]

Body

Headers

Response

HTTP 201

Location: /rest/faxesinout/{id}

{}

PUT /rest/faxes-in-out/

Table FaxesInOut

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
calldate	timestamp	Yes	Hora de recepcion del fax
faxId	int	Yes
src	varchar	No
dst	varchar	No
type	varchar	No	[enum:In\|Out]
pages	varchar	No
status	enum('error','pending','inprogress','completed'	No
file	int	No	[FSO]

Body

Headers

Response

HTTP 200

{}

DELETE /rest/faxes-in-out/

Table FaxesInOut

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Features

GET /rest/features/

GET information about all Features

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'iden': '', 
     'name': '', 
     'name_en': '', 
     'name_es': ''
 },{
     'id': '', 
     'iden': '', 
     'name': '', 
     'name_en': '', 
     'name_es': ''
 }]

GET /rest/features/{id}

Get information about Features

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'iden': '', 
     'name': '', 
     'name_en': '', 
     'name_es': ''
 }

POST /rest/features/

Create's a new Features

Headers

Parameters

Name	Type	Required	Description
iden	varchar	Yes
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/features/{id}

{}

PUT /rest/features/

Table Features

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
iden	varchar	Yes
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/features/

Table Features

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

FeaturesRelBrands

GET /rest/features-rel-brands/

GET information about all FeaturesRelBrands

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'featureId': ''
 },{
     'id': '', 
     'brandId': '', 
     'featureId': ''
 }]

GET /rest/features-rel-brands/{id}

Get information about FeaturesRelBrands

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'featureId': ''
 }

POST /rest/features-rel-brands/

Create's a new FeaturesRelBrands

Headers

Parameters

Name	Type	Required	Description
brandId	int	Yes
featureId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/featuresrelbrands/{id}

{}

PUT /rest/features-rel-brands/

Table FeaturesRelBrands

Headers

Parameters

Name	Type	Required
id	int	Yes
brandId	int	Yes
featureId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/features-rel-brands/

Table FeaturesRelBrands

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

FeaturesRelCompanies

GET /rest/features-rel-companies/

GET information about all FeaturesRelCompanies

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'featureId': ''
 },{
     'id': '', 
     'companyId': '', 
     'featureId': ''
 }]

GET /rest/features-rel-companies/{id}

Get information about FeaturesRelCompanies

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'featureId': ''
 }

POST /rest/features-rel-companies/

Create's a new FeaturesRelCompanies

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
featureId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/featuresrelcompanies/{id}

{}

PUT /rest/features-rel-companies/

Table FeaturesRelCompanies

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
featureId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/features-rel-companies/

Table FeaturesRelCompanies

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

FixedCosts

GET /rest/fixed-costs/

GET information about all FixedCosts

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'name': '', 
     'description': '', 
     'cost': ''
 },{
     'id': '', 
     'brandId': '', 
     'name': '', 
     'description': '', 
     'cost': ''
 }]

GET /rest/fixed-costs/{id}

Get information about FixedCosts

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'name': '', 
     'description': '', 
     'cost': ''
 }

POST /rest/fixed-costs/

Create's a new FixedCosts

Headers

Parameters

Name	Type	Required
brandId	int	Yes
name	varchar	Yes
description	text	No
cost	decimal	No

Body

Headers

Response

HTTP 201

Location: /rest/fixedcosts/{id}

{}

PUT /rest/fixed-costs/

Table FixedCosts

Headers

Parameters

Name	Type	Required
id	int	Yes
brandId	int	Yes
name	varchar	Yes
description	text	No
cost	decimal	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/fixed-costs/

Table FixedCosts

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

FixedCostsRelInvoices

GET /rest/fixed-costs-rel-invoices/

GET information about all FixedCostsRelInvoices

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'fixedCostId': '', 
     'invoiceId': '', 
     'quantity': ''
 },{
     'id': '', 
     'brandId': '', 
     'fixedCostId': '', 
     'invoiceId': '', 
     'quantity': ''
 }]

GET /rest/fixed-costs-rel-invoices/{id}

Get information about FixedCostsRelInvoices

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'fixedCostId': '', 
     'invoiceId': '', 
     'quantity': ''
 }

POST /rest/fixed-costs-rel-invoices/

Create's a new FixedCostsRelInvoices

Headers

Parameters

Name	Type	Required
brandId	int	Yes
fixedCostId	int	Yes
invoiceId	int	Yes
quantity	int	No

Body

Headers

Response

HTTP 201

Location: /rest/fixedcostsrelinvoices/{id}

{}

PUT /rest/fixed-costs-rel-invoices/

Table FixedCostsRelInvoices

Headers

Parameters

Name	Type	Required
id	int	Yes
brandId	int	Yes
fixedCostId	int	Yes
invoiceId	int	Yes
quantity	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/fixed-costs-rel-invoices/

Table FixedCostsRelInvoices

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Friends

GET /rest/friends/

GET information about all Friends

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'domain': '', 
     'description': '', 
     'transport': '', 
     'ip': '', 
     'port': '', 
     'auth_needed': '', 
     'password': '', 
     'callACLId': '', 
     'countryId': '', 
     'areaCode': '', 
     'outgoingDDIId': '', 
     'priority': '', 
     'disallow': '', 
     'allow': '', 
     'direct_media_method': '', 
     'callerid_update_header': '', 
     'update_callerid': '', 
     'from_domain': '', 
     'directConnectivity': '', 
     'languageId': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'domain': '', 
     'description': '', 
     'transport': '', 
     'ip': '', 
     'port': '', 
     'auth_needed': '', 
     'password': '', 
     'callACLId': '', 
     'countryId': '', 
     'areaCode': '', 
     'outgoingDDIId': '', 
     'priority': '', 
     'disallow': '', 
     'allow': '', 
     'direct_media_method': '', 
     'callerid_update_header': '', 
     'update_callerid': '', 
     'from_domain': '', 
     'directConnectivity': '', 
     'languageId': ''
 }]

GET /rest/friends/{id}

Get information about Friends

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'domain': '', 
     'description': '', 
     'transport': '', 
     'ip': '', 
     'port': '', 
     'auth_needed': '', 
     'password': '', 
     'callACLId': '', 
     'countryId': '', 
     'areaCode': '', 
     'outgoingDDIId': '', 
     'priority': '', 
     'disallow': '', 
     'allow': '', 
     'direct_media_method': '', 
     'callerid_update_header': '', 
     'update_callerid': '', 
     'from_domain': '', 
     'directConnectivity': '', 
     'languageId': ''
 }

POST /rest/friends/

Create's a new Friends

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
domain	varchar	No
description	varchar	Yes
transport	varchar	Yes	[enum:udp\|tcp\|tls]
ip	varchar	No
port	smallint	No
auth_needed	enum('yes','no'	Yes
password	varchar	No
callACLId	int	No
countryId	int	No
areaCode	varchar	No
outgoingDDIId	int	No
priority	smallint	Yes
disallow	varchar	Yes
allow	varchar	Yes
direct_media_method	enum('invite','update'	Yes
callerid_update_header	enum('pai','rpid'	Yes
update_callerid	enum('yes','no'	Yes
from_domain	varchar	No
directConnectivity	enum('yes','no'	Yes
languageId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/friends/{id}

{}

PUT /rest/friends/

Table Friends

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
domain	varchar	No
description	varchar	Yes
transport	varchar	Yes	[enum:udp\|tcp\|tls]
ip	varchar	No
port	smallint	No
auth_needed	enum('yes','no'	Yes
password	varchar	No
callACLId	int	No
countryId	int	No
areaCode	varchar	No
outgoingDDIId	int	No
priority	smallint	Yes
disallow	varchar	Yes
allow	varchar	Yes
direct_media_method	enum('invite','update'	Yes
callerid_update_header	enum('pai','rpid'	Yes
update_callerid	enum('yes','no'	Yes
from_domain	varchar	No
directConnectivity	enum('yes','no'	Yes
languageId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/friends/

Table Friends

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

FriendsPatterns

GET /rest/friends-patterns/

GET information about all FriendsPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'friendId': '', 
     'name': '', 
     'regExp': ''
 },{
     'id': '', 
     'friendId': '', 
     'name': '', 
     'regExp': ''
 }]

GET /rest/friends-patterns/{id}

Get information about FriendsPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'friendId': '', 
     'name': '', 
     'regExp': ''
 }

POST /rest/friends-patterns/

Create's a new FriendsPatterns

Headers

Parameters

Name	Type	Required
friendId	int	Yes
name	varchar	Yes
regExp	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/friendspatterns/{id}

{}

PUT /rest/friends-patterns/

Table FriendsPatterns

Headers

Parameters

Name	Type	Required
id	int	Yes
friendId	int	Yes
name	varchar	Yes
regExp	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/friends-patterns/

Table FriendsPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

GenericCallACLPatterns

GET /rest/generic-call-a-c-l-patterns/

GET information about all GenericCallACLPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'name': '', 
     'regExp': ''
 },{
     'id': '', 
     'brandId': '', 
     'name': '', 
     'regExp': ''
 }]

GET /rest/generic-call-a-c-l-patterns/{id}

Get information about GenericCallACLPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'name': '', 
     'regExp': ''
 }

POST /rest/generic-call-a-c-l-patterns/

Create's a new GenericCallACLPatterns

Headers

Parameters

Name	Type	Required
brandId	int	Yes
name	varchar	Yes
regExp	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/genericcallaclpatterns/{id}

{}

PUT /rest/generic-call-a-c-l-patterns/

Table GenericCallACLPatterns

Headers

Parameters

Name	Type	Required
id	int	Yes
brandId	int	Yes
name	varchar	Yes
regExp	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/generic-call-a-c-l-patterns/

Table GenericCallACLPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

GenericMusicOnHold

GET /rest/generic-music-on-hold/

GET information about all GenericMusicOnHold

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'originalFile': '', 
     'encodedFile': '', 
     'status': '', 
     'brandId': ''
 },{
     'id': '', 
     'name': '', 
     'originalFile': '', 
     'encodedFile': '', 
     'status': '', 
     'brandId': ''
 }]

GET /rest/generic-music-on-hold/{id}

Get information about GenericMusicOnHold

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'originalFile': '', 
     'encodedFile': '', 
     'status': '', 
     'brandId': ''
 }

POST /rest/generic-music-on-hold/

Create's a new GenericMusicOnHold

Headers

Parameters

Name	Type	Required	Description
name	varchar	Yes
originalFile	int	No	[FSO:keepExtension]
encodedFile	int	No	[FSO:keepExtension\|storeInBaseFolder]
status	varchar	No	[enum:pending\|encoding\|ready\|error]
brandId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/genericmusiconhold/{id}

{}

PUT /rest/generic-music-on-hold/

Table GenericMusicOnHold

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
name	varchar	Yes
originalFile	int	No	[FSO:keepExtension]
encodedFile	int	No	[FSO:keepExtension\|storeInBaseFolder]
status	varchar	No	[enum:pending\|encoding\|ready\|error]
brandId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/generic-music-on-hold/

Table GenericMusicOnHold

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

HolidayDates

GET /rest/holiday-dates/

GET information about all HolidayDates

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'calendarId': '', 
     'name': '', 
     'eventDate': '', 
     'locutionId': ''
 },{
     'id': '', 
     'calendarId': '', 
     'name': '', 
     'eventDate': '', 
     'locutionId': ''
 }]

GET /rest/holiday-dates/{id}

Get information about HolidayDates

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'calendarId': '', 
     'name': '', 
     'eventDate': '', 
     'locutionId': ''
 }

POST /rest/holiday-dates/

Create's a new HolidayDates

Headers

Parameters

Name	Type	Required
calendarId	int	Yes
name	varchar	Yes
eventDate	date	Yes
locutionId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/holidaydates/{id}

{}

PUT /rest/holiday-dates/

Table HolidayDates

Headers

Parameters

Name	Type	Required
id	int	Yes
calendarId	int	Yes
name	varchar	Yes
eventDate	date	Yes
locutionId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/holiday-dates/

Table HolidayDates

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

HuntGroups

GET /rest/hunt-groups/

GET information about all HuntGroups

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'description': '', 
     'companyId': '', 
     'strategy': '', 
     'ringAllTimeout': '', 
     'nextUserPosition': '', 
     'noAnswerLocutionId': '', 
     'noAnswerTargetType': '', 
     'noAnswerNumberValue': '', 
     'noAnswerExtensionId': '', 
     'noAnswerVoiceMailUserId': ''
 },{
     'id': '', 
     'name': '', 
     'description': '', 
     'companyId': '', 
     'strategy': '', 
     'ringAllTimeout': '', 
     'nextUserPosition': '', 
     'noAnswerLocutionId': '', 
     'noAnswerTargetType': '', 
     'noAnswerNumberValue': '', 
     'noAnswerExtensionId': '', 
     'noAnswerVoiceMailUserId': ''
 }]

GET /rest/hunt-groups/{id}

Get information about HuntGroups

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'description': '', 
     'companyId': '', 
     'strategy': '', 
     'ringAllTimeout': '', 
     'nextUserPosition': '', 
     'noAnswerLocutionId': '', 
     'noAnswerTargetType': '', 
     'noAnswerNumberValue': '', 
     'noAnswerExtensionId': '', 
     'noAnswerVoiceMailUserId': ''
 }

POST /rest/hunt-groups/

Create's a new HuntGroups

Headers

Parameters

Name	Type	Required	Description
name	varchar	Yes
description	varchar	Yes
companyId	int	Yes
strategy	varchar	Yes	[enum:ringAll\|linear\|roundRobin\|random]
ringAllTimeout	smallint	Yes
nextUserPosition	smallint	No
noAnswerLocutionId	int	No
noAnswerTargetType	varchar	No	[enum:number\|extension\|voicemail]
noAnswerNumberValue	varchar	No
noAnswerExtensionId	int	No
noAnswerVoiceMailUserId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/huntgroups/{id}

{}

PUT /rest/hunt-groups/

Table HuntGroups

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
name	varchar	Yes
description	varchar	Yes
companyId	int	Yes
strategy	varchar	Yes	[enum:ringAll\|linear\|roundRobin\|random]
ringAllTimeout	smallint	Yes
nextUserPosition	smallint	No
noAnswerLocutionId	int	No
noAnswerTargetType	varchar	No	[enum:number\|extension\|voicemail]
noAnswerNumberValue	varchar	No
noAnswerExtensionId	int	No
noAnswerVoiceMailUserId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/hunt-groups/

Table HuntGroups

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

HuntGroupsRelUsers

GET /rest/hunt-groups-rel-users/

GET information about all HuntGroupsRelUsers

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'huntGroupId': '', 
     'userId': '', 
     'timeoutTime': '', 
     'priority': ''
 },{
     'id': '', 
     'huntGroupId': '', 
     'userId': '', 
     'timeoutTime': '', 
     'priority': ''
 }]

GET /rest/hunt-groups-rel-users/{id}

Get information about HuntGroupsRelUsers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'huntGroupId': '', 
     'userId': '', 
     'timeoutTime': '', 
     'priority': ''
 }

POST /rest/hunt-groups-rel-users/

Create's a new HuntGroupsRelUsers

Headers

Parameters

Name	Type	Required
huntGroupId	int	Yes
userId	int	Yes
timeoutTime	smallint	No
priority	smallint	No

Body

Headers

Response

HTTP 201

Location: /rest/huntgroupsrelusers/{id}

{}

PUT /rest/hunt-groups-rel-users/

Table HuntGroupsRelUsers

Headers

Parameters

Name	Type	Required
id	int	Yes
huntGroupId	int	Yes
userId	int	Yes
timeoutTime	smallint	No
priority	smallint	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/hunt-groups-rel-users/

Table HuntGroupsRelUsers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

IVRCommon

GET /rest/i-v-r-common/

GET information about all IVRCommon

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'blackListRegExp': '', 
     'welcomeLocutionId': '', 
     'noAnswerLocutionId': '', 
     'errorLocutionId': '', 
     'successLocutionId': '', 
     'timeout': '', 
     'maxDigits': '', 
     'noAnswerTimeout': '', 
     'timeoutTargetType': '', 
     'timeoutNumberValue': '', 
     'timeoutExtensionId': '', 
     'timeoutVoiceMailUserId': '', 
     'errorTargetType': '', 
     'errorNumberValue': '', 
     'errorExtensionId': '', 
     'errorVoiceMailUserId': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'blackListRegExp': '', 
     'welcomeLocutionId': '', 
     'noAnswerLocutionId': '', 
     'errorLocutionId': '', 
     'successLocutionId': '', 
     'timeout': '', 
     'maxDigits': '', 
     'noAnswerTimeout': '', 
     'timeoutTargetType': '', 
     'timeoutNumberValue': '', 
     'timeoutExtensionId': '', 
     'timeoutVoiceMailUserId': '', 
     'errorTargetType': '', 
     'errorNumberValue': '', 
     'errorExtensionId': '', 
     'errorVoiceMailUserId': ''
 }]

GET /rest/i-v-r-common/{id}

Get information about IVRCommon

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'blackListRegExp': '', 
     'welcomeLocutionId': '', 
     'noAnswerLocutionId': '', 
     'errorLocutionId': '', 
     'successLocutionId': '', 
     'timeout': '', 
     'maxDigits': '', 
     'noAnswerTimeout': '', 
     'timeoutTargetType': '', 
     'timeoutNumberValue': '', 
     'timeoutExtensionId': '', 
     'timeoutVoiceMailUserId': '', 
     'errorTargetType': '', 
     'errorNumberValue': '', 
     'errorExtensionId': '', 
     'errorVoiceMailUserId': ''
 }

POST /rest/i-v-r-common/

Create's a new IVRCommon

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
blackListRegExp	varchar	No
welcomeLocutionId	int	No
noAnswerLocutionId	int	No
errorLocutionId	int	No
successLocutionId	int	No
timeout	smallint	Yes
maxDigits	smallint	Yes
noAnswerTimeout	mediumint	No
timeoutTargetType	varchar	No	[enum:number\|extension\|voicemail]
timeoutNumberValue	varchar	No
timeoutExtensionId	int	No
timeoutVoiceMailUserId	int	No
errorTargetType	varchar	No	[enum:number\|extension\|voicemail]
errorNumberValue	varchar	No
errorExtensionId	int	No
errorVoiceMailUserId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/ivrcommon/{id}

{}

PUT /rest/i-v-r-common/

Table IVRCommon

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
blackListRegExp	varchar	No
welcomeLocutionId	int	No
noAnswerLocutionId	int	No
errorLocutionId	int	No
successLocutionId	int	No
timeout	smallint	Yes
maxDigits	smallint	Yes
noAnswerTimeout	mediumint	No
timeoutTargetType	varchar	No	[enum:number\|extension\|voicemail]
timeoutNumberValue	varchar	No
timeoutExtensionId	int	No
timeoutVoiceMailUserId	int	No
errorTargetType	varchar	No	[enum:number\|extension\|voicemail]
errorNumberValue	varchar	No
errorExtensionId	int	No
errorVoiceMailUserId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/i-v-r-common/

Table IVRCommon

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

IVRCustom

GET /rest/i-v-r-custom/

GET information about all IVRCustom

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'welcomeLocutionId': '', 
     'noAnswerLocutionId': '', 
     'errorLocutionId': '', 
     'successLocutionId': '', 
     'timeout': '', 
     'maxDigits': '', 
     'noAnswerTimeout': '', 
     'timeoutTargetType': '', 
     'timeoutNumberValue': '', 
     'timeoutExtensionId': '', 
     'timeoutVoiceMailUserId': '', 
     'errorTargetType': '', 
     'errorNumberValue': '', 
     'errorExtensionId': '', 
     'errorVoiceMailUserId': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'welcomeLocutionId': '', 
     'noAnswerLocutionId': '', 
     'errorLocutionId': '', 
     'successLocutionId': '', 
     'timeout': '', 
     'maxDigits': '', 
     'noAnswerTimeout': '', 
     'timeoutTargetType': '', 
     'timeoutNumberValue': '', 
     'timeoutExtensionId': '', 
     'timeoutVoiceMailUserId': '', 
     'errorTargetType': '', 
     'errorNumberValue': '', 
     'errorExtensionId': '', 
     'errorVoiceMailUserId': ''
 }]

GET /rest/i-v-r-custom/{id}

Get information about IVRCustom

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'welcomeLocutionId': '', 
     'noAnswerLocutionId': '', 
     'errorLocutionId': '', 
     'successLocutionId': '', 
     'timeout': '', 
     'maxDigits': '', 
     'noAnswerTimeout': '', 
     'timeoutTargetType': '', 
     'timeoutNumberValue': '', 
     'timeoutExtensionId': '', 
     'timeoutVoiceMailUserId': '', 
     'errorTargetType': '', 
     'errorNumberValue': '', 
     'errorExtensionId': '', 
     'errorVoiceMailUserId': ''
 }

POST /rest/i-v-r-custom/

Create's a new IVRCustom

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
welcomeLocutionId	int	No
noAnswerLocutionId	int	No
errorLocutionId	int	No
successLocutionId	int	No
timeout	smallint	Yes
maxDigits	smallint	Yes
noAnswerTimeout	mediumint	No
timeoutTargetType	varchar	No	[enum:number\|extension\|voicemail]
timeoutNumberValue	varchar	No
timeoutExtensionId	int	No
timeoutVoiceMailUserId	int	No
errorTargetType	varchar	No	[enum:number\|extension\|voicemail]
errorNumberValue	varchar	No
errorExtensionId	int	No
errorVoiceMailUserId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/ivrcustom/{id}

{}

PUT /rest/i-v-r-custom/

Table IVRCustom

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
welcomeLocutionId	int	No
noAnswerLocutionId	int	No
errorLocutionId	int	No
successLocutionId	int	No
timeout	smallint	Yes
maxDigits	smallint	Yes
noAnswerTimeout	mediumint	No
timeoutTargetType	varchar	No	[enum:number\|extension\|voicemail]
timeoutNumberValue	varchar	No
timeoutExtensionId	int	No
timeoutVoiceMailUserId	int	No
errorTargetType	varchar	No	[enum:number\|extension\|voicemail]
errorNumberValue	varchar	No
errorExtensionId	int	No
errorVoiceMailUserId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/i-v-r-custom/

Table IVRCustom

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

IVRCustomEntries

GET /rest/i-v-r-custom-entries/

GET information about all IVRCustomEntries

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'IVRCustomId': '', 
     'entry': '', 
     'welcomeLocutionId': '', 
     'targetType': '', 
     'targetNumberValue': '', 
     'targetExtensionId': '', 
     'targetVoiceMailUserId': '', 
     'targetConditionalRouteId': ''
 },{
     'id': '', 
     'IVRCustomId': '', 
     'entry': '', 
     'welcomeLocutionId': '', 
     'targetType': '', 
     'targetNumberValue': '', 
     'targetExtensionId': '', 
     'targetVoiceMailUserId': '', 
     'targetConditionalRouteId': ''
 }]

GET /rest/i-v-r-custom-entries/{id}

Get information about IVRCustomEntries

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'IVRCustomId': '', 
     'entry': '', 
     'welcomeLocutionId': '', 
     'targetType': '', 
     'targetNumberValue': '', 
     'targetExtensionId': '', 
     'targetVoiceMailUserId': '', 
     'targetConditionalRouteId': ''
 }

POST /rest/i-v-r-custom-entries/

Create's a new IVRCustomEntries

Headers

Parameters

Name	Type	Required	Description
IVRCustomId	int	Yes
entry	varchar	Yes
welcomeLocutionId	int	No
targetType	varchar	Yes	[enum:number\|extension\|voicemail\|conditional]
targetNumberValue	varchar	No
targetExtensionId	int	No
targetVoiceMailUserId	int	No
targetConditionalRouteId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/ivrcustomentries/{id}

{}

PUT /rest/i-v-r-custom-entries/

Table IVRCustomEntries

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
IVRCustomId	int	Yes
entry	varchar	Yes
welcomeLocutionId	int	No
targetType	varchar	Yes	[enum:number\|extension\|voicemail\|conditional]
targetNumberValue	varchar	No
targetExtensionId	int	No
targetVoiceMailUserId	int	No
targetConditionalRouteId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/i-v-r-custom-entries/

Table IVRCustomEntries

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

InvoiceTemplates

GET /rest/invoice-templates/

GET information about all InvoiceTemplates

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'description': '', 
     'template': '', 
     'templateHeader': '', 
     'templateFooter': '', 
     'brandId': ''
 },{
     'id': '', 
     'name': '', 
     'description': '', 
     'template': '', 
     'templateHeader': '', 
     'templateFooter': '', 
     'brandId': ''
 }]

GET /rest/invoice-templates/{id}

Get information about InvoiceTemplates

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'description': '', 
     'template': '', 
     'templateHeader': '', 
     'templateFooter': '', 
     'brandId': ''
 }

POST /rest/invoice-templates/

Create's a new InvoiceTemplates

Headers

Parameters

Name	Type	Required
name	varchar	Yes
description	varchar	No
template	text	Yes
templateHeader	text	No
templateFooter	text	No
brandId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/invoicetemplates/{id}

{}

PUT /rest/invoice-templates/

Table InvoiceTemplates

Headers

Parameters

Name	Type	Required
id	int	Yes
name	varchar	Yes
description	varchar	No
template	text	Yes
templateHeader	text	No
templateFooter	text	No
brandId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/invoice-templates/

Table InvoiceTemplates

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Invoices

GET /rest/invoices/

GET information about all Invoices

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'number': '', 
     'inDate': '', 
     'outDate': '', 
     'total': '', 
     'taxRate': '', 
     'totalWithTax': '', 
     'status': '', 
     'companyId': '', 
     'brandId': '', 
     'pdfFile': '', 
     'invoiceTemplateId': ''
 },{
     'id': '', 
     'number': '', 
     'inDate': '', 
     'outDate': '', 
     'total': '', 
     'taxRate': '', 
     'totalWithTax': '', 
     'status': '', 
     'companyId': '', 
     'brandId': '', 
     'pdfFile': '', 
     'invoiceTemplateId': ''
 }]

GET /rest/invoices/{id}

Get information about Invoices

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'number': '', 
     'inDate': '', 
     'outDate': '', 
     'total': '', 
     'taxRate': '', 
     'totalWithTax': '', 
     'status': '', 
     'companyId': '', 
     'brandId': '', 
     'pdfFile': '', 
     'invoiceTemplateId': ''
 }

POST /rest/invoices/

Create's a new Invoices

Headers

Parameters

Name	Type	Required	Description
number	varchar	Yes
inDate	datetime	No
outDate	datetime	No
total	decimal	No
taxRate	decimal	No
totalWithTax	decimal	No
status	varchar	No	[enum:waiting\|processing\|created\|error]
companyId	int	Yes
brandId	int	Yes
pdfFile	int	No	[FSO]
invoiceTemplateId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/invoices/{id}

{}

PUT /rest/invoices/

Table Invoices

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
number	varchar	Yes
inDate	datetime	No
outDate	datetime	No
total	decimal	No
taxRate	decimal	No
totalWithTax	decimal	No
status	varchar	No	[enum:waiting\|processing\|created\|error]
companyId	int	Yes
brandId	int	Yes
pdfFile	int	No	[FSO]
invoiceTemplateId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/invoices/

Table Invoices

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamAccCdrs

GET /rest/kam-acc-cdrs/

GET information about all KamAccCdrs

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'proxy': '', 
     'start_time_utc': '', 
     'end_time_utc': '', 
     'start_time': '', 
     'end_time': '', 
     'duration': '', 
     'caller': '', 
     'callee': '', 
     'referee': '', 
     'referrer': '', 
     'companyId': '', 
     'brandId': '', 
     'asIden': '', 
     'asAddress': '', 
     'callid': '', 
     'callidHash': '', 
     'xcallid': '', 
     'parsed': '', 
     'diversion': '', 
     'peeringContractId': '', 
     'bounced': '', 
     'externallyRated': '', 
     'metered': '', 
     'meteringDate': '', 
     'pricingPlanId': '', 
     'pricingPlanName': '', 
     'targetPatternId': '', 
     'targetPatternName': '', 
     'price': '', 
     'pricingPlanDetails': '', 
     'invoiceId': '', 
     'direction': '', 
     'reMeteringDate': ''
 },{
     'id': '', 
     'proxy': '', 
     'start_time_utc': '', 
     'end_time_utc': '', 
     'start_time': '', 
     'end_time': '', 
     'duration': '', 
     'caller': '', 
     'callee': '', 
     'referee': '', 
     'referrer': '', 
     'companyId': '', 
     'brandId': '', 
     'asIden': '', 
     'asAddress': '', 
     'callid': '', 
     'callidHash': '', 
     'xcallid': '', 
     'parsed': '', 
     'diversion': '', 
     'peeringContractId': '', 
     'bounced': '', 
     'externallyRated': '', 
     'metered': '', 
     'meteringDate': '', 
     'pricingPlanId': '', 
     'pricingPlanName': '', 
     'targetPatternId': '', 
     'targetPatternName': '', 
     'price': '', 
     'pricingPlanDetails': '', 
     'invoiceId': '', 
     'direction': '', 
     'reMeteringDate': ''
 }]

GET /rest/kam-acc-cdrs/{id}

Get information about KamAccCdrs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'proxy': '', 
     'start_time_utc': '', 
     'end_time_utc': '', 
     'start_time': '', 
     'end_time': '', 
     'duration': '', 
     'caller': '', 
     'callee': '', 
     'referee': '', 
     'referrer': '', 
     'companyId': '', 
     'brandId': '', 
     'asIden': '', 
     'asAddress': '', 
     'callid': '', 
     'callidHash': '', 
     'xcallid': '', 
     'parsed': '', 
     'diversion': '', 
     'peeringContractId': '', 
     'bounced': '', 
     'externallyRated': '', 
     'metered': '', 
     'meteringDate': '', 
     'pricingPlanId': '', 
     'pricingPlanName': '', 
     'targetPatternId': '', 
     'targetPatternName': '', 
     'price': '', 
     'pricingPlanDetails': '', 
     'invoiceId': '', 
     'direction': '', 
     'reMeteringDate': ''
 }

POST /rest/kam-acc-cdrs/

Create's a new KamAccCdrs

Headers

Parameters

Name	Type	Required
proxy	varchar	No
start_time_utc	timestamp	Yes
end_time_utc	timestamp	Yes
start_time	timestamp	Yes
end_time	timestamp	Yes
duration	float	Yes
caller	varchar	No
callee	varchar	No
referee	varchar	No
referrer	varchar	No
companyId	int	No
brandId	int	No
asIden	varchar	No
asAddress	varchar	No
callid	varchar	No
callidHash	varchar	No
xcallid	varchar	No
parsed	enum('yes','no','error'	No
diversion	varchar	No
peeringContractId	varchar	No
bounced	enum('yes','no'	Yes
externallyRated	tinyint	No
metered	tinyint	No
meteringDate	datetime	No
pricingPlanId	int	No
pricingPlanName	varchar	No
targetPatternId	int	No
targetPatternName	varchar	No
price	decimal	No
pricingPlanDetails	text	No
invoiceId	int	No
direction	enum('inbound','outbound'	No
reMeteringDate	datetime	No

Body

Headers

Response

HTTP 201

Location: /rest/kamacccdrs/{id}

{}

PUT /rest/kam-acc-cdrs/

Table KamAccCdrs

Headers

Parameters

Name	Type	Required
id	int	Yes
proxy	varchar	No
start_time_utc	timestamp	Yes
end_time_utc	timestamp	Yes
start_time	timestamp	Yes
end_time	timestamp	Yes
duration	float	Yes
caller	varchar	No
callee	varchar	No
referee	varchar	No
referrer	varchar	No
companyId	int	No
brandId	int	No
asIden	varchar	No
asAddress	varchar	No
callid	varchar	No
callidHash	varchar	No
xcallid	varchar	No
parsed	enum('yes','no','error'	No
diversion	varchar	No
peeringContractId	varchar	No
bounced	enum('yes','no'	Yes
externallyRated	tinyint	No
metered	tinyint	No
meteringDate	datetime	No
pricingPlanId	int	No
pricingPlanName	varchar	No
targetPatternId	int	No
targetPatternName	varchar	No
price	decimal	No
pricingPlanDetails	text	No
invoiceId	int	No
direction	enum('inbound','outbound'	No
reMeteringDate	datetime	No

Body

Headers

Parameters

proxy

start_time_utc

end_time_utc

start_time

end_time

duration

caller

callee

referee

referrer

companyId

brandId

asIden

asAddress

callid

callidHash

xcallid

parsed

diversion

peeringContractId

bounced

externallyRated

metered

meteringDate

pricingPlanId

pricingPlanName

targetPatternId

targetPatternName

price

pricingPlanDetails

invoiceId

direction

reMeteringDate

Response

HTTP 200

{}

DELETE /rest/kam-acc-cdrs/

Table KamAccCdrs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamDispatcher

GET /rest/kam-dispatcher/

GET information about all KamDispatcher

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'setid': '', 
     'destination': '', 
     'flags': '', 
     'priority': '', 
     'attrs': '', 
     'description': '', 
     'applicationServerId': ''
 },{
     'id': '', 
     'setid': '', 
     'destination': '', 
     'flags': '', 
     'priority': '', 
     'attrs': '', 
     'description': '', 
     'applicationServerId': ''
 }]

GET /rest/kam-dispatcher/{id}

Get information about KamDispatcher

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'setid': '', 
     'destination': '', 
     'flags': '', 
     'priority': '', 
     'attrs': '', 
     'description': '', 
     'applicationServerId': ''
 }

POST /rest/kam-dispatcher/

Create's a new KamDispatcher

Headers

Parameters

Name	Type	Required
setid	int	Yes
destination	varchar	Yes
flags	int	Yes
priority	int	Yes
attrs	varchar	Yes
description	varchar	Yes
applicationServerId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/kamdispatcher/{id}

{}

PUT /rest/kam-dispatcher/

Table KamDispatcher

Headers

Parameters

Name	Type	Required
id	int	Yes
setid	int	Yes
destination	varchar	Yes
flags	int	Yes
priority	int	Yes
attrs	varchar	Yes
description	varchar	Yes
applicationServerId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/kam-dispatcher/

Table KamDispatcher

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamPikeTrusted

GET /rest/kam-pike-trusted/

GET information about all KamPikeTrusted

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'src_ip': '', 
     'proto': '', 
     'from_pattern': '', 
     'ruri_pattern': '', 
     'tag': '', 
     'priority': ''
 },{
     'id': '', 
     'src_ip': '', 
     'proto': '', 
     'from_pattern': '', 
     'ruri_pattern': '', 
     'tag': '', 
     'priority': ''
 }]

GET /rest/kam-pike-trusted/{id}

Get information about KamPikeTrusted

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'src_ip': '', 
     'proto': '', 
     'from_pattern': '', 
     'ruri_pattern': '', 
     'tag': '', 
     'priority': ''
 }

POST /rest/kam-pike-trusted/

Create's a new KamPikeTrusted

Headers

Parameters

Name	Type	Required
src_ip	varchar	No
proto	varchar	No
from_pattern	varchar	No
ruri_pattern	varchar	No
tag	varchar	No
priority	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/kampiketrusted/{id}

{}

PUT /rest/kam-pike-trusted/

Table KamPikeTrusted

Headers

Parameters

Name	Type	Required
id	int	Yes
src_ip	varchar	No
proto	varchar	No
from_pattern	varchar	No
ruri_pattern	varchar	No
tag	varchar	No
priority	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/kam-pike-trusted/

Table KamPikeTrusted

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamRtpproxy

GET /rest/kam-rtpproxy/

GET information about all KamRtpproxy

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'setid': '', 
     'url': '', 
     'flags': '', 
     'weight': '', 
     'description': '', 
     'mediaRelaySetsId': ''
 },{
     'id': '', 
     'setid': '', 
     'url': '', 
     'flags': '', 
     'weight': '', 
     'description': '', 
     'mediaRelaySetsId': ''
 }]

GET /rest/kam-rtpproxy/{id}

Get information about KamRtpproxy

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'setid': '', 
     'url': '', 
     'flags': '', 
     'weight': '', 
     'description': '', 
     'mediaRelaySetsId': ''
 }

POST /rest/kam-rtpproxy/

Create's a new KamRtpproxy

Headers

Parameters

Name	Type	Required
setid	varchar	Yes
url	varchar	Yes
flags	int	Yes
weight	int	Yes
description	varchar	No
mediaRelaySetsId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/kamrtpproxy/{id}

{}

PUT /rest/kam-rtpproxy/

Table KamRtpproxy

Headers

Parameters

Name	Type	Required
id	int	Yes
setid	varchar	Yes
url	varchar	Yes
flags	int	Yes
weight	int	Yes
description	varchar	No
mediaRelaySetsId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/kam-rtpproxy/

Table KamRtpproxy

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamTrunksAddress

GET /rest/kam-trunks-address/

GET information about all KamTrunksAddress

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'grp': '', 
     'ip_addr': '', 
     'mask': '', 
     'port': '', 
     'tag': ''
 },{
     'id': '', 
     'grp': '', 
     'ip_addr': '', 
     'mask': '', 
     'port': '', 
     'tag': ''
 }]

GET /rest/kam-trunks-address/{id}

Get information about KamTrunksAddress

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'grp': '', 
     'ip_addr': '', 
     'mask': '', 
     'port': '', 
     'tag': ''
 }

POST /rest/kam-trunks-address/

Create's a new KamTrunksAddress

Headers

Parameters

Name	Type	Required
grp	int	Yes
ip_addr	varchar	No
mask	int	Yes
port	int	Yes
tag	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/kamtrunksaddress/{id}

{}

PUT /rest/kam-trunks-address/

Table KamTrunksAddress

Headers

Parameters

Name	Type	Required
id	int	Yes
grp	int	Yes
ip_addr	varchar	No
mask	int	Yes
port	int	Yes
tag	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/kam-trunks-address/

Table KamTrunksAddress

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamTrunksDialplan

GET /rest/kam-trunks-dialplan/

GET information about all KamTrunksDialplan

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'dpid': '', 
     'pr': '', 
     'match_op': '', 
     'match_exp': '', 
     'match_len': '', 
     'subst_exp': '', 
     'repl_exp': '', 
     'attrs': '', 
     'transformationRulesetGroupsTrunksId': ''
 },{
     'id': '', 
     'dpid': '', 
     'pr': '', 
     'match_op': '', 
     'match_exp': '', 
     'match_len': '', 
     'subst_exp': '', 
     'repl_exp': '', 
     'attrs': '', 
     'transformationRulesetGroupsTrunksId': ''
 }]

GET /rest/kam-trunks-dialplan/{id}

Get information about KamTrunksDialplan

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'dpid': '', 
     'pr': '', 
     'match_op': '', 
     'match_exp': '', 
     'match_len': '', 
     'subst_exp': '', 
     'repl_exp': '', 
     'attrs': '', 
     'transformationRulesetGroupsTrunksId': ''
 }

POST /rest/kam-trunks-dialplan/

Create's a new KamTrunksDialplan

Headers

Parameters

Name	Type	Required
dpid	int	Yes
pr	int	Yes
match_op	int	Yes
match_exp	varchar	Yes
match_len	int	Yes
subst_exp	varchar	Yes
repl_exp	varchar	Yes
attrs	varchar	Yes
transformationRulesetGroupsTrunksId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/kamtrunksdialplan/{id}

{}

PUT /rest/kam-trunks-dialplan/

Table KamTrunksDialplan

Headers

Parameters

Name	Type	Required
id	int	Yes
dpid	int	Yes
pr	int	Yes
match_op	int	Yes
match_exp	varchar	Yes
match_len	int	Yes
subst_exp	varchar	Yes
repl_exp	varchar	Yes
attrs	varchar	Yes
transformationRulesetGroupsTrunksId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/kam-trunks-dialplan/

Table KamTrunksDialplan

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamTrunksUacreg

GET /rest/kam-trunks-uacreg/

GET information about all KamTrunksUacreg

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'l_uuid': '', 
     'l_username': '', 
     'l_domain': '', 
     'r_username': '', 
     'r_domain': '', 
     'realm': '', 
     'auth_username': '', 
     'auth_password': '', 
     'auth_proxy': '', 
     'expires': '', 
     'flags': '', 
     'reg_delay': '', 
     'brandId': '', 
     'peeringContractId': '', 
     'multiDDI': ''
 },{
     'id': '', 
     'l_uuid': '', 
     'l_username': '', 
     'l_domain': '', 
     'r_username': '', 
     'r_domain': '', 
     'realm': '', 
     'auth_username': '', 
     'auth_password': '', 
     'auth_proxy': '', 
     'expires': '', 
     'flags': '', 
     'reg_delay': '', 
     'brandId': '', 
     'peeringContractId': '', 
     'multiDDI': ''
 }]

GET /rest/kam-trunks-uacreg/{id}

Get information about KamTrunksUacreg

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'l_uuid': '', 
     'l_username': '', 
     'l_domain': '', 
     'r_username': '', 
     'r_domain': '', 
     'realm': '', 
     'auth_username': '', 
     'auth_password': '', 
     'auth_proxy': '', 
     'expires': '', 
     'flags': '', 
     'reg_delay': '', 
     'brandId': '', 
     'peeringContractId': '', 
     'multiDDI': ''
 }

POST /rest/kam-trunks-uacreg/

Create's a new KamTrunksUacreg

Headers

Parameters

Name	Type	Required
l_uuid	varchar	Yes
l_username	varchar	Yes
l_domain	varchar	Yes
r_username	varchar	Yes
r_domain	varchar	Yes
realm	varchar	Yes
auth_username	varchar	Yes
auth_password	varchar	Yes
auth_proxy	varchar	Yes
expires	int	Yes
flags	int	Yes
reg_delay	int	Yes
brandId	int	Yes
peeringContractId	int	Yes
multiDDI	tinyint	Yes

Body

Headers

Response

HTTP 201

Location: /rest/kamtrunksuacreg/{id}

{}

PUT /rest/kam-trunks-uacreg/

Table KamTrunksUacreg

Headers

Parameters

Name	Type	Required
id	int	Yes
l_uuid	varchar	Yes
l_username	varchar	Yes
l_domain	varchar	Yes
r_username	varchar	Yes
r_domain	varchar	Yes
realm	varchar	Yes
auth_username	varchar	Yes
auth_password	varchar	Yes
auth_proxy	varchar	Yes
expires	int	Yes
flags	int	Yes
reg_delay	int	Yes
brandId	int	Yes
peeringContractId	int	Yes
multiDDI	tinyint	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/kam-trunks-uacreg/

Table KamTrunksUacreg

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamUsersAddress

GET /rest/kam-users-address/

GET information about all KamUsersAddress

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'source_address': '', 
     'ip_addr': '', 
     'mask': '', 
     'port': '', 
     'tag': '', 
     'description': ''
 },{
     'id': '', 
     'companyId': '', 
     'source_address': '', 
     'ip_addr': '', 
     'mask': '', 
     'port': '', 
     'tag': '', 
     'description': ''
 }]

GET /rest/kam-users-address/{id}

Get information about KamUsersAddress

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'source_address': '', 
     'ip_addr': '', 
     'mask': '', 
     'port': '', 
     'tag': '', 
     'description': ''
 }

POST /rest/kam-users-address/

Create's a new KamUsersAddress

Headers

Parameters

Name	Type	Required
companyId	int	Yes
source_address	varchar	Yes
ip_addr	varchar	No
mask	int	Yes
port	int	Yes
tag	varchar	No
description	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/kamusersaddress/{id}

{}

PUT /rest/kam-users-address/

Table KamUsersAddress

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
source_address	varchar	Yes
ip_addr	varchar	No
mask	int	Yes
port	int	Yes
tag	varchar	No
description	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/kam-users-address/

Table KamUsersAddress

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamUsersDomainAttrs

GET /rest/kam-users-domain-attrs/

GET information about all KamUsersDomainAttrs

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'did': '', 
     'name': '', 
     'type': '', 
     'value': '', 
     'last_modified': ''
 },{
     'id': '', 
     'did': '', 
     'name': '', 
     'type': '', 
     'value': '', 
     'last_modified': ''
 }]

GET /rest/kam-users-domain-attrs/{id}

Get information about KamUsersDomainAttrs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'did': '', 
     'name': '', 
     'type': '', 
     'value': '', 
     'last_modified': ''
 }

POST /rest/kam-users-domain-attrs/

Create's a new KamUsersDomainAttrs

Headers

Parameters

Name	Type	Required
did	varchar	Yes
name	varchar	Yes
type	int	Yes
value	varchar	Yes
last_modified	datetime	Yes

Body

Headers

Response

HTTP 201

Location: /rest/kamusersdomainattrs/{id}

{}

PUT /rest/kam-users-domain-attrs/

Table KamUsersDomainAttrs

Headers

Parameters

Name	Type	Required
id	int	Yes
did	varchar	Yes
name	varchar	Yes
type	int	Yes
value	varchar	Yes
last_modified	datetime	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/kam-users-domain-attrs/

Table KamUsersDomainAttrs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

KamUsersLocation

GET /rest/kam-users-location/

GET information about all KamUsersLocation

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'ruid': '', 
     'username': '', 
     'domain': '', 
     'contact': '', 
     'received': '', 
     'path': '', 
     'expires': '', 
     'q': '', 
     'callid': '', 
     'cseq': '', 
     'last_modified': '', 
     'flags': '', 
     'cflags': '', 
     'user_agent': '', 
     'socket': '', 
     'methods': '', 
     'instance': '', 
     'reg_id': '', 
     'server_id': '', 
     'connection_id': '', 
     'keepalive': '', 
     'partition': ''
 },{
     'id': '', 
     'ruid': '', 
     'username': '', 
     'domain': '', 
     'contact': '', 
     'received': '', 
     'path': '', 
     'expires': '', 
     'q': '', 
     'callid': '', 
     'cseq': '', 
     'last_modified': '', 
     'flags': '', 
     'cflags': '', 
     'user_agent': '', 
     'socket': '', 
     'methods': '', 
     'instance': '', 
     'reg_id': '', 
     'server_id': '', 
     'connection_id': '', 
     'keepalive': '', 
     'partition': ''
 }]

GET /rest/kam-users-location/{id}

Get information about KamUsersLocation

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'ruid': '', 
     'username': '', 
     'domain': '', 
     'contact': '', 
     'received': '', 
     'path': '', 
     'expires': '', 
     'q': '', 
     'callid': '', 
     'cseq': '', 
     'last_modified': '', 
     'flags': '', 
     'cflags': '', 
     'user_agent': '', 
     'socket': '', 
     'methods': '', 
     'instance': '', 
     'reg_id': '', 
     'server_id': '', 
     'connection_id': '', 
     'keepalive': '', 
     'partition': ''
 }

POST /rest/kam-users-location/

Create's a new KamUsersLocation

Headers

Parameters

Name	Type	Required
ruid	varchar	Yes
username	varchar	Yes
domain	varchar	No
contact	varchar	Yes
received	varchar	No
path	varchar	No
expires	datetime	Yes
q	float	Yes
callid	varchar	Yes
cseq	int	Yes
last_modified	datetime	Yes
flags	int	Yes
cflags	int	Yes
user_agent	varchar	Yes
socket	varchar	No
methods	int	No
instance	varchar	No
reg_id	int	Yes
server_id	int	Yes
connection_id	int	Yes
keepalive	int	Yes
partition	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/kamuserslocation/{id}

{}

PUT /rest/kam-users-location/

Table KamUsersLocation

Headers

Parameters

Name	Type	Required
id	int	Yes
ruid	varchar	Yes
username	varchar	Yes
domain	varchar	No
contact	varchar	Yes
received	varchar	No
path	varchar	No
expires	datetime	Yes
q	float	Yes
callid	varchar	Yes
cseq	int	Yes
last_modified	datetime	Yes
flags	int	Yes
cflags	int	Yes
user_agent	varchar	Yes
socket	varchar	No
methods	int	No
instance	varchar	No
reg_id	int	Yes
server_id	int	Yes
connection_id	int	Yes
keepalive	int	Yes
partition	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/kam-users-location/

Table KamUsersLocation

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Languages

GET /rest/languages/

GET information about all Languages

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'iden': '', 
     'name': '', 
     'name_en': '', 
     'name_es': ''
 },{
     'id': '', 
     'iden': '', 
     'name': '', 
     'name_en': '', 
     'name_es': ''
 }]

GET /rest/languages/{id}

Get information about Languages

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'iden': '', 
     'name': '', 
     'name_en': '', 
     'name_es': ''
 }

POST /rest/languages/

Create's a new Languages

Headers

Parameters

Name	Type	Required	Description
iden	varchar	Yes
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/languages/{id}

{}

PUT /rest/languages/

Table Languages

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
iden	varchar	Yes
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/languages/

Table Languages

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

LcrGateways

GET /rest/lcr-gateways/

GET information about all LcrGateways

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'lcr_id': '', 
     'gw_name': '', 
     'ip': '', 
     'hostname': '', 
     'port': '', 
     'params': '', 
     'uri_scheme': '', 
     'transport': '', 
     'strip': '', 
     'prefix': '', 
     'tag': '', 
     'flags': '', 
     'defunct': '', 
     'peerServerId': ''
 },{
     'id': '', 
     'lcr_id': '', 
     'gw_name': '', 
     'ip': '', 
     'hostname': '', 
     'port': '', 
     'params': '', 
     'uri_scheme': '', 
     'transport': '', 
     'strip': '', 
     'prefix': '', 
     'tag': '', 
     'flags': '', 
     'defunct': '', 
     'peerServerId': ''
 }]

GET /rest/lcr-gateways/{id}

Get information about LcrGateways

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'lcr_id': '', 
     'gw_name': '', 
     'ip': '', 
     'hostname': '', 
     'port': '', 
     'params': '', 
     'uri_scheme': '', 
     'transport': '', 
     'strip': '', 
     'prefix': '', 
     'tag': '', 
     'flags': '', 
     'defunct': '', 
     'peerServerId': ''
 }

POST /rest/lcr-gateways/

Create's a new LcrGateways

Headers

Parameters

Name	Type	Required
lcr_id	int	Yes
gw_name	varchar	Yes
ip	varchar	No
hostname	varchar	No
port	smallint	No
params	varchar	No
uri_scheme	tinyint	No
transport	tinyint	No
strip	tinyint	No
prefix	varchar	No
tag	varchar	No
flags	int	Yes
defunct	int	No
peerServerId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/lcrgateways/{id}

{}

PUT /rest/lcr-gateways/

Table LcrGateways

Headers

Parameters

Name	Type	Required
id	int	Yes
lcr_id	int	Yes
gw_name	varchar	Yes
ip	varchar	No
hostname	varchar	No
port	smallint	No
params	varchar	No
uri_scheme	tinyint	No
transport	tinyint	No
strip	tinyint	No
prefix	varchar	No
tag	varchar	No
flags	int	Yes
defunct	int	No
peerServerId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/lcr-gateways/

Table LcrGateways

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

LcrRuleTargets

GET /rest/lcr-rule-targets/

GET information about all LcrRuleTargets

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'lcr_id': '', 
     'rule_id': '', 
     'gw_id': '', 
     'priority': '', 
     'weight': '', 
     'outgoingRoutingId': ''
 },{
     'id': '', 
     'lcr_id': '', 
     'rule_id': '', 
     'gw_id': '', 
     'priority': '', 
     'weight': '', 
     'outgoingRoutingId': ''
 }]

GET /rest/lcr-rule-targets/{id}

Get information about LcrRuleTargets

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'lcr_id': '', 
     'rule_id': '', 
     'gw_id': '', 
     'priority': '', 
     'weight': '', 
     'outgoingRoutingId': ''
 }

POST /rest/lcr-rule-targets/

Create's a new LcrRuleTargets

Headers

Parameters

Name	Type	Required
lcr_id	int	Yes
rule_id	int	Yes
gw_id	int	Yes
priority	tinyint	Yes
weight	int	Yes
outgoingRoutingId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/lcrruletargets/{id}

{}

PUT /rest/lcr-rule-targets/

Table LcrRuleTargets

Headers

Parameters

Name	Type	Required
id	int	Yes
lcr_id	int	Yes
rule_id	int	Yes
gw_id	int	Yes
priority	tinyint	Yes
weight	int	Yes
outgoingRoutingId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/lcr-rule-targets/

Table LcrRuleTargets

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

LcrRules

GET /rest/lcr-rules/

GET information about all LcrRules

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'lcr_id': '', 
     'prefix': '', 
     'from_uri': '', 
     'request_uri': '', 
     'stopper': '', 
     'enabled': '', 
     'tag': '', 
     'description': '', 
     'routingPatternId': '', 
     'outgoingRoutingId': ''
 },{
     'id': '', 
     'lcr_id': '', 
     'prefix': '', 
     'from_uri': '', 
     'request_uri': '', 
     'stopper': '', 
     'enabled': '', 
     'tag': '', 
     'description': '', 
     'routingPatternId': '', 
     'outgoingRoutingId': ''
 }]

GET /rest/lcr-rules/{id}

Get information about LcrRules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'lcr_id': '', 
     'prefix': '', 
     'from_uri': '', 
     'request_uri': '', 
     'stopper': '', 
     'enabled': '', 
     'tag': '', 
     'description': '', 
     'routingPatternId': '', 
     'outgoingRoutingId': ''
 }

POST /rest/lcr-rules/

Create's a new LcrRules

Headers

Parameters

Name	Type	Required
lcr_id	int	Yes
prefix	varchar	No
from_uri	varchar	No
request_uri	varchar	No
stopper	int	Yes
enabled	int	Yes
tag	varchar	Yes
description	varchar	Yes
routingPatternId	int	No
outgoingRoutingId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/lcrrules/{id}

{}

PUT /rest/lcr-rules/

Table LcrRules

Headers

Parameters

Name	Type	Required
id	int	Yes
lcr_id	int	Yes
prefix	varchar	No
from_uri	varchar	No
request_uri	varchar	No
stopper	int	Yes
enabled	int	Yes
tag	varchar	Yes
description	varchar	Yes
routingPatternId	int	No
outgoingRoutingId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/lcr-rules/

Table LcrRules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Locutions

GET /rest/locutions/

GET information about all Locutions

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'originalFile': '', 
     'encodedFile': '', 
     'status': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'originalFile': '', 
     'encodedFile': '', 
     'status': ''
 }]

GET /rest/locutions/{id}

Get information about Locutions

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'originalFile': '', 
     'encodedFile': '', 
     'status': ''
 }

POST /rest/locutions/

Create's a new Locutions

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
originalFile	int	No	[FSO:keepExtension]
encodedFile	int	No	[FSO:keepExtension]
status	varchar	No	[enum:pending\|encoding\|ready\|error]

Body

Headers

Response

HTTP 201

Location: /rest/locutions/{id}

{}

PUT /rest/locutions/

Table Locutions

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
originalFile	int	No	[FSO:keepExtension]
encodedFile	int	No	[FSO:keepExtension]
status	varchar	No	[enum:pending\|encoding\|ready\|error]

Body

Headers

Response

HTTP 200

{}

DELETE /rest/locutions/

Table Locutions

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

MainOperators

GET /rest/main-operators/

GET information about all MainOperators

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'username': '', 
     'pass': '', 
     'email': '', 
     'active': '', 
     'timezoneId': '', 
     'name': '', 
     'lastname': ''
 },{
     'id': '', 
     'username': '', 
     'pass': '', 
     'email': '', 
     'active': '', 
     'timezoneId': '', 
     'name': '', 
     'lastname': ''
 }]

GET /rest/main-operators/{id}

Get information about MainOperators

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'username': '', 
     'pass': '', 
     'email': '', 
     'active': '', 
     'timezoneId': '', 
     'name': '', 
     'lastname': ''
 }

POST /rest/main-operators/

Create's a new MainOperators

Headers

Parameters

Name	Type	Required	Description
username	varchar	Yes
pass	varchar	Yes	[password]
email	varchar	Yes
active	tinyint	Yes
timezoneId	int	No
name	varchar	No
lastname	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/mainoperators/{id}

{}

PUT /rest/main-operators/

Table MainOperators

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
username	varchar	Yes
pass	varchar	Yes	[password]
email	varchar	Yes
active	tinyint	Yes
timezoneId	int	No
name	varchar	No
lastname	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/main-operators/

Table MainOperators

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

MatchListPatterns

GET /rest/match-list-patterns/

GET information about all MatchListPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'matchListId': '', 
     'description': '', 
     'type': '', 
     'regExp': '', 
     'numberCountryId': '', 
     'numberValue': ''
 },{
     'id': '', 
     'matchListId': '', 
     'description': '', 
     'type': '', 
     'regExp': '', 
     'numberCountryId': '', 
     'numberValue': ''
 }]

GET /rest/match-list-patterns/{id}

Get information about MatchListPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'matchListId': '', 
     'description': '', 
     'type': '', 
     'regExp': '', 
     'numberCountryId': '', 
     'numberValue': ''
 }

POST /rest/match-list-patterns/

Create's a new MatchListPatterns

Headers

Parameters

Name	Type	Required	Description
matchListId	int	Yes
description	varchar	No
type	varchar	Yes	[enum:number\|regexp]
regExp	varchar	No
numberCountryId	int	No
numberValue	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/matchlistpatterns/{id}

{}

PUT /rest/match-list-patterns/

Table MatchListPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
matchListId	int	Yes
description	varchar	No
type	varchar	Yes	[enum:number\|regexp]
regExp	varchar	No
numberCountryId	int	No
numberValue	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/match-list-patterns/

Table MatchListPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

MatchLists

GET /rest/match-lists/

GET information about all MatchLists

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': ''
 }]

GET /rest/match-lists/{id}

Get information about MatchLists

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': ''
 }

POST /rest/match-lists/

Create's a new MatchLists

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/matchlists/{id}

{}

PUT /rest/match-lists/

Table MatchLists

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
name	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/match-lists/

Table MatchLists

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

MediaRelaySets

GET /rest/media-relay-sets/

GET information about all MediaRelaySets

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'description': ''
 },{
     'id': '', 
     'name': '', 
     'description': ''
 }]

GET /rest/media-relay-sets/{id}

Get information about MediaRelaySets

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'description': ''
 }

POST /rest/media-relay-sets/

Create's a new MediaRelaySets

Headers

Parameters

Name	Type	Required	Description
name	varchar	Yes
description	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/mediarelaysets/{id}

{}

PUT /rest/media-relay-sets/

Table MediaRelaySets

Headers

Parameters

Name	Type	Required
id	int	Yes
name	varchar	Yes
description	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/media-relay-sets/

Table MediaRelaySets

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

MusicOnHold

GET /rest/music-on-hold/

GET information about all MusicOnHold

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'originalFile': '', 
     'encodedFile': '', 
     'status': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'originalFile': '', 
     'encodedFile': '', 
     'status': ''
 }]

GET /rest/music-on-hold/{id}

Get information about MusicOnHold

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'originalFile': '', 
     'encodedFile': '', 
     'status': ''
 }

POST /rest/music-on-hold/

Create's a new MusicOnHold

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
originalFile	int	No	[FSO:keepExtension]
encodedFile	int	No	[FSO:keepExtension\|storeInBaseFolder]
status	varchar	No	[enum:pending\|encoding\|ready\|error]

Body

Headers

Response

HTTP 201

Location: /rest/musiconhold/{id}

{}

PUT /rest/music-on-hold/

Table MusicOnHold

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
originalFile	int	No	[FSO:keepExtension]
encodedFile	int	No	[FSO:keepExtension\|storeInBaseFolder]
status	varchar	No	[enum:pending\|encoding\|ready\|error]

Body

Headers

Response

HTTP 200

{}

DELETE /rest/music-on-hold/

Table MusicOnHold

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

OutgoingDDIRules

GET /rest/outgoing-d-d-i-rules/

GET information about all OutgoingDDIRules

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'defaultAction': '', 
     'forcedDDIId': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'defaultAction': '', 
     'forcedDDIId': ''
 }]

GET /rest/outgoing-d-d-i-rules/{id}

Get information about OutgoingDDIRules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'defaultAction': '', 
     'forcedDDIId': ''
 }

POST /rest/outgoing-d-d-i-rules/

Create's a new OutgoingDDIRules

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
defaultAction	varchar	Yes	[enum:keep\|force]
forcedDDIId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/outgoingddirules/{id}

{}

PUT /rest/outgoing-d-d-i-rules/

Table OutgoingDDIRules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
defaultAction	varchar	Yes	[enum:keep\|force]
forcedDDIId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/outgoing-d-d-i-rules/

Table OutgoingDDIRules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

OutgoingDDIRulesPatterns

GET /rest/outgoing-d-d-i-rules-patterns/

GET information about all OutgoingDDIRulesPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'outgoingDDIRuleId': '', 
     'matchListId': '', 
     'action': '', 
     'forcedDDIId': '', 
     'priority': ''
 },{
     'id': '', 
     'outgoingDDIRuleId': '', 
     'matchListId': '', 
     'action': '', 
     'forcedDDIId': '', 
     'priority': ''
 }]

GET /rest/outgoing-d-d-i-rules-patterns/{id}

Get information about OutgoingDDIRulesPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'outgoingDDIRuleId': '', 
     'matchListId': '', 
     'action': '', 
     'forcedDDIId': '', 
     'priority': ''
 }

POST /rest/outgoing-d-d-i-rules-patterns/

Create's a new OutgoingDDIRulesPatterns

Headers

Parameters

Name	Type	Required	Description
outgoingDDIRuleId	int	Yes
matchListId	int	Yes
action	varchar	Yes	[enum:keep\|force]
forcedDDIId	int	No
priority	smallint	Yes

Body

Headers

Response

HTTP 201

Location: /rest/outgoingddirulespatterns/{id}

{}

PUT /rest/outgoing-d-d-i-rules-patterns/

Table OutgoingDDIRulesPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
outgoingDDIRuleId	int	Yes
matchListId	int	Yes
action	varchar	Yes	[enum:keep\|force]
forcedDDIId	int	No
priority	smallint	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/outgoing-d-d-i-rules-patterns/

Table OutgoingDDIRulesPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

OutgoingRouting

GET /rest/outgoing-routing/

GET information about all OutgoingRouting

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'type': '', 
     'routingPatternId': '', 
     'routingPatternGroupId': '', 
     'peeringContractId': '', 
     'priority': '', 
     'weight': '', 
     'companyId': '', 
     'brandId': ''
 },{
     'id': '', 
     'type': '', 
     'routingPatternId': '', 
     'routingPatternGroupId': '', 
     'peeringContractId': '', 
     'priority': '', 
     'weight': '', 
     'companyId': '', 
     'brandId': ''
 }]

GET /rest/outgoing-routing/{id}

Get information about OutgoingRouting

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'type': '', 
     'routingPatternId': '', 
     'routingPatternGroupId': '', 
     'peeringContractId': '', 
     'priority': '', 
     'weight': '', 
     'companyId': '', 
     'brandId': ''
 }

POST /rest/outgoing-routing/

Create's a new OutgoingRouting

Headers

Parameters

Name	Type	Required
type	enum('pattern','group','fax'	No
routingPatternId	int	No
routingPatternGroupId	int	No
peeringContractId	int	Yes
priority	tinyint	Yes
weight	int	Yes
companyId	int	No
brandId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/outgoingrouting/{id}

{}

PUT /rest/outgoing-routing/

Table OutgoingRouting

Headers

Parameters

Name	Type	Required
id	int	Yes
type	enum('pattern','group','fax'	No
routingPatternId	int	No
routingPatternGroupId	int	No
peeringContractId	int	Yes
priority	tinyint	Yes
weight	int	Yes
companyId	int	No
brandId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/outgoing-routing/

Table OutgoingRouting

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ParsedCDRs

GET /rest/parsed-c-d-rs/

GET information about all ParsedCDRs

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'statId': '', 
     'xstatId': '', 
     'statType': '', 
     'initialLeg': '', 
     'initialLegHash': '', 
     'cid': '', 
     'cidHash': '', 
     'xcid': '', 
     'xcidHash': '', 
     'proxies': '', 
     'type': '', 
     'subtype': '', 
     'calldate': '', 
     'duration': '', 
     'aParty': '', 
     'bParty': '', 
     'caller': '', 
     'callee': '', 
     'xCaller': '', 
     'xCallee': '', 
     'initialReferrer': '', 
     'referrer': '', 
     'referee': '', 
     'lastForwarder': '', 
     'brandId': '', 
     'companyId': '', 
     'peeringContractId': ''
 },{
     'id': '', 
     'statId': '', 
     'xstatId': '', 
     'statType': '', 
     'initialLeg': '', 
     'initialLegHash': '', 
     'cid': '', 
     'cidHash': '', 
     'xcid': '', 
     'xcidHash': '', 
     'proxies': '', 
     'type': '', 
     'subtype': '', 
     'calldate': '', 
     'duration': '', 
     'aParty': '', 
     'bParty': '', 
     'caller': '', 
     'callee': '', 
     'xCaller': '', 
     'xCallee': '', 
     'initialReferrer': '', 
     'referrer': '', 
     'referee': '', 
     'lastForwarder': '', 
     'brandId': '', 
     'companyId': '', 
     'peeringContractId': ''
 }]

GET /rest/parsed-c-d-rs/{id}

Get information about ParsedCDRs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'statId': '', 
     'xstatId': '', 
     'statType': '', 
     'initialLeg': '', 
     'initialLegHash': '', 
     'cid': '', 
     'cidHash': '', 
     'xcid': '', 
     'xcidHash': '', 
     'proxies': '', 
     'type': '', 
     'subtype': '', 
     'calldate': '', 
     'duration': '', 
     'aParty': '', 
     'bParty': '', 
     'caller': '', 
     'callee': '', 
     'xCaller': '', 
     'xCallee': '', 
     'initialReferrer': '', 
     'referrer': '', 
     'referee': '', 
     'lastForwarder': '', 
     'brandId': '', 
     'companyId': '', 
     'peeringContractId': ''
 }

POST /rest/parsed-c-d-rs/

Create's a new ParsedCDRs

Headers

Parameters

Name	Type	Required
statId	int	No
xstatId	int	No
statType	varchar	No
initialLeg	varchar	No
initialLegHash	varchar	No
cid	varchar	No
cidHash	varchar	No
xcid	varchar	No
xcidHash	varchar	No
proxies	varchar	No
type	varchar	No
subtype	varchar	No
calldate	timestamp	Yes
duration	int	No
aParty	varchar	No
bParty	varchar	No
caller	varchar	No
callee	varchar	No
xCaller	varchar	No
xCallee	varchar	No
initialReferrer	varchar	No
referrer	varchar	No
referee	varchar	No
lastForwarder	varchar	No
brandId	int	No
companyId	int	No
peeringContractId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/parsedcdrs/{id}

{}

PUT /rest/parsed-c-d-rs/

Table ParsedCDRs

Headers

Parameters

Name	Type	Required
id	int	Yes
statId	int	No
xstatId	int	No
statType	varchar	No
initialLeg	varchar	No
initialLegHash	varchar	No
cid	varchar	No
cidHash	varchar	No
xcid	varchar	No
xcidHash	varchar	No
proxies	varchar	No
type	varchar	No
subtype	varchar	No
calldate	timestamp	Yes
duration	int	No
aParty	varchar	No
bParty	varchar	No
caller	varchar	No
callee	varchar	No
xCaller	varchar	No
xCallee	varchar	No
initialReferrer	varchar	No
referrer	varchar	No
referee	varchar	No
lastForwarder	varchar	No
brandId	int	No
companyId	int	No
peeringContractId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/parsed-c-d-rs/

Table ParsedCDRs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

PeerServers

GET /rest/peer-servers/

GET information about all PeerServers

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'peeringContractId': '', 
     'ip': '', 
     'brandId': '', 
     'hostname': '', 
     'port': '', 
     'params': '', 
     'uri_scheme': '', 
     'transport': '', 
     'strip': '', 
     'prefix': '', 
     'sendPAI': '', 
     'sendRPID': '', 
     'auth_needed': '', 
     'auth_user': '', 
     'auth_password': '', 
     'sip_proxy': '', 
     'outbound_proxy': '', 
     'from_user': '', 
     'from_domain': ''
 },{
     'id': '', 
     'peeringContractId': '', 
     'ip': '', 
     'brandId': '', 
     'hostname': '', 
     'port': '', 
     'params': '', 
     'uri_scheme': '', 
     'transport': '', 
     'strip': '', 
     'prefix': '', 
     'sendPAI': '', 
     'sendRPID': '', 
     'auth_needed': '', 
     'auth_user': '', 
     'auth_password': '', 
     'sip_proxy': '', 
     'outbound_proxy': '', 
     'from_user': '', 
     'from_domain': ''
 }]

GET /rest/peer-servers/{id}

Get information about PeerServers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'peeringContractId': '', 
     'ip': '', 
     'brandId': '', 
     'hostname': '', 
     'port': '', 
     'params': '', 
     'uri_scheme': '', 
     'transport': '', 
     'strip': '', 
     'prefix': '', 
     'sendPAI': '', 
     'sendRPID': '', 
     'auth_needed': '', 
     'auth_user': '', 
     'auth_password': '', 
     'sip_proxy': '', 
     'outbound_proxy': '', 
     'from_user': '', 
     'from_domain': ''
 }

POST /rest/peer-servers/

Create's a new PeerServers

Headers

Parameters

Name	Type	Required
peeringContractId	int	Yes
ip	varchar	No
brandId	int	Yes
hostname	varchar	No
port	smallint	No
params	varchar	No
uri_scheme	tinyint	No
transport	tinyint	No
strip	tinyint	No
prefix	varchar	No
sendPAI	tinyint	No
sendRPID	tinyint	No
auth_needed	enum('yes','no'	Yes
auth_user	varchar	No
auth_password	varchar	No
sip_proxy	varchar	No
outbound_proxy	varchar	No
from_user	varchar	No
from_domain	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/peerservers/{id}

{}

PUT /rest/peer-servers/

Table PeerServers

Headers

Parameters

Name	Type	Required
id	int	Yes
peeringContractId	int	Yes
ip	varchar	No
brandId	int	Yes
hostname	varchar	No
port	smallint	No
params	varchar	No
uri_scheme	tinyint	No
transport	tinyint	No
strip	tinyint	No
prefix	varchar	No
sendPAI	tinyint	No
sendRPID	tinyint	No
auth_needed	enum('yes','no'	Yes
auth_user	varchar	No
auth_password	varchar	No
sip_proxy	varchar	No
outbound_proxy	varchar	No
from_user	varchar	No
from_domain	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/peer-servers/

Table PeerServers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

PeeringContracts

GET /rest/peering-contracts/

GET information about all PeeringContracts

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'description': '', 
     'name': '', 
     'transformationRulesetGroupsTrunksId': '', 
     'externallyRated': ''
 },{
     'id': '', 
     'brandId': '', 
     'description': '', 
     'name': '', 
     'transformationRulesetGroupsTrunksId': '', 
     'externallyRated': ''
 }]

GET /rest/peering-contracts/{id}

Get information about PeeringContracts

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'description': '', 
     'name': '', 
     'transformationRulesetGroupsTrunksId': '', 
     'externallyRated': ''
 }

POST /rest/peering-contracts/

Create's a new PeeringContracts

Headers

Parameters

Name	Type	Required
brandId	int	Yes
description	varchar	Yes
name	varchar	Yes
transformationRulesetGroupsTrunksId	int	No
externallyRated	tinyint	No

Body

Headers

Response

HTTP 201

Location: /rest/peeringcontracts/{id}

{}

PUT /rest/peering-contracts/

Table PeeringContracts

Headers

Parameters

Name	Type	Required
id	int	Yes
brandId	int	Yes
description	varchar	Yes
name	varchar	Yes
transformationRulesetGroupsTrunksId	int	No
externallyRated	tinyint	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/peering-contracts/

Table PeeringContracts

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

PickUpGroups

GET /rest/pick-up-groups/

GET information about all PickUpGroups

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'companyId': ''
 },{
     'id': '', 
     'name': '', 
     'companyId': ''
 }]

GET /rest/pick-up-groups/{id}

Get information about PickUpGroups

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'companyId': ''
 }

POST /rest/pick-up-groups/

Create's a new PickUpGroups

Headers

Parameters

Name	Type	Required	Description
name	varchar	Yes
companyId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/pickupgroups/{id}

{}

PUT /rest/pick-up-groups/

Table PickUpGroups

Headers

Parameters

Name	Type	Required
id	int	Yes
name	varchar	Yes
companyId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/pick-up-groups/

Table PickUpGroups

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

PickUpRelUsers

GET /rest/pick-up-rel-users/

GET information about all PickUpRelUsers

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'pickUpGroupId': '', 
     'userId': ''
 },{
     'id': '', 
     'pickUpGroupId': '', 
     'userId': ''
 }]

GET /rest/pick-up-rel-users/{id}

Get information about PickUpRelUsers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'pickUpGroupId': '', 
     'userId': ''
 }

POST /rest/pick-up-rel-users/

Create's a new PickUpRelUsers

Headers

Parameters

Name	Type	Required	Description
pickUpGroupId	int	Yes
userId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/pickuprelusers/{id}

{}

PUT /rest/pick-up-rel-users/

Table PickUpRelUsers

Headers

Parameters

Name	Type	Required
id	int	Yes
pickUpGroupId	int	Yes
userId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/pick-up-rel-users/

Table PickUpRelUsers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

PricingPlans

GET /rest/pricing-plans/

GET information about all PricingPlans

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'createdOn': '', 
     'brandId': ''
 },{
     'id': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'createdOn': '', 
     'brandId': ''
 }]

GET /rest/pricing-plans/{id}

Get information about PricingPlans

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'createdOn': '', 
     'brandId': ''
 }

POST /rest/pricing-plans/

Create's a new PricingPlans

Headers

Parameters

Name	Type	Required	Description
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes
description	varchar	Yes	[ml]
description_en	varchar	Yes
description_es	varchar	Yes
createdOn	timestamp	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/pricingplans/{id}

{}

PUT /rest/pricing-plans/

Table PricingPlans

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes
description	varchar	Yes	[ml]
description_en	varchar	Yes
description_es	varchar	Yes
createdOn	timestamp	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/pricing-plans/

Table PricingPlans

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

PricingPlansRelCompanies

GET /rest/pricing-plans-rel-companies/

GET information about all PricingPlansRelCompanies

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'pricingPlanId': '', 
     'companyId': '', 
     'validFrom': '', 
     'validTo': '', 
     'metric': '', 
     'brandId': ''
 },{
     'id': '', 
     'pricingPlanId': '', 
     'companyId': '', 
     'validFrom': '', 
     'validTo': '', 
     'metric': '', 
     'brandId': ''
 }]

GET /rest/pricing-plans-rel-companies/{id}

Get information about PricingPlansRelCompanies

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'pricingPlanId': '', 
     'companyId': '', 
     'validFrom': '', 
     'validTo': '', 
     'metric': '', 
     'brandId': ''
 }

POST /rest/pricing-plans-rel-companies/

Create's a new PricingPlansRelCompanies

Headers

Parameters

Name	Type	Required
pricingPlanId	int	Yes
companyId	int	Yes
validFrom	datetime	Yes
validTo	datetime	Yes
metric	int	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/pricingplansrelcompanies/{id}

{}

PUT /rest/pricing-plans-rel-companies/

Table PricingPlansRelCompanies

Headers

Parameters

Name	Type	Required
id	int	Yes
pricingPlanId	int	Yes
companyId	int	Yes
validFrom	datetime	Yes
validTo	datetime	Yes
metric	int	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/pricing-plans-rel-companies/

Table PricingPlansRelCompanies

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

PricingPlansRelTargetPatterns

GET /rest/pricing-plans-rel-target-patterns/

GET information about all PricingPlansRelTargetPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'connectionCharge': '', 
     'periodTime': '', 
     'perPeriodCharge': '', 
     'pricingPlanId': '', 
     'targetPatternId': '', 
     'brandId': ''
 },{
     'id': '', 
     'connectionCharge': '', 
     'periodTime': '', 
     'perPeriodCharge': '', 
     'pricingPlanId': '', 
     'targetPatternId': '', 
     'brandId': ''
 }]

GET /rest/pricing-plans-rel-target-patterns/{id}

Get information about PricingPlansRelTargetPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'connectionCharge': '', 
     'periodTime': '', 
     'perPeriodCharge': '', 
     'pricingPlanId': '', 
     'targetPatternId': '', 
     'brandId': ''
 }

POST /rest/pricing-plans-rel-target-patterns/

Create's a new PricingPlansRelTargetPatterns

Headers

Parameters

Name	Type	Required
connectionCharge	decimal	Yes
periodTime	mediumint	Yes
perPeriodCharge	decimal	Yes
pricingPlanId	int	Yes
targetPatternId	int	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/pricingplansreltargetpatterns/{id}

{}

PUT /rest/pricing-plans-rel-target-patterns/

Table PricingPlansRelTargetPatterns

Headers

Parameters

Name	Type	Required
id	int	Yes
connectionCharge	decimal	Yes
periodTime	mediumint	Yes
perPeriodCharge	decimal	Yes
pricingPlanId	int	Yes
targetPatternId	int	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/pricing-plans-rel-target-patterns/

Table PricingPlansRelTargetPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ProxyTrunks

GET /rest/proxy-trunks/

GET information about all ProxyTrunks

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'ip': ''
 },{
     'id': '', 
     'name': '', 
     'ip': ''
 }]

GET /rest/proxy-trunks/{id}

Get information about ProxyTrunks

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'ip': ''
 }

POST /rest/proxy-trunks/

Create's a new ProxyTrunks

Headers

Parameters

Name	Type	Required	Description
name	varchar	No
ip	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/proxytrunks/{id}

{}

PUT /rest/proxy-trunks/

Table ProxyTrunks

Headers

Parameters

Name	Type	Required
id	int	Yes
name	varchar	No
ip	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/proxy-trunks/

Table ProxyTrunks

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

ProxyUsers

GET /rest/proxy-users/

GET information about all ProxyUsers

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'ip': ''
 },{
     'id': '', 
     'name': '', 
     'ip': ''
 }]

GET /rest/proxy-users/{id}

Get information about ProxyUsers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'ip': ''
 }

POST /rest/proxy-users/

Create's a new ProxyUsers

Headers

Parameters

Name	Type	Required	Description
name	varchar	No
ip	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/proxyusers/{id}

{}

PUT /rest/proxy-users/

Table ProxyUsers

Headers

Parameters

Name	Type	Required
id	int	Yes
name	varchar	No
ip	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/proxy-users/

Table ProxyUsers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

QueueMembers

GET /rest/queue-members/

GET information about all QueueMembers

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'queueId': '', 
     'userId': '', 
     'penalty': ''
 },{
     'id': '', 
     'queueId': '', 
     'userId': '', 
     'penalty': ''
 }]

GET /rest/queue-members/{id}

Get information about QueueMembers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'queueId': '', 
     'userId': '', 
     'penalty': ''
 }

POST /rest/queue-members/

Create's a new QueueMembers

Headers

Parameters

Name	Type	Required
queueId	int	No
userId	int	No
penalty	int	No

Body

Headers

Response

HTTP 201

Location: /rest/queuemembers/{id}

{}

PUT /rest/queue-members/

Table QueueMembers

Headers

Parameters

Name	Type	Required
id	int	Yes
queueId	int	No
userId	int	No
penalty	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/queue-members/

Table QueueMembers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Queues

GET /rest/queues/

GET information about all Queues

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'maxWaitTime': '', 
     'timeoutLocutionId': '', 
     'timeoutTargetType': '', 
     'timeoutNumberValue': '', 
     'timeoutExtensionId': '', 
     'timeoutVoiceMailUserId': '', 
     'maxlen': '', 
     'fullLocutionId': '', 
     'fullTargetType': '', 
     'fullNumberValue': '', 
     'fullExtensionId': '', 
     'fullVoiceMailUserId': '', 
     'periodicAnnounceLocutionId': '', 
     'periodicAnnounceFrequency': '', 
     'memberCallRest': '', 
     'memberCallTimeout': '', 
     'strategy': '', 
     'weight': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'maxWaitTime': '', 
     'timeoutLocutionId': '', 
     'timeoutTargetType': '', 
     'timeoutNumberValue': '', 
     'timeoutExtensionId': '', 
     'timeoutVoiceMailUserId': '', 
     'maxlen': '', 
     'fullLocutionId': '', 
     'fullTargetType': '', 
     'fullNumberValue': '', 
     'fullExtensionId': '', 
     'fullVoiceMailUserId': '', 
     'periodicAnnounceLocutionId': '', 
     'periodicAnnounceFrequency': '', 
     'memberCallRest': '', 
     'memberCallTimeout': '', 
     'strategy': '', 
     'weight': ''
 }]

GET /rest/queues/{id}

Get information about Queues

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'maxWaitTime': '', 
     'timeoutLocutionId': '', 
     'timeoutTargetType': '', 
     'timeoutNumberValue': '', 
     'timeoutExtensionId': '', 
     'timeoutVoiceMailUserId': '', 
     'maxlen': '', 
     'fullLocutionId': '', 
     'fullTargetType': '', 
     'fullNumberValue': '', 
     'fullExtensionId': '', 
     'fullVoiceMailUserId': '', 
     'periodicAnnounceLocutionId': '', 
     'periodicAnnounceFrequency': '', 
     'memberCallRest': '', 
     'memberCallTimeout': '', 
     'strategy': '', 
     'weight': ''
 }

POST /rest/queues/

Create's a new Queues

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	No
maxWaitTime	int	No
timeoutLocutionId	int	No
timeoutTargetType	varchar	No	[enum:number\|extension\|voicemail]
timeoutNumberValue	varchar	No
timeoutExtensionId	int	No
timeoutVoiceMailUserId	int	No
maxlen	int	No
fullLocutionId	int	No
fullTargetType	varchar	No	[enum:number\|extension\|voicemail]
fullNumberValue	varchar	No
fullExtensionId	int	No
fullVoiceMailUserId	int	No
periodicAnnounceLocutionId	int	No
periodicAnnounceFrequency	int	No
memberCallRest	int	No
memberCallTimeout	int	No
strategy	enum('ringall','leastrecent','fewestcalls','random','rrmemory','linear','wrandom','rrordered'	No
weight	int	No

Body

Headers

Response

HTTP 201

Location: /rest/queues/{id}

{}

PUT /rest/queues/

Table Queues

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	No
maxWaitTime	int	No
timeoutLocutionId	int	No
timeoutTargetType	varchar	No	[enum:number\|extension\|voicemail]
timeoutNumberValue	varchar	No
timeoutExtensionId	int	No
timeoutVoiceMailUserId	int	No
maxlen	int	No
fullLocutionId	int	No
fullTargetType	varchar	No	[enum:number\|extension\|voicemail]
fullNumberValue	varchar	No
fullExtensionId	int	No
fullVoiceMailUserId	int	No
periodicAnnounceLocutionId	int	No
periodicAnnounceFrequency	int	No
memberCallRest	int	No
memberCallTimeout	int	No
strategy	enum('ringall','leastrecent','fewestcalls','random','rrmemory','linear','wrandom','rrordered'	No
weight	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/queues/

Table Queues

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Recordings

GET /rest/recordings/

GET information about all Recordings

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'callid': '', 
     'calldate': '', 
     'type': '', 
     'duration': '', 
     'caller': '', 
     'callee': '', 
     'recorder': '', 
     'recordedFile': ''
 },{
     'id': '', 
     'companyId': '', 
     'callid': '', 
     'calldate': '', 
     'type': '', 
     'duration': '', 
     'caller': '', 
     'callee': '', 
     'recorder': '', 
     'recordedFile': ''
 }]

GET /rest/recordings/{id}

Get information about Recordings

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'callid': '', 
     'calldate': '', 
     'type': '', 
     'duration': '', 
     'caller': '', 
     'callee': '', 
     'recorder': '', 
     'recordedFile': ''
 }

POST /rest/recordings/

Create's a new Recordings

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
callid	varchar	No
calldate	timestamp	Yes
type	enum('ondemand','ddi'	Yes
duration	float	Yes
caller	varchar	No
callee	varchar	No
recorder	varchar	No
recordedFile	int	No	[FSO:keepExtension]

Body

Headers

Response

HTTP 201

Location: /rest/recordings/{id}

{}

PUT /rest/recordings/

Table Recordings

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
callid	varchar	No
calldate	timestamp	Yes
type	enum('ondemand','ddi'	Yes
duration	float	Yes
caller	varchar	No
callee	varchar	No
recorder	varchar	No
recordedFile	int	No	[FSO:keepExtension]

Body

Headers

Response

HTTP 200

{}

DELETE /rest/recordings/

Table Recordings

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

RetailAccounts

GET /rest/retail-accounts/

GET information about all RetailAccounts

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'companyId': '', 
     'name': '', 
     'domain': '', 
     'description': '', 
     'transport': '', 
     'ip': '', 
     'port': '', 
     'auth_needed': '', 
     'password': '', 
     'countryId': '', 
     'areaCode': '', 
     'outgoingDDIId': '', 
     'disallow': '', 
     'allow': '', 
     'direct_media_method': '', 
     'callerid_update_header': '', 
     'update_callerid': '', 
     'from_domain': '', 
     'directConnectivity': '', 
     'languageId': ''
 },{
     'id': '', 
     'brandId': '', 
     'companyId': '', 
     'name': '', 
     'domain': '', 
     'description': '', 
     'transport': '', 
     'ip': '', 
     'port': '', 
     'auth_needed': '', 
     'password': '', 
     'countryId': '', 
     'areaCode': '', 
     'outgoingDDIId': '', 
     'disallow': '', 
     'allow': '', 
     'direct_media_method': '', 
     'callerid_update_header': '', 
     'update_callerid': '', 
     'from_domain': '', 
     'directConnectivity': '', 
     'languageId': ''
 }]

GET /rest/retail-accounts/{id}

Get information about RetailAccounts

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'companyId': '', 
     'name': '', 
     'domain': '', 
     'description': '', 
     'transport': '', 
     'ip': '', 
     'port': '', 
     'auth_needed': '', 
     'password': '', 
     'countryId': '', 
     'areaCode': '', 
     'outgoingDDIId': '', 
     'disallow': '', 
     'allow': '', 
     'direct_media_method': '', 
     'callerid_update_header': '', 
     'update_callerid': '', 
     'from_domain': '', 
     'directConnectivity': '', 
     'languageId': ''
 }

POST /rest/retail-accounts/

Create's a new RetailAccounts

Headers

Parameters

Name	Type	Required	Description
brandId	int	Yes
companyId	int	Yes
name	varchar	Yes
domain	varchar	No
description	varchar	Yes
transport	varchar	Yes	[enum:udp\|tcp\|tls]
ip	varchar	No
port	smallint	No
auth_needed	enum('yes','no'	Yes
password	varchar	No
countryId	int	No
areaCode	varchar	No
outgoingDDIId	int	No
disallow	varchar	Yes
allow	varchar	Yes
direct_media_method	enum('invite','update'	Yes
callerid_update_header	enum('pai','rpid'	Yes
update_callerid	enum('yes','no'	Yes
from_domain	varchar	No
directConnectivity	enum('yes','no'	Yes
languageId	int	No

Body

Headers

Response

HTTP 201

Location: /rest/retailaccounts/{id}

{}

PUT /rest/retail-accounts/

Table RetailAccounts

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
brandId	int	Yes
companyId	int	Yes
name	varchar	Yes
domain	varchar	No
description	varchar	Yes
transport	varchar	Yes	[enum:udp\|tcp\|tls]
ip	varchar	No
port	smallint	No
auth_needed	enum('yes','no'	Yes
password	varchar	No
countryId	int	No
areaCode	varchar	No
outgoingDDIId	int	No
disallow	varchar	Yes
allow	varchar	Yes
direct_media_method	enum('invite','update'	Yes
callerid_update_header	enum('pai','rpid'	Yes
update_callerid	enum('yes','no'	Yes
from_domain	varchar	No
directConnectivity	enum('yes','no'	Yes
languageId	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/retail-accounts/

Table RetailAccounts

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

RouteLocks

GET /rest/route-locks/

GET information about all RouteLocks

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'description': '', 
     'open': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'description': '', 
     'open': ''
 }]

GET /rest/route-locks/{id}

Get information about RouteLocks

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'description': '', 
     'open': ''
 }

POST /rest/route-locks/

Create's a new RouteLocks

Headers

Parameters

Name	Type	Required
companyId	int	Yes
name	varchar	Yes
description	varchar	Yes
open	tinyint	Yes

Body

Headers

Response

HTTP 201

Location: /rest/routelocks/{id}

{}

PUT /rest/route-locks/

Table RouteLocks

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
name	varchar	Yes
description	varchar	Yes
open	tinyint	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/route-locks/

Table RouteLocks

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

RoutingPatternGroups

GET /rest/routing-pattern-groups/

GET information about all RoutingPatternGroups

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'description': '', 
     'brandId': ''
 },{
     'id': '', 
     'name': '', 
     'description': '', 
     'brandId': ''
 }]

GET /rest/routing-pattern-groups/{id}

Get information about RoutingPatternGroups

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'description': '', 
     'brandId': ''
 }

POST /rest/routing-pattern-groups/

Create's a new RoutingPatternGroups

Headers

Parameters

Name	Type	Required
name	varchar	Yes
description	varchar	No
brandId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/routingpatterngroups/{id}

{}

PUT /rest/routing-pattern-groups/

Table RoutingPatternGroups

Headers

Parameters

Name	Type	Required
id	int	Yes
name	varchar	Yes
description	varchar	No
brandId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/routing-pattern-groups/

Table RoutingPatternGroups

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

RoutingPatternGroupsRelPatterns

GET /rest/routing-pattern-groups-rel-patterns/

GET information about all RoutingPatternGroupsRelPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'routingPatternId': '', 
     'routingPatternGroupId': ''
 },{
     'id': '', 
     'routingPatternId': '', 
     'routingPatternGroupId': ''
 }]

GET /rest/routing-pattern-groups-rel-patterns/{id}

Get information about RoutingPatternGroupsRelPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'routingPatternId': '', 
     'routingPatternGroupId': ''
 }

POST /rest/routing-pattern-groups-rel-patterns/

Create's a new RoutingPatternGroupsRelPatterns

Headers

Parameters

Name	Type	Required	Description
routingPatternId	int	Yes
routingPatternGroupId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/routingpatterngroupsrelpatterns/{id}

{}

PUT /rest/routing-pattern-groups-rel-patterns/

Table RoutingPatternGroupsRelPatterns

Headers

Parameters

Name	Type	Required
id	int	Yes
routingPatternId	int	Yes
routingPatternGroupId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/routing-pattern-groups-rel-patterns/

Table RoutingPatternGroupsRelPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

RoutingPatterns

GET /rest/routing-patterns/

GET information about all RoutingPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'regExp': '', 
     'brandId': ''
 },{
     'id': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'regExp': '', 
     'brandId': ''
 }]

GET /rest/routing-patterns/{id}

Get information about RoutingPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'regExp': '', 
     'brandId': ''
 }

POST /rest/routing-patterns/

Create's a new RoutingPatterns

Headers

Parameters

Name	Type	Required	Description
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes
description	varchar	No	[ml]
description_en	varchar	No
description_es	varchar	No
regExp	varchar	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/routingpatterns/{id}

{}

PUT /rest/routing-patterns/

Table RoutingPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes
description	varchar	No	[ml]
description_en	varchar	No
description_es	varchar	No
regExp	varchar	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/routing-patterns/

Table RoutingPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Schedules

GET /rest/schedules/

GET information about all Schedules

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'timeIn': '', 
     'timeout': '', 
     'monday': '', 
     'tuesday': '', 
     'wednesday': '', 
     'thursday': '', 
     'friday': '', 
     'saturday': '', 
     'sunday': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'timeIn': '', 
     'timeout': '', 
     'monday': '', 
     'tuesday': '', 
     'wednesday': '', 
     'thursday': '', 
     'friday': '', 
     'saturday': '', 
     'sunday': ''
 }]

GET /rest/schedules/{id}

Get information about Schedules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'timeIn': '', 
     'timeout': '', 
     'monday': '', 
     'tuesday': '', 
     'wednesday': '', 
     'thursday': '', 
     'friday': '', 
     'saturday': '', 
     'sunday': ''
 }

POST /rest/schedules/

Create's a new Schedules

Headers

Parameters

Name	Type	Required
companyId	int	Yes
name	varchar	Yes
timeIn	time	Yes
timeout	time	Yes
monday	tinyint	No
tuesday	tinyint	No
wednesday	tinyint	No
thursday	tinyint	No
friday	tinyint	No
saturday	tinyint	No
sunday	tinyint	No

Body

Headers

Response

HTTP 201

Location: /rest/schedules/{id}

{}

PUT /rest/schedules/

Table Schedules

Headers

Parameters

Name	Type	Required
id	int	Yes
companyId	int	Yes
name	varchar	Yes
timeIn	time	Yes
timeout	time	Yes
monday	tinyint	No
tuesday	tinyint	No
wednesday	tinyint	No
thursday	tinyint	No
friday	tinyint	No
saturday	tinyint	No
sunday	tinyint	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/schedules/

Table Schedules

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Services

GET /rest/services/

GET information about all Services

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'iden': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'defaultCode': '', 
     'extraArgs': ''
 },{
     'id': '', 
     'iden': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'defaultCode': '', 
     'extraArgs': ''
 }]

GET /rest/services/{id}

Get information about Services

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'iden': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'defaultCode': '', 
     'extraArgs': ''
 }

POST /rest/services/

Create's a new Services

Headers

Parameters

Name	Type	Required	Description
iden	varchar	Yes
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes
description	varchar	Yes	[ml]
description_en	varchar	Yes
description_es	varchar	Yes
defaultCode	varchar	Yes
extraArgs	tinyint	Yes

Body

Headers

Response

HTTP 201

Location: /rest/services/{id}

{}

PUT /rest/services/

Table Services

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
iden	varchar	Yes
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes
description	varchar	Yes	[ml]
description_en	varchar	Yes
description_es	varchar	Yes
defaultCode	varchar	Yes
extraArgs	tinyint	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/services/

Table Services

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

TargetPatterns

GET /rest/target-patterns/

GET information about all TargetPatterns

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'regExp': '', 
     'brandId': ''
 },{
     'id': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'regExp': '', 
     'brandId': ''
 }]

GET /rest/target-patterns/{id}

Get information about TargetPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'name': '', 
     'name_en': '', 
     'name_es': '', 
     'description': '', 
     'description_en': '', 
     'description_es': '', 
     'regExp': '', 
     'brandId': ''
 }

POST /rest/target-patterns/

Create's a new TargetPatterns

Headers

Parameters

Name	Type	Required	Description
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes
description	varchar	Yes	[ml]
description_en	varchar	Yes
description_es	varchar	Yes
regExp	varchar	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 201

Location: /rest/targetpatterns/{id}

{}

PUT /rest/target-patterns/

Table TargetPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
name	varchar	Yes	[ml]
name_en	varchar	Yes
name_es	varchar	Yes
description	varchar	Yes	[ml]
description_en	varchar	Yes
description_es	varchar	Yes
regExp	varchar	Yes
brandId	int	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/target-patterns/

Table TargetPatterns

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

TerminalManufacturers

GET /rest/terminal-manufacturers/

GET information about all TerminalManufacturers

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'iden': '', 
     'name': '', 
     'description': ''
 },{
     'id': '', 
     'iden': '', 
     'name': '', 
     'description': ''
 }]

GET /rest/terminal-manufacturers/{id}

Get information about TerminalManufacturers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'iden': '', 
     'name': '', 
     'description': ''
 }

POST /rest/terminal-manufacturers/

Create's a new TerminalManufacturers

Headers

Parameters

Name	Type	Required
iden	varchar	Yes
name	varchar	Yes
description	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/terminalmanufacturers/{id}

{}

PUT /rest/terminal-manufacturers/

Table TerminalManufacturers

Headers

Parameters

Name	Type	Required
id	int	Yes
iden	varchar	Yes
name	varchar	Yes
description	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/terminal-manufacturers/

Table TerminalManufacturers

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

TerminalModels

GET /rest/terminal-models/

GET information about all TerminalModels

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'iden': '', 
     'name': '', 
     'description': '', 
     'TerminalManufacturerId': '', 
     'genericTemplate': '', 
     'specificTemplate': '', 
     'genericUrlPattern': '', 
     'specificUrlPattern': ''
 },{
     'id': '', 
     'iden': '', 
     'name': '', 
     'description': '', 
     'TerminalManufacturerId': '', 
     'genericTemplate': '', 
     'specificTemplate': '', 
     'genericUrlPattern': '', 
     'specificUrlPattern': ''
 }]

GET /rest/terminal-models/{id}

Get information about TerminalModels

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'iden': '', 
     'name': '', 
     'description': '', 
     'TerminalManufacturerId': '', 
     'genericTemplate': '', 
     'specificTemplate': '', 
     'genericUrlPattern': '', 
     'specificUrlPattern': ''
 }

POST /rest/terminal-models/

Create's a new TerminalModels

Headers

Parameters

Name	Type	Required
iden	varchar	Yes
name	varchar	Yes
description	varchar	Yes
TerminalManufacturerId	int	Yes
genericTemplate	text	No
specificTemplate	text	No
genericUrlPattern	varchar	No
specificUrlPattern	varchar	No

Body

Headers

Response

HTTP 201

Location: /rest/terminalmodels/{id}

{}

PUT /rest/terminal-models/

Table TerminalModels

Headers

Parameters

Name	Type	Required
id	int	Yes
iden	varchar	Yes
name	varchar	Yes
description	varchar	Yes
TerminalManufacturerId	int	Yes
genericTemplate	text	No
specificTemplate	text	No
genericUrlPattern	varchar	No
specificUrlPattern	varchar	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/terminal-models/

Table TerminalModels

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Terminals

GET /rest/terminals/

GET information about all Terminals

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'TerminalModelId': '', 
     'name': '', 
     'domain': '', 
     'disallow': '', 
     'allow_audio': '', 
     'allow_video': '', 
     'direct_media_method': '', 
     'password': '', 
     'companyId': '', 
     'mac': '', 
     'lastProvisionDate': ''
 },{
     'id': '', 
     'TerminalModelId': '', 
     'name': '', 
     'domain': '', 
     'disallow': '', 
     'allow_audio': '', 
     'allow_video': '', 
     'direct_media_method': '', 
     'password': '', 
     'companyId': '', 
     'mac': '', 
     'lastProvisionDate': ''
 }]

GET /rest/terminals/{id}

Get information about Terminals

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'TerminalModelId': '', 
     'name': '', 
     'domain': '', 
     'disallow': '', 
     'allow_audio': '', 
     'allow_video': '', 
     'direct_media_method': '', 
     'password': '', 
     'companyId': '', 
     'mac': '', 
     'lastProvisionDate': ''
 }

POST /rest/terminals/

Create's a new Terminals

Headers

Parameters

Name	Type	Required	Description
TerminalModelId	int	No
name	varchar	No
domain	varchar	No
disallow	varchar	Yes
allow_audio	varchar	Yes
allow_video	varchar	No
direct_media_method	enum('invite','reinvite','update'	Yes
password	varchar	Yes	[password]
companyId	int	Yes
mac	varchar	No
lastProvisionDate	timestamp	No

Body

Headers

Response

HTTP 201

Location: /rest/terminals/{id}

{}

PUT /rest/terminals/

Table Terminals

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
TerminalModelId	int	No
name	varchar	No
domain	varchar	No
disallow	varchar	Yes
allow_audio	varchar	Yes
allow_video	varchar	No
direct_media_method	enum('invite','reinvite','update'	Yes
password	varchar	Yes	[password]
companyId	int	Yes
mac	varchar	No
lastProvisionDate	timestamp	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/terminals/

Table Terminals

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Timezones

GET /rest/timezones/

GET information about all Timezones

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'countryId': '', 
     'tz': '', 
     'comment': '', 
     'timeZoneLabel': '', 
     'timeZoneLabel_en': '', 
     'timeZoneLabel_es': ''
 },{
     'id': '', 
     'countryId': '', 
     'tz': '', 
     'comment': '', 
     'timeZoneLabel': '', 
     'timeZoneLabel_en': '', 
     'timeZoneLabel_es': ''
 }]

GET /rest/timezones/{id}

Get information about Timezones

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'countryId': '', 
     'tz': '', 
     'comment': '', 
     'timeZoneLabel': '', 
     'timeZoneLabel_en': '', 
     'timeZoneLabel_es': ''
 }

POST /rest/timezones/

Create's a new Timezones

Headers

Parameters

Name	Type	Required	Description
countryId	int	No
tz	varchar	Yes
comment	varchar	No
timeZoneLabel	varchar	Yes	[ml]
timeZoneLabel_en	varchar	Yes
timeZoneLabel_es	varchar	Yes

Body

Headers

Response

HTTP 201

Location: /rest/timezones/{id}

{}

PUT /rest/timezones/

Table Timezones

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
countryId	int	No
tz	varchar	Yes
comment	varchar	No
timeZoneLabel	varchar	Yes	[ml]
timeZoneLabel_en	varchar	Yes
timeZoneLabel_es	varchar	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/timezones/

Table Timezones

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

TransformationRulesetGroupsTrunks

GET /rest/transformation-ruleset-groups-trunks/

GET information about all TransformationRulesetGroupsTrunks

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'brandId': '', 
     'name': '', 
     'caller_in': '', 
     'callee_in': '', 
     'caller_out': '', 
     'callee_out': '', 
     'description': '', 
     'automatic': '', 
     'countryId': '', 
     'internationalCode': '', 
     'nationalNumLength': ''
 },{
     'id': '', 
     'brandId': '', 
     'name': '', 
     'caller_in': '', 
     'callee_in': '', 
     'caller_out': '', 
     'callee_out': '', 
     'description': '', 
     'automatic': '', 
     'countryId': '', 
     'internationalCode': '', 
     'nationalNumLength': ''
 }]

GET /rest/transformation-ruleset-groups-trunks/{id}

Get information about TransformationRulesetGroupsTrunks

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'brandId': '', 
     'name': '', 
     'caller_in': '', 
     'callee_in': '', 
     'caller_out': '', 
     'callee_out': '', 
     'description': '', 
     'automatic': '', 
     'countryId': '', 
     'internationalCode': '', 
     'nationalNumLength': ''
 }

POST /rest/transformation-ruleset-groups-trunks/

Create's a new TransformationRulesetGroupsTrunks

Headers

Parameters

Name	Type	Required
brandId	int	Yes
name	varchar	Yes
caller_in	int	No
callee_in	int	No
caller_out	int	No
callee_out	int	No
description	varchar	Yes
automatic	tinyint	Yes
countryId	int	No
internationalCode	varchar	No
nationalNumLength	int	No

Body

Headers

Response

HTTP 201

Location: /rest/transformationrulesetgroupstrunks/{id}

{}

PUT /rest/transformation-ruleset-groups-trunks/

Table TransformationRulesetGroupsTrunks

Headers

Parameters

Name	Type	Required
id	int	Yes
brandId	int	Yes
name	varchar	Yes
caller_in	int	No
callee_in	int	No
caller_out	int	No
callee_out	int	No
description	varchar	Yes
automatic	tinyint	Yes
countryId	int	No
internationalCode	varchar	No
nationalNumLength	int	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/transformation-ruleset-groups-trunks/

Table TransformationRulesetGroupsTrunks

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Users

GET /rest/users/

GET information about all Users

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'lastname': '', 
     'email': '', 
     'pass': '', 
     'timezoneId': '', 
     'terminalId': '', 
     'extensionId': '', 
     'outgoingDDIId': '', 
     'outgoingDDIRuleId': '', 
     'callACLId': '', 
     'doNotDisturb': '', 
     'isBoss': '', 
     'bossAssistantId': '', 
     'bossAssistantWhiteListId': '', 
     'active': '', 
     'maxCalls': '', 
     'externalIpCalls': '', 
     'voicemailEnabled': '', 
     'voicemailLocutionId': '', 
     'voicemailSendMail': '', 
     'voicemailAttachSound': '', 
     'tokenKey': '', 
     'countryId': '', 
     'languageId': '', 
     'areaCode': '', 
     'gsQRCode': ''
 },{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'lastname': '', 
     'email': '', 
     'pass': '', 
     'timezoneId': '', 
     'terminalId': '', 
     'extensionId': '', 
     'outgoingDDIId': '', 
     'outgoingDDIRuleId': '', 
     'callACLId': '', 
     'doNotDisturb': '', 
     'isBoss': '', 
     'bossAssistantId': '', 
     'bossAssistantWhiteListId': '', 
     'active': '', 
     'maxCalls': '', 
     'externalIpCalls': '', 
     'voicemailEnabled': '', 
     'voicemailLocutionId': '', 
     'voicemailSendMail': '', 
     'voicemailAttachSound': '', 
     'tokenKey': '', 
     'countryId': '', 
     'languageId': '', 
     'areaCode': '', 
     'gsQRCode': ''
 }]

GET /rest/users/{id}

Get information about Users

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'companyId': '', 
     'name': '', 
     'lastname': '', 
     'email': '', 
     'pass': '', 
     'timezoneId': '', 
     'terminalId': '', 
     'extensionId': '', 
     'outgoingDDIId': '', 
     'outgoingDDIRuleId': '', 
     'callACLId': '', 
     'doNotDisturb': '', 
     'isBoss': '', 
     'bossAssistantId': '', 
     'bossAssistantWhiteListId': '', 
     'active': '', 
     'maxCalls': '', 
     'externalIpCalls': '', 
     'voicemailEnabled': '', 
     'voicemailLocutionId': '', 
     'voicemailSendMail': '', 
     'voicemailAttachSound': '', 
     'tokenKey': '', 
     'countryId': '', 
     'languageId': '', 
     'areaCode': '', 
     'gsQRCode': ''
 }

POST /rest/users/

Create's a new Users

Headers

Parameters

Name	Type	Required	Description
companyId	int	Yes
name	varchar	Yes
lastname	varchar	Yes
email	varchar	No
pass	varchar	No	[password]
timezoneId	int	No
terminalId	int	No
extensionId	int	No
outgoingDDIId	int	No
outgoingDDIRuleId	int	No
callACLId	int	No
doNotDisturb	tinyint	Yes
isBoss	tinyint	Yes
bossAssistantId	int	No
bossAssistantWhiteListId	int	No
active	tinyint	Yes
maxCalls	smallint	Yes
externalIpCalls	tinyint	Yes	[enum:0\|1\|2\|3]
voicemailEnabled	tinyint	Yes
voicemailLocutionId	int	No
voicemailSendMail	tinyint	Yes
voicemailAttachSound	tinyint	Yes
tokenKey	varchar	No
countryId	int	No
languageId	int	No
areaCode	varchar	No
gsQRCode	tinyint	Yes

Body

Headers

Response

HTTP 201

Location: /rest/users/{id}

{}

PUT /rest/users/

Table Users

Headers

Parameters

Name	Type	Required	Description
id	int	Yes
companyId	int	Yes
name	varchar	Yes
lastname	varchar	Yes
email	varchar	No
pass	varchar	No	[password]
timezoneId	int	No
terminalId	int	No
extensionId	int	No
outgoingDDIId	int	No
outgoingDDIRuleId	int	No
callACLId	int	No
doNotDisturb	tinyint	Yes
isBoss	tinyint	Yes
bossAssistantId	int	No
bossAssistantWhiteListId	int	No
active	tinyint	Yes
maxCalls	smallint	Yes
externalIpCalls	tinyint	Yes	[enum:0\|1\|2\|3]
voicemailEnabled	tinyint	Yes
voicemailLocutionId	int	No
voicemailSendMail	tinyint	Yes
voicemailAttachSound	tinyint	Yes
tokenKey	varchar	No
countryId	int	No
languageId	int	No
areaCode	varchar	No
gsQRCode	tinyint	Yes

Body

Headers

Response

HTTP 200

{}

DELETE /rest/users/

Table Users

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

XMLRPCLogs

GET /rest/x-m-l-r-p-c-logs/

GET information about all XMLRPCLogs

Headers

Parameters

Name	Type	Required
page	int	No
order	string	No
search	json_encode	No

Body

Headers

Response

HTTP 200 OK

[{
     'id': '', 
     'proxy': '', 
     'module': '', 
     'method': '', 
     'mapperName': '', 
     'startDate': '', 
     'execDate': '', 
     'finishDate': ''
 },{
     'id': '', 
     'proxy': '', 
     'module': '', 
     'method': '', 
     'mapperName': '', 
     'startDate': '', 
     'execDate': '', 
     'finishDate': ''
 }]

GET /rest/x-m-l-r-p-c-logs/{id}

Get information about XMLRPCLogs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 200 OK

{
     'id': '', 
     'proxy': '', 
     'module': '', 
     'method': '', 
     'mapperName': '', 
     'startDate': '', 
     'execDate': '', 
     'finishDate': ''
 }

POST /rest/x-m-l-r-p-c-logs/

Create's a new XMLRPCLogs

Headers

Parameters

Name	Type	Required
proxy	varchar	Yes
module	varchar	Yes
method	varchar	Yes
mapperName	varchar	Yes
startDate	timestamp	Yes
execDate	datetime	No
finishDate	datetime	No

Body

Headers

Response

HTTP 201

Location: /rest/xmlrpclogs/{id}

{}

PUT /rest/x-m-l-r-p-c-logs/

Table XMLRPCLogs

Headers

Parameters

Name	Type	Required
id	int	Yes
proxy	varchar	Yes
module	varchar	Yes
method	varchar	Yes
mapperName	varchar	Yes
startDate	timestamp	Yes
execDate	datetime	No
finishDate	datetime	No

Body

Headers

Response

HTTP 200

{}

DELETE /rest/x-m-l-r-p-c-logs/

Table XMLRPCLogs

Headers

Parameters

Name	Type	Required	Description
id	int	Yes

Body

Headers

Response

HTTP 204

{}

Api URL

ApplicationServers

GET /rest/application-servers/

GET /rest/application-servers/{id}

POST /rest/application-servers/

PUT /rest/application-servers/

DELETE /rest/application-servers/

AstMusiconhold

GET /rest/ast-musiconhold/

GET /rest/ast-musiconhold/{id}

POST /rest/ast-musiconhold/

PUT /rest/ast-musiconhold/

DELETE /rest/ast-musiconhold/

AstPsAors

GET /rest/ast-ps-aors/

GET /rest/ast-ps-aors/{id}

POST /rest/ast-ps-aors/

PUT /rest/ast-ps-aors/

DELETE /rest/ast-ps-aors/

AstPsEndpoints

GET /rest/ast-ps-endpoints/

GET /rest/ast-ps-endpoints/{id}

POST /rest/ast-ps-endpoints/

PUT /rest/ast-ps-endpoints/

DELETE /rest/ast-ps-endpoints/

AstQueueMembers

GET /rest/ast-queue-members/

GET /rest/ast-queue-members/{id}

POST /rest/ast-queue-members/

PUT /rest/ast-queue-members/

DELETE /rest/ast-queue-members/

AstQueues

GET /rest/ast-queues/

GET /rest/ast-queues/{id}

POST /rest/ast-queues/

PUT /rest/ast-queues/

DELETE /rest/ast-queues/

AstVoicemail

GET /rest/ast-voicemail/

GET /rest/ast-voicemail/{uniqueid}

POST /rest/ast-voicemail/

PUT /rest/ast-voicemail/

DELETE /rest/ast-voicemail/

BrandOperators

GET /rest/brand-operators/

GET /rest/brand-operators/{id}

POST /rest/brand-operators/

PUT /rest/brand-operators/

DELETE /rest/brand-operators/

BrandServices

GET /rest/brand-services/

GET /rest/brand-services/{id}

POST /rest/brand-services/

PUT /rest/brand-services/

DELETE /rest/brand-services/

BrandURLs

GET /rest/brand-u-r-ls/

GET /rest/brand-u-r-ls/{id}

POST /rest/brand-u-r-ls/

PUT /rest/brand-u-r-ls/

DELETE /rest/brand-u-r-ls/

Brands

GET /rest/brands/

GET /rest/brands/{id}

POST /rest/brands/

PUT /rest/brands/

DELETE /rest/brands/

Calendars

GET /rest/calendars/

GET /rest/calendars/{id}

POST /rest/calendars/

PUT /rest/calendars/

DELETE /rest/calendars/

CallACL

GET /rest/call-a-c-l/

GET /rest/call-a-c-l/{id}

POST /rest/call-a-c-l/

PUT /rest/call-a-c-l/

DELETE /rest/call-a-c-l/

CallACLPatterns