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": 1015,
"created_at": "2016-05-27 12:17:49",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 5552,
"user_id": 7322
}
],
"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": 9130,
"created_at": "2016-08-30 07:36:36",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 2973,
"user_id": 9111
},
"links": {}
}
PATCH /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
[
{
"id": 531,
"group_name": "abcd"
},
{
"id": 1175,
"group_name": "abcd"
}
]
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 5996,
"created_at": "2017-11-28 20:20:23",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 1806,
"user_id": 8505
},
"links": {}
}
GET /v1.1/voipstudio/contacts/62 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7678,
"created_at": "2018-08-07 22:15:04",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 4262,
"user_id": 5274
},
"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": 3955,
"created_at": "2017-09-05 21:12:10",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 1618,
"user_id": 749
},
"links": {}
}
DELETE /v1.1/voipstudio/contacts/62,156,422 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": 5521,
"ann_join_leave": true,
"confno": 839,
"pin": "value"
}
],
"total": 59
}
POST /v1.1/voipstudio/conferences HTTP/1.1
Host: l7api.com
{
"pin": "abcd",
"ann_join_leave": true,
"ddis": "abcd"
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 372,
"ann_join_leave": true,
"confno": 6154,
"pin": "value"
},
"links": {}
}
GET /v1.1/voipstudio/conferences/43 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3113,
"ann_join_leave": true,
"confno": 5063,
"pin": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/conferences/49 HTTP/1.1
Host: l7api.com
{
"pin": "abcd",
"ann_join_leave": true,
"ddis": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8733,
"ann_join_leave": true,
"confno": 970,
"pin": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/conferences/88 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": 167,
"cli_hide": true,
"cli_prefix": 584,
"created_at": "2016-06-23 12:29:00",
"e164": "value",
"fax_email": "value",
"flag": "value",
"has_fax_password": true,
"info": "value",
"rate": 5.17,
"status": "value",
"target_id": 9795,
"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": 3343,
"cli_hide": true,
"cli_prefix": 1619,
"created_at": "2017-04-20 06:41:27",
"e164": "value",
"fax_email": "value",
"flag": "value",
"has_fax_password": true,
"info": "value",
"rate": 3.11,
"status": "value",
"target_id": 2217,
"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": 66,
"cli_hide": true,
"cli_prefix": 9131,
"created_at": "2019-04-29 01:21:44",
"e164": "value",
"fax_email": "value",
"flag": "value",
"has_fax_password": true,
"info": "value",
"rate": 5.33,
"status": "value",
"target_id": 6199,
"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": 4972,
"ann_freq": 3843,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 7720,
"final_dst_type": "value",
"hash_to_exit": true,
"hold_ann": true,
"ivr_id": 5158,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 4018,
"max_wait_time": 5132,
"moh_id": 3386,
"name": "value",
"number": 4724,
"pos_ann": true,
"retry": 4871,
"ring_strategy": "value",
"ring_time": 7279,
"skip_busy": true,
"users": "value",
"wait_time_prefix": true,
"wrap_up_time": 1172
}
],
"total": 59
}
POST /v1.1/voipstudio/queues HTTP/1.1
Host: l7api.com
{
"moh_id": 612,
"ivr_id": 704,
"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": 709,
"max_callers": 189,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 891,
"retry": 942,
"wrap_up_time": 560,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 615,
"final_dst_type": "abcd",
"final_dst_id": 841,
"hash_to_exit": true,
"liaf": true
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 9410,
"ann_freq": 5424,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 8562,
"final_dst_type": "value",
"hash_to_exit": true,
"hold_ann": true,
"ivr_id": 2703,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 9461,
"max_wait_time": 8883,
"moh_id": 8448,
"name": "value",
"number": 6143,
"pos_ann": true,
"retry": 3434,
"ring_strategy": "value",
"ring_time": 704,
"skip_busy": true,
"users": "value",
"wait_time_prefix": true,
"wrap_up_time": 4434
},
"links": {}
}
GET /v1.1/voipstudio/queues/36 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1701,
"ann_freq": 2970,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 4253,
"final_dst_type": "value",
"hash_to_exit": true,
"hold_ann": true,
"ivr_id": 4286,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 8472,
"max_wait_time": 9725,
"moh_id": 6071,
"name": "value",
"number": 6847,
"pos_ann": true,
"retry": 8524,
"ring_strategy": "value",
"ring_time": 7849,
"skip_busy": true,
"users": "value",
"wait_time_prefix": true,
"wrap_up_time": 7829
},
"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": 1808,
"name": "value",
"users": "value"
}
],
"total": 59
}
GET /v1.1/voipstudio/pickupgroups/18 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7929,
"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": 7172,
"action": "value",
"customer": "value",
"destination": "value",
"direction": "value",
"pos": 8102,
"source": "value",
"time_interval": "value"
}
],
"total": 59
}
GET /v1.1/voipstudio/routingrules/5 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2799,
"action": "value",
"customer": "value",
"destination": "value",
"direction": "value",
"pos": 8442,
"source": "value",
"time_interval": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/routingrules/59 HTTP/1.1
Host: l7api.com
{
"direction": "abcd",
"pos": 564,
"source": "abcd",
"destination": "abcd",
"time_interval": "abcd",
"action": "abcd"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7064,
"action": "value",
"customer": "value",
"destination": "value",
"direction": "value",
"pos": 5712,
"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": 25,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 7950,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"one": "value",
"post_sounds": "value",
"repeats": 6119,
"ring_time": 9218,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 5700,
"two": "value",
"zero": "value"
}
],
"total": 59
}
POST /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 431,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 872,
"repeats": 654,
"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": 178
}
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 999,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 9438,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"one": "value",
"post_sounds": "value",
"repeats": 2017,
"ring_time": 7134,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 1966,
"two": "value",
"zero": "value"
},
"links": {}
}
GET /v1.1/voipstudio/ivrs/78 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 5438,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 7733,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"one": "value",
"post_sounds": "value",
"repeats": 7924,
"ring_time": 1056,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 3539,
"two": "value",
"zero": "value"
},
"links": {}
}
PATCH /v1.1/voipstudio/ivrs/12 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 879,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 524,
"repeats": 195,
"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": 492
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9751,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 4024,
"final_dst_type": "value",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"one": "value",
"post_sounds": "value",
"repeats": 3357,
"ring_time": 6497,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 5420,
"two": "value",
"zero": "value"
},
"links": {}
}
DELETE /v1.1/voipstudio/ivrs/80 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK
GET /v1.1/voipstudio/mohs/12 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8614,
"locked": true,
"name": "value"
},
"links": {}
}