Settings module
Endpoints for managing PBX settings such us Telephone Numbers configuration, Contacts, Ring Group, IVRs etc.
GET
/calltracking/ddis Returns collection of Call Tracking Ddi resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/calltracking/ddis HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 2323,
"cli_hide": true,
"cli_prefix": 3965,
"created_at": "2018-06-22 12:14:57",
"e164": "value",
"fax_email": "value",
"flag": "S",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 4.33,
"sms_enabled": true,
"status": "C",
"target_id": 6700,
"target_type": "I",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
PATCH
/calltracking/ddis [BULK] Updates folder of existing Ddi resources
Parameters
JSON body attributes:
e164 string
campaign_id integer
Example Request
PATCH /v1.1/voipstudio/calltracking/ddis HTTP/1.1
Host: l7api.com
[
{
"e164": "abcd",
"campaign_id": 245
},
{
"e164": "abcd",
"campaign_id": 245,
"id": 8542
}
]
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": "value",
"channels": 1724,
"cli_hide": true,
"cli_prefix": 9339,
"created_at": "2018-05-27 19:00:58",
"e164": "value",
"fax_email": "value",
"flag": "R",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 8.14,
"sms_enabled": true,
"status": "P",
"target_id": 9375,
"target_type": "U",
"tel_verified": true,
"uri": "value"
},
"links": {}
}
GET
/calltracking/campaigns Returns collection of Campaign resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/calltracking/campaigns HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 9100,
"cli_hide": true,
"cli_prefix": 9607,
"created_at": "2017-05-06 21:12:24",
"e164": "value",
"fax_email": "value",
"flag": "N",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 8.17,
"sms_enabled": true,
"status": "U",
"target_id": 7811,
"target_type": "R",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
POST
/calltracking/campaigns Creates new Website resource
Parameters
Example Request
POST /v1.1/voipstudio/calltracking/campaigns HTTP/1.1 Host: l7api.com
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": "value",
"channels": 3616,
"cli_hide": true,
"cli_prefix": 8094,
"created_at": "2021-03-18 10:48:22",
"e164": "value",
"fax_email": "value",
"flag": "N",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 4.33,
"sms_enabled": true,
"status": "T",
"target_id": 4240,
"target_type": "R",
"tel_verified": true,
"uri": "value"
},
"links": {}
}
GET
/contacts Returns collection of Contact resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/contacts HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 6022,
"created_at": "2016-08-16 20:44:00",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 7642,
"user_id": 8953
}
],
"total": 59
}
POST
/contacts Creates new Contact resource
Parameters
JSON body attributes:
group_name string
first_name string
last_name string
email string
tel string
speed_dial_phone string
mobile string
speed_dial_mobile string
notes string
labels array
global boolean
user_id integer
Example Request
POST /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
{
"group_name": "abcd",
"first_name": "abcd",
"last_name": "abcd",
"email": "email@example.com",
"tel": "abcd",
"speed_dial_phone": "abcd",
"mobile": "abcd",
"speed_dial_mobile": "abcd",
"notes": "abcd",
"labels": "abcd",
"global": true,
"user_id": 444
}
Responses
201 Created
400 Validation error
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 2390,
"created_at": "2018-01-10 08:35:11",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 5995,
"user_id": 684
},
"links": {}
}
PATCH
/contacts [BULK] Updates folder of existing Contact resources
Parameters
JSON body attributes:
id integer
group_name string
labels array
Example Request
PATCH /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
[
{
"id": 218,
"group_name": "abcd",
"labels": "abcd"
},
{
"id": 4440,
"group_name": "abcd",
"labels": "abcd"
}
]
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3416,
"created_at": "2018-10-06 21:26:17",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 1679,
"user_id": 7011
},
"links": {}
}
GET
/contacts/{id} Returns Contact resource for given Id
Parameters
Endpoint URL:
{id} integerContact identifier
Example Request
GET /v1.1/voipstudio/contacts/14 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9014,
"created_at": "2017-05-19 10:44:55",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 4809,
"user_id": 7193
},
"links": {}
}
PATCH
/contacts/{id} Updates existing Contact resource
Parameters
Endpoint URL:
{id} integerContact identifier
JSON body attributes:
group_name string
first_name string
last_name string
email string
tel string
speed_dial_phone string
mobile string
speed_dial_mobile string
notes string
labels array
global boolean
user_id integer
Example Request
PATCH /v1.1/voipstudio/contacts/21 HTTP/1.1
Host: l7api.com
{
"group_name": "abcd",
"first_name": "abcd",
"last_name": "abcd",
"email": "email@example.com",
"tel": "abcd",
"speed_dial_phone": "abcd",
"mobile": "abcd",
"speed_dial_mobile": "abcd",
"notes": "abcd",
"labels": "abcd",
"global": true,
"user_id": 816
}
Responses
200 Success
400 Validation error
404 Resource not found
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 705,
"created_at": "2021-09-13 18:02:48",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 4616,
"user_id": 2257
},
"links": {}
}
DELETE
/contacts/{ids} Deletes existing Contacts resources
Parameters
Endpoint URL:
{ids} comma separated list of integersContact identifiers
Example Request
DELETE /v1.1/voipstudio/contacts/39,161,411 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/conferences Returns collection of Conference resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/conferences HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 7112,
"ann_join_leave": true,
"confno": 9598,
"confno_pstn": 5238,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
}
],
"total": 59
}
POST
/conferences Creates new Conference resource
Parameters
JSON body attributes:
name string
pin string
pin_pstn string
ann_join_leave boolean
monitor boolean
ddis array
Example Request
POST /v1.1/voipstudio/conferences HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"pin": "abcd",
"pin_pstn": "abcd",
"ann_join_leave": true,
"monitor": true,
"ddis": "abcd"
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 4962,
"ann_join_leave": true,
"confno": 7249,
"confno_pstn": 8067,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
GET
/conferences/{id} Returns Conference resource for given Id
Parameters
Endpoint URL:
{id} integerConference identifier
Example Request
GET /v1.1/voipstudio/conferences/96 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4937,
"ann_join_leave": true,
"confno": 1756,
"confno_pstn": 3251,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
PATCH
/conferences/{id} Updates existing Conference resource
Parameters
Endpoint URL:
{id} integerConference identifier
JSON body attributes:
name string
pin string
pin_pstn string
ann_join_leave boolean
monitor boolean
ddis array
Example Request
PATCH /v1.1/voipstudio/conferences/13 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"pin": "abcd",
"pin_pstn": "abcd",
"ann_join_leave": true,
"monitor": true,
"ddis": "abcd"
}
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 131,
"ann_join_leave": true,
"confno": 970,
"confno_pstn": 3742,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
DELETE
/conferences/{id} Deletes existing Conference resource
Parameters
Endpoint URL:
{id} integerConference identifier
Example Request
DELETE /v1.1/voipstudio/conferences/36 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/ddis Returns collection of Ddi resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ddis HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 7505,
"cli_hide": true,
"cli_prefix": 5965,
"created_at": "2016-05-26 11:46:36",
"e164": "value",
"fax_email": "value",
"flag": "N",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 9.14,
"sms_enabled": true,
"status": "P",
"target_id": 4825,
"target_type": "N",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/ddis/calltracking Returns collection of Call Tracking Ddi resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ddis/calltracking HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 2191,
"cli_hide": true,
"cli_prefix": 7067,
"created_at": "2020-12-20 18:31:00",
"e164": "value",
"fax_email": "value",
"flag": "P",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 9.17,
"sms_enabled": true,
"status": "C",
"target_id": 8777,
"target_type": "R",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/ddis/dictionaries Returns Dictionary for Ddi resource
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ddis/dictionaries HTTP/1.1 Host: l7api.com
Responses
200 Unknown
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 392,
"cli_hide": true,
"cli_prefix": 4607,
"created_at": "2019-07-30 12:08:31",
"e164": "value",
"fax_email": "value",
"flag": "R",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 6.11,
"sms_enabled": true,
"status": "O",
"target_id": 5566,
"target_type": "N",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/ddis/{e164} Returns Ddi resource for given e164
Parameters
Example Request
GET /v1.1/voipstudio/ddis/{e164} HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 7208,
"cli_hide": true,
"cli_prefix": 9147,
"created_at": "2018-05-19 19:20:25",
"e164": "value",
"fax_email": "value",
"flag": "C",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 3.2,
"sms_enabled": true,
"status": "C",
"target_id": 8430,
"target_type": "Q",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/queues Returns collection of Queue resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/queues HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 3656,
"ann_freq": 8533,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 3216,
"final_dst_type": "H",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 7834,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 9218,
"max_wait_time": 5720,
"moh": 9102,
"name": "value",
"number": 5188,
"pos_ann": true,
"retry": 9607,
"ring_strategy": "A",
"ring_time": 3929,
"skip_busy": true,
"users": 6693,
"wait_time_prefix": true,
"wrap_up_time": 7187
}
],
"total": 59
}
POST
/queues Creates new Queue resource
Parameters
JSON body attributes:
moh_id integer
ivr_id integer
ddis array
users array
Users that should be logged in to the queue
Users that should be logged in to the queue
name string
number integer
cli_prefix boolean
wait_time_prefix boolean
agent_sounds string
caller_sounds string
max_wait_time integer
max_callers integer
join_empty boolean
ring_strategy string
ring_time integer
retry integer
wrap_up_time integer
skip_busy boolean
language string
pos_ann boolean
hold_ann boolean
ann_freq integer
final_dst_type string
final_dst_id integer
hash_to_exit boolean
liaf boolean
Example Request
POST /v1.1/voipstudio/queues HTTP/1.1
Host: l7api.com
{
"moh_id": 201,
"ivr_id": 899,
"ddis": "abcd",
"users": [
{
"id": "User ID",
"status": "Bool that indicates that user is logged in by default."
}
],
"name": "abcd",
"number": 245,
"cli_prefix": true,
"wait_time_prefix": true,
"agent_sounds": "abcd",
"caller_sounds": "abcd",
"max_wait_time": 443,
"max_callers": 757,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 460,
"retry": 807,
"wrap_up_time": 506,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 637,
"final_dst_type": "abcd",
"final_dst_id": 731,
"hash_to_exit": true,
"liaf": true
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 1400,
"ann_freq": 557,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 5779,
"final_dst_type": "I",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 8284,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 6585,
"max_wait_time": 1732,
"moh": 8055,
"name": "value",
"number": 7600,
"pos_ann": true,
"retry": 7885,
"ring_strategy": "A",
"ring_time": 950,
"skip_busy": true,
"users": 8075,
"wait_time_prefix": true,
"wrap_up_time": 7246
},
"links": {}
}
GET
/queues/{id} Returns Queue resource for given Id
Parameters
Endpoint URL:
{id} integerQueue identifier
Example Request
GET /v1.1/voipstudio/queues/50 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1078,
"ann_freq": 1356,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 9715,
"final_dst_type": "V",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 3132,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 5596,
"max_wait_time": 1111,
"moh": 9427,
"name": "value",
"number": 1525,
"pos_ann": true,
"retry": 9510,
"ring_strategy": "M",
"ring_time": 8123,
"skip_busy": true,
"users": 3242,
"wait_time_prefix": true,
"wrap_up_time": 8808
},
"links": {}
}
GET
/pickupgroups Returns collection of PickupGroup resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/pickupgroups HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 7599,
"name": "value",
"users": 7877
}
],
"total": 59
}
GET
/pickupgroups/{id} Returns PickupGroup resource for given Id
Parameters
Endpoint URL:
{id} integerPickupGroup identifier
Example Request
GET /v1.1/voipstudio/pickupgroups/29 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8534,
"name": "value",
"users": 6601
},
"links": {}
}
GET
/routingrules Returns collection of RoutingRule resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/routingrules HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 5632,
"action": "value",
"customer": 3133,
"destination": "value",
"direction": "out",
"pos": 4722,
"source": "value",
"time_interval": "value"
}
],
"total": 59
}
GET
/routingrules/{id} Returns routing rule resource for given ID
Parameters
Endpoint URL:
{id} integerRoutingRule2 identifier
Example Request
GET /v1.1/voipstudio/routingrules/31 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1656,
"action": "value",
"customer": 8967,
"destination": "value",
"direction": "in",
"pos": 3626,
"source": "value",
"time_interval": "value"
},
"links": {}
}
PATCH
/routingrules/{id} Updates existing routing rule resource
Parameters
Endpoint URL:
{id} integerRoutingRule2 identifier
JSON body attributes:
direction string
pos integer
source undefined
destination undefined
time_interval array
action string
Example Request
PATCH /v1.1/voipstudio/routingrules/33 HTTP/1.1
Host: l7api.com
{
"direction": "abcd",
"pos": 529,
"source": "abcd",
"destination": "abcd",
"time_interval": "abcd",
"action": "abcd"
}
Responses
200 Success
400 Validation error
404 Resource not found
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9542,
"action": "value",
"customer": 257,
"destination": "value",
"direction": "in",
"pos": 3321,
"source": "value",
"time_interval": "value"
},
"links": {}
}
GET
/ivrs Returns collection of Ivr resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ivrs HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 967,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 2979,
"final_dst_type": "Q",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 9725,
"one": "value",
"post_sounds": "value",
"repeats": 5331,
"ring_time": 4296,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 8257,
"two": "value",
"zero": "value"
}
],
"total": 59
}
POST
/ivrs Creates new Ivr resource
Parameters
JSON body attributes:
name string
ring_time integer
sounds array
post_sounds array
ddis array
timeout integer
repeats integer
ext_dialing boolean
language string
one string
two string
three string
four string
five string
six string
seven string
eight string
nine string
zero string
star string
hash string
final_dst_type string
final_dst_id integer
number integer
Example Request
POST /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 623,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 348,
"repeats": 248,
"ext_dialing": true,
"language": "abcd",
"one": "abcd",
"two": "abcd",
"three": "abcd",
"four": "abcd",
"five": "abcd",
"six": "abcd",
"seven": "abcd",
"eight": "abcd",
"nine": "abcd",
"zero": "abcd",
"star": "abcd",
"hash": "abcd",
"final_dst_type": "abcd",
"final_dst_id": 100,
"number": 367
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 9367,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 9359,
"final_dst_type": "U",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 3337,
"one": "value",
"post_sounds": "value",
"repeats": 5306,
"ring_time": 4848,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 1886,
"two": "value",
"zero": "value"
},
"links": {}
}
GET
/ivrs/{id} Returns Ivr resource for given Id
Parameters
Endpoint URL:
{id} integerIvr identifier
Example Request
GET /v1.1/voipstudio/ivrs/8 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2254,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 7442,
"final_dst_type": "U",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 3486,
"one": "value",
"post_sounds": "value",
"repeats": 2920,
"ring_time": 9512,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 2115,
"two": "value",
"zero": "value"
},
"links": {}
}
PATCH
/ivrs/{id} Updates existing Ivr resource
Parameters
Endpoint URL:
{id} integerIvr identifier
JSON body attributes:
name string
ring_time integer
sounds array
post_sounds array
ddis array
timeout integer
repeats integer
ext_dialing boolean
language string
one string
two string
three string
four string
five string
six string
seven string
eight string
nine string
zero string
star string
hash string
final_dst_type string
final_dst_id integer
number integer
Example Request
PATCH /v1.1/voipstudio/ivrs/93 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 255,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 931,
"repeats": 937,
"ext_dialing": true,
"language": "abcd",
"one": "abcd",
"two": "abcd",
"three": "abcd",
"four": "abcd",
"five": "abcd",
"six": "abcd",
"seven": "abcd",
"eight": "abcd",
"nine": "abcd",
"zero": "abcd",
"star": "abcd",
"hash": "abcd",
"final_dst_type": "abcd",
"final_dst_id": 504,
"number": 180
}
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 6503,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 6687,
"final_dst_type": "H",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 7745,
"one": "value",
"post_sounds": "value",
"repeats": 3168,
"ring_time": 3184,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 1384,
"two": "value",
"zero": "value"
},
"links": {}
}
DELETE
/ivrs/{id} Deletes existing Ivr resource
Parameters
Endpoint URL:
{id} integerIvr identifier
Example Request
DELETE /v1.1/voipstudio/ivrs/18 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/mohs/{id} Returns Moh resource for given Id
Parameters
Endpoint URL:
{id} integerMoh identifier
Example Request
GET /v1.1/voipstudio/mohs/13 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4184,
"locked": true,
"name": "value"
},
"links": {}
}
GET
/contactlabels Returns collection of ContactLabel resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/contactlabels HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 5465,
"color": "value",
"name": "value"
}
],
"total": 59
}
POST
/contactlabels Creates new ContactLabel resource
Parameters
JSON body attributes:
name string
color string
Example Request
POST /v1.1/voipstudio/contactlabels HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
Responses
201 Created
400 Validation error
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 1814,
"color": "value",
"name": "value"
},
"links": {}
}
GET
/contactlabels/{id} Returns ContactLabel resource for given Id
Parameters
Endpoint URL:
{id} integerContactLabel identifier
Example Request
GET /v1.1/voipstudio/contactlabels/80 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2455,
"color": "value",
"name": "value"
},
"links": {}
}
PATCH
/contactlabels/{id} Updates existing ContactLabel resource
Parameters
Endpoint URL:
{id} integerContactLabel identifier
JSON body attributes:
name string
color string
Example Request
PATCH /v1.1/voipstudio/contactlabels/48 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
Responses
200 Success
400 Validation error
404 Resource not found
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 5711,
"color": "value",
"name": "value"
},
"links": {}
}
DELETE
/contactlabels/{id} Deletes existing ContactLabels resources
Parameters
Endpoint URL:
{id} integerContactLabel identifier
Example Request
DELETE /v1.1/voipstudio/contactlabels/33 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK