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": 7453,
"created_at": "2018-07-08 12:24:44",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 8280,
"user_id": 3206
}
],
"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",
"global": true
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 6849,
"created_at": "2017-07-05 20:15:22",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 2567,
"user_id": 898
},
"links": {}
}
PATCH /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
[
{
"id": 615,
"group_name": "abcd"
},
{
"id": 6926,
"group_name": "abcd"
}
]
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4036,
"created_at": "2017-01-11 14:42:02",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 892,
"user_id": 6851
},
"links": {}
}
GET /v1.1/voipstudio/contacts/75 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4240,
"created_at": "2018-01-19 01:12:47",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 3236,
"user_id": 689
},
"links": {}
}
PATCH /v1.1/voipstudio/contacts/22 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
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9208,
"created_at": "2016-12-07 05:26:49",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 219,
"user_id": 7064
},
"links": {}
}
DELETE /v1.1/voipstudio/contacts/51,129,481 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": 7654,
"ann_join_leave": true,
"confno": 2027,
"monitor": true,
"pin": "value"
}
],
"total": 59
}
POST /v1.1/voipstudio/conferences HTTP/1.1
Host: l7api.com
{
"pin": "abcd",
"ann_join_leave": true,
"monitor": true,
"ddis": "abcd"
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 5946,
"ann_join_leave": true,
"confno": 5616,
"monitor": true,
"pin": "value"
},
"links": {}
}
GET /v1.1/voipstudio/conferences/9 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1044,
"ann_join_leave": true,
"confno": 6125,
"monitor": true,
"pin": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/conferences/72 HTTP/1.1
Host: l7api.com
{
"pin": "abcd",
"ann_join_leave": true,
"monitor": true,
"ddis": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7003,
"ann_join_leave": true,
"confno": 7638,
"monitor": true,
"pin": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/conferences/78 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": 4090,
"cli_hide": true,
"cli_prefix": 8996,
"created_at": "2016-07-13 15:05:03",
"e164": "value",
"fax_email": "value",
"flag": "value",
"has_fax_password": true,
"info": "value",
"rate": 4.17,
"status": "value",
"target_id": 8144,
"target_type": "value",
"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": 4970,
"cli_hide": true,
"cli_prefix": 1138,
"created_at": "2017-01-27 11:18:03",
"e164": "value",
"fax_email": "value",
"flag": "value",
"has_fax_password": true,
"info": "value",
"rate": 2.2,
"status": "value",
"target_id": 3878,
"target_type": "value",
"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": 9341,
"cli_hide": true,
"cli_prefix": 7998,
"created_at": "2018-08-18 05:28:51",
"e164": "value",
"fax_email": "value",
"flag": "value",
"has_fax_password": true,
"info": "value",
"rate": 8.14,
"status": "value",
"target_id": 8480,
"target_type": "value",
"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": 754,
"ann_freq": 2460,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 2785,
"final_dst_type": "value",
"hash_to_exit": true,
"hold_ann": true,
"ivr_id": 3647,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 6454,
"max_wait_time": 88,
"moh_id": 8081,
"name": "value",
"number": 4462,
"pos_ann": true,
"retry": 916,
"ring_strategy": "value",
"ring_time": 8417,
"skip_busy": true,
"users": "value",
"wait_time_prefix": true,
"wrap_up_time": 4207
}
],
"total": 59
}
POST /v1.1/voipstudio/queues HTTP/1.1
Host: l7api.com
{
"moh_id": 741,
"ivr_id": 373,
"ddis": "abcd",
"users": [
{
"id": "User ID",
"status": "Bool that indicates that user is logged in by default."
}
],
"name": "abcd",
"number": 529,
"cli_prefix": true,
"wait_time_prefix": true,
"agent_sounds": "abcd",
"caller_sounds": "abcd",
"max_wait_time": 277,
"max_callers": 551,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 418,
"retry": 512,
"wrap_up_time": 390,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 946,
"final_dst_type": "abcd",
"final_dst_id": 375,
"hash_to_exit": true,
"liaf": true
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 4638,
"ann_freq": 7831,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 3970,
"final_dst_type": "value",
"hash_to_exit": true,
"hold_ann": true,
"ivr_id": 8744,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 5009,
"max_wait_time": 6765,
"moh_id": 7884,
"name": "value",
"number": 6658,
"pos_ann": true,
"retry": 7515,
"ring_strategy": "value",
"ring_time": 7747,
"skip_busy": true,
"users": "value",
"wait_time_prefix": true,
"wrap_up_time": 9467
},
"links": {}
}
GET /v1.1/voipstudio/queues/82 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8660,
"ann_freq": 7556,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 1729,
"final_dst_type": "value",
"hash_to_exit": true,
"hold_ann": true,
"ivr_id": 8508,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 649,
"max_wait_time": 8765,
"moh_id": 8302,
"name": "value",
"number": 9303,
"pos_ann": true,
"retry": 2319,
"ring_strategy": "value",
"ring_time": 4326,
"skip_busy": true,
"users": "value",
"wait_time_prefix": true,
"wrap_up_time": 5235
},
"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": 4117,
"name": "value",
"users": "value"
}
],
"total": 59
}
GET /v1.1/voipstudio/pickupgroups/59 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9691,
"name": "value",
"users": "value"
},
"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": 9962,
"action": "value",
"customer": "value",
"destination": "value",
"direction": "value",
"pos": 1645,
"source": "value",
"time_interval": "value"
}
],
"total": 59
}
GET /v1.1/voipstudio/routingrules/23 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 5271,
"action": "value",
"customer": "value",
"destination": "value",
"direction": "value",
"pos": 3117,
"source": "value",
"time_interval": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/routingrules/31 HTTP/1.1
Host: l7api.com
{
"direction": "abcd",
"pos": 504,
"source": "abcd",
"destination": "abcd",
"time_interval": "abcd",
"action": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3516,
"action": "value",
"customer": "value",
"destination": "value",
"direction": "value",
"pos": 8790,
"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": 4768,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 4460,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 6742,
"one": "value",
"post_sounds": "value",
"repeats": 9035,
"ring_time": 7799,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 586,
"two": "value",
"zero": "value"
}
],
"total": 59
}
POST /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 359,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 386,
"repeats": 530,
"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": 356,
"number": 534
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 1047,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 3871,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 8053,
"one": "value",
"post_sounds": "value",
"repeats": 5251,
"ring_time": 5574,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 736,
"two": "value",
"zero": "value"
},
"links": {}
}
GET /v1.1/voipstudio/ivrs/53 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 431,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 9642,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 7726,
"one": "value",
"post_sounds": "value",
"repeats": 7144,
"ring_time": 1667,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 6898,
"two": "value",
"zero": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/ivrs/87 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 880,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 650,
"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": 587,
"number": 911
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3353,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 4099,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 5378,
"one": "value",
"post_sounds": "value",
"repeats": 4646,
"ring_time": 360,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 9313,
"two": "value",
"zero": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/ivrs/93 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK
GET /v1.1/voipstudio/mohs/62 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8104,
"locked": true,
"name": "value"
},
"links": {}
}