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": 4554,
"created_at": "2018-04-24 15:06:42",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 184,
"user_id": 8161
}
],
"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": 7111,
"created_at": "2019-02-17 22:34:12",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 7472,
"user_id": 8047
},
"links": {}
}
PATCH /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
[
{
"id": 327,
"group_name": "abcd"
},
{
"id": 8531,
"group_name": "abcd"
}
]
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7126,
"created_at": "2020-05-09 23:20:44",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 6177,
"user_id": 3937
},
"links": {}
}
GET /v1.1/voipstudio/contacts/68 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2035,
"created_at": "2017-05-22 05:07:36",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 9925,
"user_id": 4480
},
"links": {}
}
PATCH /v1.1/voipstudio/contacts/30 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": 6048,
"created_at": "2019-09-02 13:21:18",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 9949,
"user_id": 7060
},
"links": {}
}
DELETE /v1.1/voipstudio/contacts/37,196,441 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": 1588,
"ann_join_leave": true,
"confno": 2949,
"confno_pstn": 2164,
"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": 6956,
"ann_join_leave": true,
"confno": 7580,
"confno_pstn": 9446,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
GET /v1.1/voipstudio/conferences/64 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 6457,
"ann_join_leave": true,
"confno": 8113,
"confno_pstn": 4393,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/conferences/62 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": 971,
"ann_join_leave": true,
"confno": 3138,
"confno_pstn": 1343,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/conferences/91 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": 4946,
"cli_hide": true,
"cli_prefix": 526,
"created_at": "2019-05-17 20:55:59",
"e164": "value",
"fax_email": "value",
"flag": "S",
"has_fax_password": true,
"info": "value",
"rate": 4.1,
"status": "N",
"target_id": 5550,
"target_type": "I",
"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": 4944,
"cli_hide": true,
"cli_prefix": 4247,
"created_at": "2017-04-16 16:04:50",
"e164": "value",
"fax_email": "value",
"flag": "D",
"has_fax_password": true,
"info": "value",
"rate": 6.33,
"status": "C",
"target_id": 5844,
"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": 530,
"cli_hide": true,
"cli_prefix": 5035,
"created_at": "2018-07-16 12:30:28",
"e164": "value",
"fax_email": "value",
"flag": "S",
"has_fax_password": true,
"info": "value",
"rate": 3.17,
"status": "I",
"target_id": 4979,
"target_type": "R",
"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": 5347,
"ann_freq": 7952,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 6594,
"final_dst_type": "I",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 9958,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 1191,
"max_wait_time": 2396,
"moh": 8076,
"name": "value",
"number": 6585,
"pos_ann": true,
"retry": 6131,
"ring_strategy": "A",
"ring_time": 3708,
"skip_busy": true,
"users": 2422,
"wait_time_prefix": true,
"wrap_up_time": 1456
}
],
"total": 59
}
POST /v1.1/voipstudio/queues HTTP/1.1
Host: l7api.com
{
"moh_id": 232,
"ivr_id": 725,
"ddis": "abcd",
"users": [
{
"id": "User ID",
"status": "Bool that indicates that user is logged in by default."
}
],
"name": "abcd",
"number": 567,
"cli_prefix": true,
"wait_time_prefix": true,
"agent_sounds": "abcd",
"caller_sounds": "abcd",
"max_wait_time": 355,
"max_callers": 272,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 790,
"retry": 846,
"wrap_up_time": 320,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 435,
"final_dst_type": "abcd",
"final_dst_id": 398,
"hash_to_exit": true,
"liaf": true
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 9126,
"ann_freq": 2020,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 8370,
"final_dst_type": "C",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 5737,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 5712,
"max_wait_time": 4701,
"moh": 7018,
"name": "value",
"number": 4322,
"pos_ann": true,
"retry": 7689,
"ring_strategy": "M",
"ring_time": 5888,
"skip_busy": true,
"users": 9353,
"wait_time_prefix": true,
"wrap_up_time": 422
},
"links": {}
}
GET /v1.1/voipstudio/queues/65 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 5330,
"ann_freq": 568,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 1254,
"final_dst_type": "U",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 9639,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 7785,
"max_wait_time": 8356,
"moh": 9918,
"name": "value",
"number": 9846,
"pos_ann": true,
"retry": 5714,
"ring_strategy": "H",
"ring_time": 1685,
"skip_busy": true,
"users": 66,
"wait_time_prefix": true,
"wrap_up_time": 9351
},
"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": 3041,
"name": "value",
"users": 2705
}
],
"total": 59
}
GET /v1.1/voipstudio/pickupgroups/28 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7520,
"name": "value",
"users": 6515
},
"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": 8534,
"action": "value",
"customer": 2117,
"destination": "value",
"direction": "in",
"pos": 3548,
"source": "value",
"time_interval": "value"
}
],
"total": 59
}
GET /v1.1/voipstudio/routingrules/54 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2719,
"action": "value",
"customer": 8288,
"destination": "value",
"direction": "out",
"pos": 5714,
"source": "value",
"time_interval": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/routingrules/54 HTTP/1.1
Host: l7api.com
{
"direction": "abcd",
"pos": 128,
"source": "abcd",
"destination": "abcd",
"time_interval": "abcd",
"action": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3359,
"action": "value",
"customer": 2898,
"destination": "value",
"direction": "in",
"pos": 469,
"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": 8097,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 2249,
"final_dst_type": "Q",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 8745,
"one": "value",
"post_sounds": "value",
"repeats": 9033,
"ring_time": 3067,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 8700,
"two": "value",
"zero": "value"
}
],
"total": 59
}
POST /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 772,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 352,
"repeats": 117,
"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": 393,
"number": 375
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 8209,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 5065,
"final_dst_type": "Q",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 6960,
"one": "value",
"post_sounds": "value",
"repeats": 149,
"ring_time": 3504,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 1791,
"two": "value",
"zero": "value"
},
"links": {}
}
GET /v1.1/voipstudio/ivrs/94 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8850,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 3101,
"final_dst_type": "H",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 9797,
"one": "value",
"post_sounds": "value",
"repeats": 3906,
"ring_time": 538,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 4068,
"two": "value",
"zero": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/ivrs/9 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 654,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 935,
"repeats": 754,
"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": 907,
"number": 954
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3636,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 8977,
"final_dst_type": "I",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 489,
"one": "value",
"post_sounds": "value",
"repeats": 3215,
"ring_time": 9706,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 8832,
"two": "value",
"zero": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/ivrs/27 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK
GET /v1.1/voipstudio/mohs/91 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3481,
"locked": true,
"name": "value"
},
"links": {}
}