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": 5936,
"created_at": "2016-09-30 15:03:07",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 6152,
"user_id": 7294
}
],
"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": 8404,
"created_at": "2020-09-12 07:06:51",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 3983,
"user_id": 6535
},
"links": {}
}
PATCH /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
[
{
"id": 596,
"group_name": "abcd"
},
{
"id": 8734,
"group_name": "abcd"
}
]
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8949,
"created_at": "2017-08-12 00:33:01",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 963,
"user_id": 733
},
"links": {}
}
GET /v1.1/voipstudio/contacts/86 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3713,
"created_at": "2018-05-01 18:56:38",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 9504,
"user_id": 5441
},
"links": {}
}
PATCH /v1.1/voipstudio/contacts/48 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": 5198,
"created_at": "2017-01-29 03:55:56",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 7,
"user_id": 8407
},
"links": {}
}
DELETE /v1.1/voipstudio/contacts/24,140,434 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": 2146,
"ann_join_leave": true,
"confno": 1497,
"confno_pstn": 1633,
"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": 28,
"ann_join_leave": true,
"confno": 5116,
"confno_pstn": 791,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
GET /v1.1/voipstudio/conferences/56 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9198,
"ann_join_leave": true,
"confno": 5494,
"confno_pstn": 4551,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/conferences/33 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": 5613,
"ann_join_leave": true,
"confno": 7821,
"confno_pstn": 8659,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/conferences/59 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": 245,
"cli_hide": true,
"cli_prefix": 5901,
"created_at": "2017-01-28 21:15:41",
"e164": "value",
"fax_email": "value",
"flag": "R",
"has_fax_password": true,
"info": "value",
"rate": 7.2,
"status": "C",
"target_id": 9450,
"target_type": "T",
"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": 6235,
"cli_hide": true,
"cli_prefix": 8875,
"created_at": "2017-01-23 19:52:25",
"e164": "value",
"fax_email": "value",
"flag": "S",
"has_fax_password": true,
"info": "value",
"rate": 9.1,
"status": "N",
"target_id": 413,
"target_type": "U",
"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": 441,
"cli_hide": true,
"cli_prefix": 9264,
"created_at": "2020-04-03 22:22:26",
"e164": "value",
"fax_email": "value",
"flag": "R",
"has_fax_password": true,
"info": "value",
"rate": 2.14,
"status": "N",
"target_id": 990,
"target_type": "N",
"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": 414,
"ann_freq": 9160,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 1784,
"final_dst_type": "H",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 5099,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 824,
"max_wait_time": 1146,
"moh": 9261,
"name": "value",
"number": 4297,
"pos_ann": true,
"retry": 7055,
"ring_strategy": "H",
"ring_time": 289,
"skip_busy": true,
"users": 662,
"wait_time_prefix": true,
"wrap_up_time": 8844
}
],
"total": 59
}
POST /v1.1/voipstudio/queues HTTP/1.1
Host: l7api.com
{
"moh_id": 922,
"ivr_id": 241,
"ddis": "abcd",
"users": [
{
"id": "User ID",
"status": "Bool that indicates that user is logged in by default."
}
],
"name": "abcd",
"number": 448,
"cli_prefix": true,
"wait_time_prefix": true,
"agent_sounds": "abcd",
"caller_sounds": "abcd",
"max_wait_time": 832,
"max_callers": 330,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 486,
"retry": 450,
"wrap_up_time": 370,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 262,
"final_dst_type": "abcd",
"final_dst_id": 383,
"hash_to_exit": true,
"liaf": true
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 6492,
"ann_freq": 2227,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 6819,
"final_dst_type": "R",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 5142,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 789,
"max_wait_time": 4351,
"moh": 164,
"name": "value",
"number": 6231,
"pos_ann": true,
"retry": 4518,
"ring_strategy": "M",
"ring_time": 5171,
"skip_busy": true,
"users": 3940,
"wait_time_prefix": true,
"wrap_up_time": 7659
},
"links": {}
}
GET /v1.1/voipstudio/queues/62 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 242,
"ann_freq": 7812,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 7907,
"final_dst_type": "U",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 7238,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 3251,
"max_wait_time": 6327,
"moh": 1752,
"name": "value",
"number": 3439,
"pos_ann": true,
"retry": 6939,
"ring_strategy": "H",
"ring_time": 9486,
"skip_busy": true,
"users": 2432,
"wait_time_prefix": true,
"wrap_up_time": 2338
},
"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": 2542,
"name": "value",
"users": 9167
}
],
"total": 59
}
GET /v1.1/voipstudio/pickupgroups/37 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2068,
"name": "value",
"users": 8912
},
"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": 1487,
"action": "value",
"customer": 6742,
"destination": "value",
"direction": "in",
"pos": 4082,
"source": "value",
"time_interval": "value"
}
],
"total": 59
}
GET /v1.1/voipstudio/routingrules/38 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 6984,
"action": "value",
"customer": 1123,
"destination": "value",
"direction": "out",
"pos": 3129,
"source": "value",
"time_interval": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/routingrules/63 HTTP/1.1
Host: l7api.com
{
"direction": "abcd",
"pos": 930,
"source": "abcd",
"destination": "abcd",
"time_interval": "abcd",
"action": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3988,
"action": "value",
"customer": 7640,
"destination": "value",
"direction": "out",
"pos": 4606,
"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": 4601,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 2807,
"final_dst_type": "Q",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 2827,
"one": "value",
"post_sounds": "value",
"repeats": 9545,
"ring_time": 2765,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 8725,
"two": "value",
"zero": "value"
}
],
"total": 59
}
POST /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 673,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 361,
"repeats": 270,
"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": 797,
"number": 443
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 8128,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 4429,
"final_dst_type": "Q",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 1440,
"one": "value",
"post_sounds": "value",
"repeats": 598,
"ring_time": 4583,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 2635,
"two": "value",
"zero": "value"
},
"links": {}
}
GET /v1.1/voipstudio/ivrs/25 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8052,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 1178,
"final_dst_type": "Q",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 9581,
"one": "value",
"post_sounds": "value",
"repeats": 3374,
"ring_time": 9455,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 1632,
"two": "value",
"zero": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/ivrs/39 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 453,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 304,
"repeats": 635,
"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": 716,
"number": 475
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3073,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 5277,
"final_dst_type": "I",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 134,
"one": "value",
"post_sounds": "value",
"repeats": 771,
"ring_time": 7601,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 4682,
"two": "value",
"zero": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/ivrs/98 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK
GET /v1.1/voipstudio/mohs/39 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7989,
"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": 1310,
"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": 9675,
"color": "value",
"name": "value"
},
"links": {}
}
GET /v1.1/voipstudio/contactlabels/24 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4832,
"color": "value",
"name": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/contactlabels/88 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9947,
"color": "value",
"name": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/contactlabels/23 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK