Settings module
Endpoints for managing PBX settings such us Telephone Numbers configuration, Contacts, Ring Group, IVRs etc.
GET
/contacts Returns collection of Contact resources
Example Request
GET /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 5239,
"created_at": "2019-09-20 06:30:36",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 8282,
"user_id": 4737
}
],
"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
global boolean
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",
"global": true
}
Responses
201 Created
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 7172,
"created_at": "2018-02-28 16:02:28",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 6530,
"user_id": 7103
},
"links": {}
}
PATCH
/contacts [BULK] Updates folder of existing Contact resources
Parameters
JSON body attributes:
id integer
group_name string
Example Request
PATCH /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
[
{
"id": 171,
"group_name": "abcd"
},
{
"id": 4424,
"group_name": "abcd"
}
]
Responses
200 Success
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": 6122,
"created_at": "2020-03-07 05:45:07",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 6860,
"user_id": 3845
},
"links": {}
}
GET
/contacts/{id} Returns Contact resource for given Id
Parameters
Endpoint URL:
{id} integer
Contact identifier
Example Request
GET /v1.1/voipstudio/contacts/60 HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7610,
"created_at": "2020-01-28 10:10:56",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 4504,
"user_id": 9739
},
"links": {}
}
PATCH
/contacts/{id} Updates existing Contact resource
Parameters
Endpoint URL:
{id} integer
Contact 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
global boolean
Example Request
PATCH /v1.1/voipstudio/contacts/58 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",
"global": true
}
Responses
200 Success
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 6662,
"created_at": "2016-09-30 13:26:07",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 7057,
"user_id": 4229
},
"links": {}
}
DELETE
/contacts/{ids} Deletes existing Contacts resources
Parameters
Endpoint URL:
{ids} comma separated list of integers
Contact identifiers
Example Request
DELETE /v1.1/voipstudio/contacts/46,151,403 HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
GET
/conferences Returns collection of Conference resources
Example Request
GET /v1.1/voipstudio/conferences HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 2370,
"ann_join_leave": true,
"confno": 1513,
"pin": "value"
}
],
"total": 59
}
POST
/conferences Creates new Conference resource
Parameters
JSON body attributes:
pin string
ann_join_leave boolean
ddis array
Example Request
POST /v1.1/voipstudio/conferences HTTP/1.1
Host: l7api.com
{
"pin": "abcd",
"ann_join_leave": true,
"ddis": "abcd"
}
Responses
201 Created
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 5753,
"ann_join_leave": true,
"confno": 3632,
"pin": "value"
},
"links": {}
}
GET
/conferences/{id} Returns Conference resource for given Id
Parameters
Endpoint URL:
{id} integer
Conference identifier
Example Request
GET /v1.1/voipstudio/conferences/69 HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3197,
"ann_join_leave": true,
"confno": 5017,
"pin": "value"
},
"links": {}
}
PATCH
/conferences/{id} Updates existing Conference resource
Parameters
Endpoint URL:
{id} integer
Conference identifier
JSON body attributes:
pin string
ann_join_leave boolean
ddis array
Example Request
PATCH /v1.1/voipstudio/conferences/51 HTTP/1.1
Host: l7api.com
{
"pin": "abcd",
"ann_join_leave": true,
"ddis": "abcd"
}
Responses
200 Success
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": 2327,
"ann_join_leave": true,
"confno": 4100,
"pin": "value"
},
"links": {}
}
DELETE
/conferences/{id} Deletes existing Conference resource
Parameters
Endpoint URL:
{id} integer
Conference identifier
Example Request
DELETE /v1.1/voipstudio/conferences/22 HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
GET
/ddis Returns collection of Ddi resources
Example Request
GET /v1.1/voipstudio/ddis HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 6445,
"cli_hide": true,
"cli_prefix": 5558,
"created_at": "2020-10-24 04:24:46",
"e164": "value",
"fax_email": "value",
"flag": "value",
"has_fax_password": true,
"info": "value",
"rate": 3.17,
"status": "value",
"target_id": 696,
"target_type": "value",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/ddis/dictionaries Returns Dictionary for Ddi resource
Example Request
GET /v1.1/voipstudio/ddis/dictionaries HTTP/1.1
Host: l7api.com
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 4295,
"cli_hide": true,
"cli_prefix": 5724,
"created_at": "2018-11-25 04:18:08",
"e164": "value",
"fax_email": "value",
"flag": "value",
"has_fax_password": true,
"info": "value",
"rate": 6.17,
"status": "value",
"target_id": 4814,
"target_type": "value",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/ddis/{e164} Returns Ddi resource for given e164
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
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 905,
"cli_hide": true,
"cli_prefix": 4182,
"created_at": "2019-03-28 17:16:37",
"e164": "value",
"fax_email": "value",
"flag": "value",
"has_fax_password": true,
"info": "value",
"rate": 2.25,
"status": "value",
"target_id": 7732,
"target_type": "value",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/queues Returns collection of Queue resources
Example Request
GET /v1.1/voipstudio/queues HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 6512,
"ann_freq": 3634,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 3006,
"final_dst_type": "value",
"hash_to_exit": true,
"hold_ann": true,
"ivr_id": 9385,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 8657,
"max_wait_time": 5630,
"moh_id": 3268,
"name": "value",
"number": 2721,
"pos_ann": true,
"retry": 7719,
"ring_strategy": "value",
"ring_time": 2821,
"skip_busy": true,
"users": "value",
"wait_time_prefix": true,
"wrap_up_time": 8454
}
],
"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
name string
number string
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": 823,
"ivr_id": 780,
"ddis": "abcd",
"users": [
{
"id": "User ID",
"status": "Bool that indicates that user is logged in by default."
}
],
"name": "abcd",
"number": "abcd",
"cli_prefix": true,
"wait_time_prefix": true,
"agent_sounds": "abcd",
"caller_sounds": "abcd",
"max_wait_time": 559,
"max_callers": 386,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 475,
"retry": 543,
"wrap_up_time": 124,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 175,
"final_dst_type": "abcd",
"final_dst_id": 181,
"hash_to_exit": true,
"liaf": true
}
Responses
201 Created
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 5630,
"ann_freq": 3494,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 9436,
"final_dst_type": "value",
"hash_to_exit": true,
"hold_ann": true,
"ivr_id": 6312,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 6813,
"max_wait_time": 3737,
"moh_id": 1982,
"name": "value",
"number": 4501,
"pos_ann": true,
"retry": 3810,
"ring_strategy": "value",
"ring_time": 777,
"skip_busy": true,
"users": "value",
"wait_time_prefix": true,
"wrap_up_time": 3325
},
"links": {}
}
GET
/queues/{id} Returns Queue resource for given Id
Parameters
Endpoint URL:
{id} integer
Queue identifier
Example Request
GET /v1.1/voipstudio/queues/72 HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9328,
"ann_freq": 1676,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 6281,
"final_dst_type": "value",
"hash_to_exit": true,
"hold_ann": true,
"ivr_id": 9689,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 4438,
"max_wait_time": 1262,
"moh_id": 282,
"name": "value",
"number": 8199,
"pos_ann": true,
"retry": 5437,
"ring_strategy": "value",
"ring_time": 1391,
"skip_busy": true,
"users": "value",
"wait_time_prefix": true,
"wrap_up_time": 9365
},
"links": {}
}
GET
/pickupgroups Returns collection of PickupGroup resources
Example Request
GET /v1.1/voipstudio/pickupgroups HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 3109,
"name": "value",
"users": "value"
}
],
"total": 59
}
GET
/pickupgroups/{id} Returns PickupGroup resource for given Id
Parameters
Endpoint URL:
{id} integer
PickupGroup identifier
Example Request
GET /v1.1/voipstudio/pickupgroups/71 HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7373,
"name": "value",
"users": "value"
},
"links": {}
}
GET
/routingrules Returns collection of RoutingRule resources
Example Request
GET /v1.1/voipstudio/routingrules HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 3628,
"action": "value",
"customer": "value",
"destination": "value",
"direction": "value",
"pos": 7571,
"source": "value",
"time_interval": "value"
}
],
"total": 59
}
GET
/routingrules/{id} Returns routing rule resource for given ID
Parameters
Endpoint URL:
{id} integer
RoutingRule2 identifier
Example Request
GET /v1.1/voipstudio/routingrules/60 HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7158,
"action": "value",
"customer": "value",
"destination": "value",
"direction": "value",
"pos": 2544,
"source": "value",
"time_interval": "value"
},
"links": {}
}
PATCH
/routingrules/{id} Updates existing routing rule resource
Parameters
Endpoint URL:
{id} integer
RoutingRule2 identifier
JSON body attributes:
direction string
pos integer
source undefined
destination undefined
time_interval array
action string
Example Request
PATCH /v1.1/voipstudio/routingrules/88 HTTP/1.1
Host: l7api.com
{
"direction": "abcd",
"pos": 707,
"source": "abcd",
"destination": "abcd",
"time_interval": "abcd",
"action": "abcd"
}
Responses
200 Success
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1009,
"action": "value",
"customer": "value",
"destination": "value",
"direction": "value",
"pos": 7128,
"source": "value",
"time_interval": "value"
},
"links": {}
}
GET
/ivrs Returns collection of Ivr resources
Example Request
GET /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 4116,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 1489,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"one": "value",
"post_sounds": "value",
"repeats": 6751,
"ring_time": 7879,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 7622,
"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
Example Request
POST /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 861,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 564,
"repeats": 575,
"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": 154
}
Responses
201 Created
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 3567,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 6107,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"one": "value",
"post_sounds": "value",
"repeats": 5789,
"ring_time": 5900,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 9142,
"two": "value",
"zero": "value"
},
"links": {}
}
GET
/ivrs/{id} Returns Ivr resource for given Id
Parameters
Endpoint URL:
{id} integer
Ivr identifier
Example Request
GET /v1.1/voipstudio/ivrs/48 HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3943,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 4548,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"one": "value",
"post_sounds": "value",
"repeats": 1229,
"ring_time": 503,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 269,
"two": "value",
"zero": "value"
},
"links": {}
}
PATCH
/ivrs/{id} Updates existing Ivr resource
Parameters
Endpoint URL:
{id} integer
Ivr 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
Example Request
PATCH /v1.1/voipstudio/ivrs/83 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 822,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 239,
"repeats": 514,
"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": 607
}
Responses
200 Success
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": 8817,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 1682,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"one": "value",
"post_sounds": "value",
"repeats": 67,
"ring_time": 3850,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 7390,
"two": "value",
"zero": "value"
},
"links": {}
}
DELETE
/ivrs/{id} Deletes existing Ivr resource
Parameters
Endpoint URL:
{id} integer
Ivr identifier
Example Request
DELETE /v1.1/voipstudio/ivrs/21 HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
GET
/mohs/{id} Returns Moh resource for given Id
Parameters
Endpoint URL:
{id} integer
Moh identifier
Example Request
GET /v1.1/voipstudio/mohs/41 HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8279,
"locked": true,
"name": "value"
},
"links": {}
}
