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": 5607, "created_at": "2018-07-20 12:40:18", "first_name": "value", "global": true, "group_name": "value", "internal": true, "last_name": "value", "rel_user_id": 5159, "user_id": 590 } ], "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": 1254, "created_at": "2017-03-19 13:30:26", "first_name": "value", "global": true, "group_name": "value", "internal": true, "last_name": "value", "rel_user_id": 1409, "user_id": 2733 }, "links": {} }
PATCH /v1.1/voipstudio/contacts HTTP/1.1 Host: l7api.com [ { "id": 368, "group_name": "abcd" }, { "id": 9663, "group_name": "abcd" } ]
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 5199, "created_at": "2020-12-19 19:07:03", "first_name": "value", "global": true, "group_name": "value", "internal": true, "last_name": "value", "rel_user_id": 2418, "user_id": 4842 }, "links": {} }
GET /v1.1/voipstudio/contacts/49 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 4539, "created_at": "2017-06-15 23:44:07", "first_name": "value", "global": true, "group_name": "value", "internal": true, "last_name": "value", "rel_user_id": 9368, "user_id": 4976 }, "links": {} }
PATCH /v1.1/voipstudio/contacts/57 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": 2458, "created_at": "2017-07-24 11:29:09", "first_name": "value", "global": true, "group_name": "value", "internal": true, "last_name": "value", "rel_user_id": 554, "user_id": 1805 }, "links": {} }
DELETE /v1.1/voipstudio/contacts/68,148,463 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": 8891, "ann_join_leave": true, "confno": 1807, "confno_pstn": 9775, "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": 9834, "ann_join_leave": true, "confno": 6892, "confno_pstn": 3068, "monitor": true, "name": "value", "pin": "value", "pin_pstn": "value" }, "links": {} }
GET /v1.1/voipstudio/conferences/8 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 5420, "ann_join_leave": true, "confno": 9563, "confno_pstn": 209, "monitor": true, "name": "value", "pin": "value", "pin_pstn": "value" }, "links": {} }
PATCH /v1.1/voipstudio/conferences/6 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": 1527, "ann_join_leave": true, "confno": 4278, "confno_pstn": 3446, "monitor": true, "name": "value", "pin": "value", "pin_pstn": "value" }, "links": {} }
DELETE /v1.1/voipstudio/conferences/68 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": 9093, "cli_hide": true, "cli_prefix": 1553, "created_at": "2016-08-05 06:16:02", "e164": "value", "fax_email": "value", "flag": "P", "has_fax_password": true, "info": "value", "rate": 2.11, "status": "T", "target_id": 5477, "target_type": "S", "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": 1527, "cli_hide": true, "cli_prefix": 4459, "created_at": "2019-08-28 04:09:21", "e164": "value", "fax_email": "value", "flag": "P", "has_fax_password": true, "info": "value", "rate": 3.33, "status": "O", "target_id": 4852, "target_type": "T", "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": 3698, "cli_hide": true, "cli_prefix": 7040, "created_at": "2018-10-17 01:15:50", "e164": "value", "fax_email": "value", "flag": "R", "has_fax_password": true, "info": "value", "rate": 6.1, "status": "U", "target_id": 8220, "target_type": "U", "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": 3675, "ann_freq": 6648, "caller_sounds": "value", "cli_prefix": true, "final_dst_id": 269, "final_dst_type": "H", "hash_to_exit": true, "hold_ann": true, "ivr": 2701, "join_empty": true, "language": "value", "liaf": true, "max_callers": 8524, "max_wait_time": 1021, "moh": 6195, "name": "value", "number": 9081, "pos_ann": true, "retry": 52, "ring_strategy": "A", "ring_time": 2193, "skip_busy": true, "users": 3293, "wait_time_prefix": true, "wrap_up_time": 4508 } ], "total": 59 }
POST /v1.1/voipstudio/queues HTTP/1.1 Host: l7api.com { "moh_id": 904, "ivr_id": 279, "ddis": "abcd", "users": [ { "id": "User ID", "status": "Bool that indicates that user is logged in by default." } ], "name": "abcd", "number": 811, "cli_prefix": true, "wait_time_prefix": true, "agent_sounds": "abcd", "caller_sounds": "abcd", "max_wait_time": 938, "max_callers": 119, "join_empty": true, "ring_strategy": "abcd", "ring_time": 428, "retry": 845, "wrap_up_time": 452, "skip_busy": true, "language": "abcd", "pos_ann": true, "hold_ann": true, "ann_freq": 132, "final_dst_type": "abcd", "final_dst_id": 579, "hash_to_exit": true, "liaf": true }
HTTP/1.1 201 OK Content-Type: application/json { "data": { "id": 6043, "ann_freq": 6511, "caller_sounds": "value", "cli_prefix": true, "final_dst_id": 8100, "final_dst_type": "U", "hash_to_exit": true, "hold_ann": true, "ivr": 306, "join_empty": true, "language": "value", "liaf": true, "max_callers": 5124, "max_wait_time": 7937, "moh": 4693, "name": "value", "number": 8244, "pos_ann": true, "retry": 5532, "ring_strategy": "M", "ring_time": 6462, "skip_busy": true, "users": 4266, "wait_time_prefix": true, "wrap_up_time": 1455 }, "links": {} }
GET /v1.1/voipstudio/queues/45 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 6524, "ann_freq": 6103, "caller_sounds": "value", "cli_prefix": true, "final_dst_id": 5229, "final_dst_type": "U", "hash_to_exit": true, "hold_ann": true, "ivr": 7207, "join_empty": true, "language": "value", "liaf": true, "max_callers": 447, "max_wait_time": 6857, "moh": 369, "name": "value", "number": 8958, "pos_ann": true, "retry": 7155, "ring_strategy": "M", "ring_time": 2187, "skip_busy": true, "users": 8568, "wait_time_prefix": true, "wrap_up_time": 277 }, "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": 7861, "name": "value", "users": 4187 } ], "total": 59 }
GET /v1.1/voipstudio/pickupgroups/16 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 6580, "name": "value", "users": 3358 }, "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": 7616, "action": "value", "customer": 6944, "destination": "value", "direction": "out", "pos": 2875, "source": "value", "time_interval": "value" } ], "total": 59 }
GET /v1.1/voipstudio/routingrules/52 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 2447, "action": "value", "customer": 5916, "destination": "value", "direction": "out", "pos": 1526, "source": "value", "time_interval": "value" }, "links": {} }
PATCH /v1.1/voipstudio/routingrules/77 HTTP/1.1 Host: l7api.com { "direction": "abcd", "pos": 984, "source": "abcd", "destination": "abcd", "time_interval": "abcd", "action": "abcd" }
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 5864, "action": "value", "customer": 1830, "destination": "value", "direction": "out", "pos": 3460, "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": 3843, "eight": "value", "ext_dialing": true, "final_dst_id": 7995, "final_dst_type": "V", "five": "value", "four": "value", "hash": "value", "language": "value", "name": "value", "nine": "value", "number": 8400, "one": "value", "post_sounds": "value", "repeats": 3977, "ring_time": 3821, "seven": "value", "six": "value", "sounds": "value", "star": "value", "three": "value", "timeout": 5124, "two": "value", "zero": "value" } ], "total": 59 }
POST /v1.1/voipstudio/ivrs HTTP/1.1 Host: l7api.com { "name": "abcd", "ring_time": 373, "sounds": "abcd", "post_sounds": "abcd", "ddis": "abcd", "timeout": 172, "repeats": 605, "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": 478, "number": 908 }
HTTP/1.1 201 OK Content-Type: application/json { "data": { "id": 2051, "eight": "value", "ext_dialing": true, "final_dst_id": 5459, "final_dst_type": "H", "five": "value", "four": "value", "hash": "value", "language": "value", "name": "value", "nine": "value", "number": 1070, "one": "value", "post_sounds": "value", "repeats": 152, "ring_time": 6012, "seven": "value", "six": "value", "sounds": "value", "star": "value", "three": "value", "timeout": 2627, "two": "value", "zero": "value" }, "links": {} }
GET /v1.1/voipstudio/ivrs/9 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 1836, "eight": "value", "ext_dialing": true, "final_dst_id": 828, "final_dst_type": "Q", "five": "value", "four": "value", "hash": "value", "language": "value", "name": "value", "nine": "value", "number": 4953, "one": "value", "post_sounds": "value", "repeats": 6863, "ring_time": 8320, "seven": "value", "six": "value", "sounds": "value", "star": "value", "three": "value", "timeout": 6850, "two": "value", "zero": "value" }, "links": {} }
PATCH /v1.1/voipstudio/ivrs/25 HTTP/1.1 Host: l7api.com { "name": "abcd", "ring_time": 517, "sounds": "abcd", "post_sounds": "abcd", "ddis": "abcd", "timeout": 704, "repeats": 819, "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": 590, "number": 309 }
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 4374, "eight": "value", "ext_dialing": true, "final_dst_id": 3653, "final_dst_type": "Q", "five": "value", "four": "value", "hash": "value", "language": "value", "name": "value", "nine": "value", "number": 2457, "one": "value", "post_sounds": "value", "repeats": 840, "ring_time": 8446, "seven": "value", "six": "value", "sounds": "value", "star": "value", "three": "value", "timeout": 3505, "two": "value", "zero": "value" }, "links": {} }
DELETE /v1.1/voipstudio/ivrs/96 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK
GET /v1.1/voipstudio/mohs/58 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 3085, "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": 6311, "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": 5595, "color": "value", "name": "value" }, "links": {} }
GET /v1.1/voipstudio/contactlabels/90 HTTP/1.1 Host: l7api.com
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 7348, "color": "value", "name": "value" }, "links": {} }
PATCH /v1.1/voipstudio/contactlabels/74 HTTP/1.1 Host: l7api.com { "name": "abcd", "color": "abcd" }
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 2452, "color": "value", "name": "value" }, "links": {} }
DELETE /v1.1/voipstudio/contactlabels/27 HTTP/1.1 Host: l7api.com
HTTP/1.1 204 OK