Endpoints for managing PBX settings such us Telephone Numbers configuration, Contacts, Ring Group, IVRs etc.
No parameters
GET /v1.1/voipstudio/contacts HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 1416,
"created_at": "2019-09-20 02:40:09",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 8846,
"user_id": 325
}
],
"total": 59
}
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
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 9039,
"created_at": "2018-04-29 04:14:04",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 2675,
"user_id": 6537
},
"links": {}
}
PATCH /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
[
{
"id": 798,
"group_name": "abcd"
},
{
"id": 1092,
"group_name": "abcd"
}
]
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7917,
"created_at": "2017-01-02 14:31:21",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 1241,
"user_id": 2733
},
"links": {}
}
GET /v1.1/voipstudio/contacts/70 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7852,
"created_at": "2018-10-19 19:55:32",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 4398,
"user_id": 5811
},
"links": {}
}
PATCH /v1.1/voipstudio/contacts/60 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
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9948,
"created_at": "2017-10-19 02:46:10",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 9309,
"user_id": 8348
},
"links": {}
}
DELETE /v1.1/voipstudio/contacts/29,162,462 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK
No parameters
GET /v1.1/voipstudio/conferences HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 3999,
"ann_join_leave": true,
"confno": 4300,
"confno_pstn": 6654,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
}
],
"total": 59
}
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"
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 399,
"ann_join_leave": true,
"confno": 9318,
"confno_pstn": 7103,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
GET /v1.1/voipstudio/conferences/58 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4760,
"ann_join_leave": true,
"confno": 1720,
"confno_pstn": 1449,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/conferences/12 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"pin": "abcd",
"pin_pstn": "abcd",
"ann_join_leave": true,
"monitor": true,
"ddis": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9555,
"ann_join_leave": true,
"confno": 6611,
"confno_pstn": 5006,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/conferences/94 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK
No parameters
GET /v1.1/voipstudio/ddis HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 2919,
"cli_hide": true,
"cli_prefix": 7515,
"created_at": "2019-08-11 07:04:17",
"e164": "value",
"fax_email": "value",
"flag": "D",
"has_fax_password": true,
"info": "value",
"rate": 4.11,
"status": "O",
"target_id": 6506,
"target_type": "F",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
No parameters
GET /v1.1/voipstudio/ddis/dictionaries HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 5543,
"cli_hide": true,
"cli_prefix": 6361,
"created_at": "2016-12-27 00:42:47",
"e164": "value",
"fax_email": "value",
"flag": "S",
"has_fax_password": true,
"info": "value",
"rate": 8.17,
"status": "N",
"target_id": 6155,
"target_type": "N",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET /v1.1/voipstudio/ddis/{e164} HTTP/1.1
Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 3376,
"cli_hide": true,
"cli_prefix": 2659,
"created_at": "2017-01-26 01:18:36",
"e164": "value",
"fax_email": "value",
"flag": "C",
"has_fax_password": true,
"info": "value",
"rate": 9.2,
"status": "I",
"target_id": 6869,
"target_type": "S",
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
No parameters
GET /v1.1/voipstudio/queues HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 5731,
"ann_freq": 1339,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 7866,
"final_dst_type": "C",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 3514,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 1886,
"max_wait_time": 526,
"moh": 3903,
"name": "value",
"number": 4024,
"pos_ann": true,
"retry": 7425,
"ring_strategy": "A",
"ring_time": 4977,
"skip_busy": true,
"users": 1078,
"wait_time_prefix": true,
"wrap_up_time": 8758
}
],
"total": 59
}
POST /v1.1/voipstudio/queues HTTP/1.1
Host: l7api.com
{
"moh_id": 930,
"ivr_id": 222,
"ddis": "abcd",
"users": [
{
"id": "User ID",
"status": "Bool that indicates that user is logged in by default."
}
],
"name": "abcd",
"number": 568,
"cli_prefix": true,
"wait_time_prefix": true,
"agent_sounds": "abcd",
"caller_sounds": "abcd",
"max_wait_time": 751,
"max_callers": 840,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 512,
"retry": 207,
"wrap_up_time": 243,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 759,
"final_dst_type": "abcd",
"final_dst_id": 446,
"hash_to_exit": true,
"liaf": true
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 4378,
"ann_freq": 8199,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 9430,
"final_dst_type": "C",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 7166,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 8399,
"max_wait_time": 8890,
"moh": 7282,
"name": "value",
"number": 2598,
"pos_ann": true,
"retry": 544,
"ring_strategy": "A",
"ring_time": 777,
"skip_busy": true,
"users": 3163,
"wait_time_prefix": true,
"wrap_up_time": 8095
},
"links": {}
}
GET /v1.1/voipstudio/queues/35 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2934,
"ann_freq": 2730,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 8508,
"final_dst_type": "I",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 8680,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 4542,
"max_wait_time": 4839,
"moh": 5889,
"name": "value",
"number": 600,
"pos_ann": true,
"retry": 2442,
"ring_strategy": "M",
"ring_time": 8697,
"skip_busy": true,
"users": 3637,
"wait_time_prefix": true,
"wrap_up_time": 6987
},
"links": {}
}
No parameters
GET /v1.1/voipstudio/pickupgroups HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 7620,
"name": "value",
"users": 2320
}
],
"total": 59
}
GET /v1.1/voipstudio/pickupgroups/39 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 5081,
"name": "value",
"users": 1827
},
"links": {}
}
No parameters
GET /v1.1/voipstudio/routingrules HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 8429,
"action": "value",
"customer": 6352,
"destination": "value",
"direction": "out",
"pos": 8953,
"source": "value",
"time_interval": "value"
}
],
"total": 59
}
GET /v1.1/voipstudio/routingrules/77 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1847,
"action": "value",
"customer": 2951,
"destination": "value",
"direction": "in",
"pos": 6267,
"source": "value",
"time_interval": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/routingrules/97 HTTP/1.1
Host: l7api.com
{
"direction": "abcd",
"pos": 193,
"source": "abcd",
"destination": "abcd",
"time_interval": "abcd",
"action": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 349,
"action": "value",
"customer": 1380,
"destination": "value",
"direction": "in",
"pos": 4293,
"source": "value",
"time_interval": "value"
},
"links": {}
}
No parameters
GET /v1.1/voipstudio/ivrs HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 1036,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 1927,
"final_dst_type": "C",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 5814,
"one": "value",
"post_sounds": "value",
"repeats": 8804,
"ring_time": 6054,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 2974,
"two": "value",
"zero": "value"
}
],
"total": 59
}
POST /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 961,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 616,
"repeats": 923,
"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": 995,
"number": 976
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 2163,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 606,
"final_dst_type": "C",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 3825,
"one": "value",
"post_sounds": "value",
"repeats": 3860,
"ring_time": 4205,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 1117,
"two": "value",
"zero": "value"
},
"links": {}
}
GET /v1.1/voipstudio/ivrs/21 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1057,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 3057,
"final_dst_type": "R",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 5951,
"one": "value",
"post_sounds": "value",
"repeats": 9814,
"ring_time": 9276,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 4253,
"two": "value",
"zero": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/ivrs/56 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 919,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 557,
"repeats": 596,
"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": 536,
"number": 480
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9177,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 2819,
"final_dst_type": "U",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 897,
"one": "value",
"post_sounds": "value",
"repeats": 9155,
"ring_time": 8688,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 8958,
"two": "value",
"zero": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/ivrs/71 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK
GET /v1.1/voipstudio/mohs/8 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2157,
"locked": true,
"name": "value"
},
"links": {}
}
No parameters
GET /v1.1/voipstudio/contactlabels HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 3737,
"color": "value",
"name": "value"
}
],
"total": 59
}
POST /v1.1/voipstudio/contactlabels HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 1582,
"color": "value",
"name": "value"
},
"links": {}
}
GET /v1.1/voipstudio/contactlabels/55 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8801,
"color": "value",
"name": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/contactlabels/90 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4355,
"color": "value",
"name": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/contactlabels/26 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK