Settings module
Endpoints for managing PBX settings such us Telephone Numbers configuration, Contacts, Ring Group, IVRs etc.
GET
/calltracking/ddis Returns collection of Call Tracking Ddi resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/calltracking/ddis HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 7842,
"cli_hide": true,
"cli_prefix": 2087,
"created_at": "2016-05-19 07:18:31",
"e164": "value",
"esc_enabled": true,
"fax_email": "value",
"fax_enabled": true,
"flag": 6,
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 7.5,
"sms_email": "value",
"sms_enabled": true,
"status": 0,
"target_id": 6167,
"target_type": 5,
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
PATCH
/calltracking/ddis [BULK] Updates folder of existing Ddi resources
Parameters
JSON body attributes:
e164 string
campaign_id integer
Example Request
PATCH /v1.1/voipstudio/calltracking/ddis HTTP/1.1
Host: l7api.com
[
{
"e164": "abcd",
"campaign_id": 187
},
{
"e164": "abcd",
"campaign_id": 187,
"id": 1172
}
]
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": "value",
"channels": 5744,
"cli_hide": true,
"cli_prefix": 9560,
"created_at": "2024-07-30 02:13:41",
"e164": "value",
"esc_enabled": true,
"fax_email": "value",
"fax_enabled": true,
"flag": 1,
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 4.2,
"sms_email": "value",
"sms_enabled": true,
"status": 1,
"target_id": 7349,
"target_type": 3,
"tel_verified": true,
"uri": "value"
},
"links": {}
}
GET
/calltracking/campaigns Returns collection of Campaign resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/calltracking/campaigns HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 679,
"cli_hide": true,
"cli_prefix": 6208,
"created_at": "2016-10-21 04:37:16",
"e164": "value",
"esc_enabled": true,
"fax_email": "value",
"fax_enabled": true,
"flag": 4,
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 8.33,
"sms_email": "value",
"sms_enabled": true,
"status": 3,
"target_id": 3563,
"target_type": 3,
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
POST
/calltracking/campaigns Creates new Website resource
Parameters
JSON body attributes:
chat_setting_id integer
call_me_back_setting_id integer
call_tracking_setting_id integer
name string
url string
rules array
Example Request
POST /v1.1/voipstudio/calltracking/campaigns HTTP/1.1
Host: l7api.com
{
"chat_setting_id": 888,
"call_me_back_setting_id": 117,
"call_tracking_setting_id": 256,
"name": "abcd",
"url": "abcd",
"rules": "[{Level7\\ChatBundle\\Form\\WebsiteRuleType}]"
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": "value",
"channels": 2946,
"cli_hide": true,
"cli_prefix": 8577,
"created_at": "2019-03-07 07:10:31",
"e164": "value",
"esc_enabled": true,
"fax_email": "value",
"fax_enabled": true,
"flag": 3,
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 3.14,
"sms_email": "value",
"sms_enabled": true,
"status": 0,
"target_id": 7099,
"target_type": 7,
"tel_verified": true,
"uri": "value"
},
"links": {}
}
GET
/contacts Returns collection of Contact resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/contacts HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 7749,
"company": "value",
"created_at": "2016-12-05 04:16:08",
"dialler_source_id": 4331,
"email": "value",
"ext": "value",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_call_at": "2016-12-05 04:06:20",
"last_name": "value",
"mobile": "value",
"mobile_1": "value",
"mobile_2": "value",
"nb_call_attempts": 9964,
"next_call_at": "2016-12-05 04:08:27",
"notes": "value",
"outcome_id": 139,
"rel_user_id": 7057,
"tel": "value",
"tel_1": "value",
"tel_2": "value",
"type": 2,
"user_id": 124
}
],
"total": 59
}
POST
/contacts Creates new Contact resource
Parameters
JSON body attributes:
type string
dialler_source_id integer
outcome_id integer
group_name string
first_name string
last_name string
email string
company string
tel string
tel_1 string
tel_2 string
speed_dial_phone string
speed_dial_phone_1 string
speed_dial_phone_2 string
mobile string
mobile_1 string
mobile_2 string
speed_dial_mobile string
speed_dial_mobile_1 string
speed_dial_mobile_2 string
notes string
labels array
groups array
transfer_list boolean
user_id integer
Example Request
POST /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
{
"type": "abcd",
"dialler_source_id": 723,
"outcome_id": 356,
"group_name": "abcd",
"first_name": "abcd",
"last_name": "abcd",
"email": "email@example.com",
"company": "abcd",
"tel": "abcd",
"tel_1": "abcd",
"tel_2": "abcd",
"speed_dial_phone": "abcd",
"speed_dial_phone_1": "abcd",
"speed_dial_phone_2": "abcd",
"mobile": "abcd",
"mobile_1": "abcd",
"mobile_2": "abcd",
"speed_dial_mobile": "abcd",
"speed_dial_mobile_1": "abcd",
"speed_dial_mobile_2": "abcd",
"notes": "abcd",
"labels": "abcd",
"groups": "abcd",
"transfer_list": true,
"user_id": 639
}
Responses
201 Created
400 Validation error
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 6199,
"company": "value",
"created_at": "2018-10-21 20:41:17",
"dialler_source_id": 5780,
"email": "value",
"ext": "value",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_call_at": "2018-10-21 20:43:52",
"last_name": "value",
"mobile": "value",
"mobile_1": "value",
"mobile_2": "value",
"nb_call_attempts": 5117,
"next_call_at": "2018-10-21 20:37:47",
"notes": "value",
"outcome_id": 2010,
"rel_user_id": 2071,
"tel": "value",
"tel_1": "value",
"tel_2": "value",
"type": 0,
"user_id": 3170
},
"links": {}
}
PATCH
/contacts [BULK] Updates folder of existing Contact resources
Parameters
JSON body attributes:
id integer
group_name string
labels array
Example Request
PATCH /v1.1/voipstudio/contacts HTTP/1.1
Host: l7api.com
[
{
"id": 370,
"group_name": "abcd",
"labels": "abcd"
},
{
"id": 1709,
"group_name": "abcd",
"labels": "abcd"
}
]
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 864,
"company": "value",
"created_at": "2018-01-31 19:13:39",
"dialler_source_id": 9356,
"email": "value",
"ext": "value",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_call_at": "2018-01-31 19:01:33",
"last_name": "value",
"mobile": "value",
"mobile_1": "value",
"mobile_2": "value",
"nb_call_attempts": 6379,
"next_call_at": "2018-01-31 19:08:13",
"notes": "value",
"outcome_id": 1442,
"rel_user_id": 978,
"tel": "value",
"tel_1": "value",
"tel_2": "value",
"type": 0,
"user_id": 3827
},
"links": {}
}
GET
/contacts/{id} Returns Contact resource for given Id
Parameters
Endpoint URL:
{id} integerContact identifier
Example Request
GET /v1.1/voipstudio/contacts/89 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7950,
"company": "value",
"created_at": "2020-08-16 08:34:29",
"dialler_source_id": 4344,
"email": "value",
"ext": "value",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_call_at": "2020-08-16 08:50:58",
"last_name": "value",
"mobile": "value",
"mobile_1": "value",
"mobile_2": "value",
"nb_call_attempts": 7251,
"next_call_at": "2020-08-16 08:47:48",
"notes": "value",
"outcome_id": 5811,
"rel_user_id": 757,
"tel": "value",
"tel_1": "value",
"tel_2": "value",
"type": 3,
"user_id": 8957
},
"links": {}
}
PATCH
/contacts/{id} Updates existing Contact resource
Parameters
Endpoint URL:
{id} integerContact identifier
JSON body attributes:
type string
dialler_source_id integer
outcome_id integer
group_name string
first_name string
last_name string
email string
company string
tel string
tel_1 string
tel_2 string
speed_dial_phone string
speed_dial_phone_1 string
speed_dial_phone_2 string
mobile string
mobile_1 string
mobile_2 string
speed_dial_mobile string
speed_dial_mobile_1 string
speed_dial_mobile_2 string
notes string
labels array
groups array
transfer_list boolean
user_id integer
Example Request
PATCH /v1.1/voipstudio/contacts/56 HTTP/1.1
Host: l7api.com
{
"type": "abcd",
"dialler_source_id": 544,
"outcome_id": 454,
"group_name": "abcd",
"first_name": "abcd",
"last_name": "abcd",
"email": "email@example.com",
"company": "abcd",
"tel": "abcd",
"tel_1": "abcd",
"tel_2": "abcd",
"speed_dial_phone": "abcd",
"speed_dial_phone_1": "abcd",
"speed_dial_phone_2": "abcd",
"mobile": "abcd",
"mobile_1": "abcd",
"mobile_2": "abcd",
"speed_dial_mobile": "abcd",
"speed_dial_mobile_1": "abcd",
"speed_dial_mobile_2": "abcd",
"notes": "abcd",
"labels": "abcd",
"groups": "abcd",
"transfer_list": true,
"user_id": 732
}
Responses
200 Success
400 Validation error
404 Resource not found
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 6611,
"company": "value",
"created_at": "2023-07-01 10:42:38",
"dialler_source_id": 4675,
"email": "value",
"ext": "value",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_call_at": "2023-07-01 10:41:09",
"last_name": "value",
"mobile": "value",
"mobile_1": "value",
"mobile_2": "value",
"nb_call_attempts": 7169,
"next_call_at": "2023-07-01 10:37:52",
"notes": "value",
"outcome_id": 5017,
"rel_user_id": 7944,
"tel": "value",
"tel_1": "value",
"tel_2": "value",
"type": 2,
"user_id": 6699
},
"links": {}
}
DELETE
/contacts/{ids} Deletes existing Contact resources
Parameters
Endpoint URL:
{ids} comma separated list of integersContact identifiers
Example Request
DELETE /v1.1/voipstudio/contacts/47,140,403 HTTP/1.1 Host: l7api.com
Responses
204 Success
202 Accepted for further procesing.
401 Unauthorized
403 Access denied
404 Resource not found
202 Accepted for further procesing.
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 202 OK
GET
/conferences Returns collection of Conference resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/conferences HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 4240,
"ann_join_leave": true,
"confno": 9580,
"confno_pstn": 4476,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
}
],
"total": 59
}
POST
/conferences Creates new Conference resource
Parameters
JSON body attributes:
name string
pin string
pin_pstn string
ann_join_leave boolean
monitor boolean
ddis array
Example Request
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"
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 8468,
"ann_join_leave": true,
"confno": 4237,
"confno_pstn": 4861,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
GET
/conferences/{id} Returns Conference resource for given Id
Parameters
Endpoint URL:
{id} integerConference identifier
Example Request
GET /v1.1/voipstudio/conferences/30 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2256,
"ann_join_leave": true,
"confno": 2928,
"confno_pstn": 4198,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
PATCH
/conferences/{id} Updates existing Conference resource
Parameters
Endpoint URL:
{id} integerConference identifier
JSON body attributes:
name string
pin string
pin_pstn string
ann_join_leave boolean
monitor boolean
ddis array
Example Request
PATCH /v1.1/voipstudio/conferences/92 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"pin": "abcd",
"pin_pstn": "abcd",
"ann_join_leave": true,
"monitor": true,
"ddis": "abcd"
}
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1629,
"ann_join_leave": true,
"confno": 2972,
"confno_pstn": 3440,
"monitor": true,
"name": "value",
"pin": "value",
"pin_pstn": "value"
},
"links": {}
}
DELETE
/conferences/{id} Deletes existing Conference resource
Parameters
Endpoint URL:
{id} integerConference identifier
Example Request
DELETE /v1.1/voipstudio/conferences/23 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/ddis Returns collection of Ddi resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ddis HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 5247,
"cli_hide": true,
"cli_prefix": 9220,
"created_at": "2018-08-21 10:12:51",
"e164": "value",
"esc_enabled": true,
"fax_email": "value",
"fax_enabled": true,
"flag": 0,
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 9.25,
"sms_email": "value",
"sms_enabled": true,
"status": 6,
"target_id": 5084,
"target_type": 2,
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/ddis/calltracking Returns collection of Call Tracking Ddi resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ddis/calltracking HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 6185,
"cli_hide": true,
"cli_prefix": 6789,
"created_at": "2020-02-15 09:19:24",
"e164": "value",
"esc_enabled": true,
"fax_email": "value",
"fax_enabled": true,
"flag": 1,
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 8.33,
"sms_email": "value",
"sms_enabled": true,
"status": 3,
"target_id": 8465,
"target_type": 6,
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/ddis/dictionaries Returns Dictionary for Ddi resource
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ddis/dictionaries HTTP/1.1 Host: l7api.com
Responses
200 Unknown
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 4417,
"cli_hide": true,
"cli_prefix": 4080,
"created_at": "2019-04-07 01:19:47",
"e164": "value",
"esc_enabled": true,
"fax_email": "value",
"fax_enabled": true,
"flag": 5,
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 2.14,
"sms_email": "value",
"sms_enabled": true,
"status": 4,
"target_id": 729,
"target_type": 4,
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/ddis/{e164} Returns Ddi resource for given e164
Parameters
Example Request
GET /v1.1/voipstudio/ddis/{e164} HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"channels": 3602,
"cli_hide": true,
"cli_prefix": 8525,
"created_at": "2018-08-18 20:49:40",
"e164": "value",
"esc_enabled": true,
"fax_email": "value",
"fax_enabled": true,
"flag": 2,
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 6.25,
"sms_email": "value",
"sms_enabled": true,
"status": 1,
"target_id": 542,
"target_type": 5,
"tel_verified": true,
"uri": "value"
}
],
"total": 59
}
GET
/queues Returns collection of Queue resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/queues HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 3452,
"ann_freq": 5987,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 8351,
"final_dst_type": 6,
"hash_to_exit": true,
"hold_ann": true,
"ivr": 2873,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 5942,
"max_wait_time": 7909,
"moh": 5192,
"monitor": 0,
"name": "value",
"number": 869,
"pos_ann": true,
"post_call_ivr_id": 2757,
"retry": 6868,
"ring_strategy": 2,
"ring_time": 85,
"skip_busy": true,
"wait_time_prefix": true,
"wrap_up_panel": true,
"wrap_up_panel_timeout": 8436,
"wrap_up_time": 9606
}
],
"total": 59
}
POST
/queues Creates new Queue resource
Parameters
JSON body attributes:
moh_id integer
ivr_id integer
ddis array
users array
Users that should be logged in to the queue
Users that should be logged in to the queue
name string
number integer
cli_prefix boolean
wait_time_prefix boolean
agent_sounds undefined
caller_sounds undefined
max_wait_time integer
max_callers integer
join_empty boolean
ring_strategy string
ring_time integer
retry integer
wrap_up_time integer
wrap_up_panel boolean
wrap_up_panel_timeout integer
skip_busy boolean
language string
pos_ann boolean
hold_ann boolean
ann_freq integer
final_dst_type string
final_dst_id integer
post_call_ivr_id integer
hash_to_exit boolean
liaf boolean
groups array
monitor string
Example Request
POST /v1.1/voipstudio/queues HTTP/1.1
Host: l7api.com
{
"moh_id": 103,
"ivr_id": 444,
"ddis": "abcd",
"users": [
{
"id": "User ID",
"status": "Bool that indicates that user is logged in by default."
}
],
"name": "abcd",
"number": 633,
"cli_prefix": true,
"wait_time_prefix": true,
"agent_sounds": "abcd",
"caller_sounds": "abcd",
"max_wait_time": 249,
"max_callers": 107,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 886,
"retry": 735,
"wrap_up_time": 551,
"wrap_up_panel": true,
"wrap_up_panel_timeout": 543,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 871,
"final_dst_type": "abcd",
"final_dst_id": 120,
"post_call_ivr_id": 232,
"hash_to_exit": true,
"liaf": true,
"groups": "abcd",
"monitor": "abcd"
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 696,
"ann_freq": 8093,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 5085,
"final_dst_type": 0,
"hash_to_exit": true,
"hold_ann": true,
"ivr": 6307,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 5547,
"max_wait_time": 1653,
"moh": 9327,
"monitor": 2,
"name": "value",
"number": 93,
"pos_ann": true,
"post_call_ivr_id": 9935,
"retry": 9513,
"ring_strategy": 1,
"ring_time": 704,
"skip_busy": true,
"wait_time_prefix": true,
"wrap_up_panel": true,
"wrap_up_panel_timeout": 4337,
"wrap_up_time": 7752
},
"links": {}
}
GET
/queues/{id} Returns Queue resource for given Id
Parameters
Endpoint URL:
{id} integerQueue identifier
Example Request
GET /v1.1/voipstudio/queues/8 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 937,
"ann_freq": 5926,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 9271,
"final_dst_type": 4,
"hash_to_exit": true,
"hold_ann": true,
"ivr": 4872,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 5779,
"max_wait_time": 4334,
"moh": 2045,
"monitor": 1,
"name": "value",
"number": 492,
"pos_ann": true,
"post_call_ivr_id": 4298,
"retry": 8945,
"ring_strategy": 2,
"ring_time": 1859,
"skip_busy": true,
"wait_time_prefix": true,
"wrap_up_panel": true,
"wrap_up_panel_timeout": 3082,
"wrap_up_time": 3528
},
"links": {}
}
GET
/ringgroups Returns collection of RingGroup resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ringgroups HTTP/1.1 Host: l7api.com
Responses
200 This endpoint return Ring Group resource data.
Each record can also contain data of assigned users and numbers.
To return additional data 'include' query parameter should be added to GET request:
```
GET /ringgroups?include=ddis,users
```
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 2414,
"cli_prefix": true,
"final_dst_id": 2953,
"final_dst_type": 6,
"moh_id": 466,
"name": "value",
"number": 3213,
"ring_time": 3195,
"strategy": 2
}
],
"total": 59
}
POST
/ringgroups Creates new RingGroup resource
Parameters
JSON body attributes:
name string
users array
Users that should be assigned to the ring group
Users that should be assigned to the ring group
ddis array
Numbers that should be assigned to the ring group in E164 format
Numbers that should be assigned to the ring group in E164 format
strategy string
final_dst_type string
final_dst_id integer
ring_time integer
cli_prefix boolean
moh_id integer
number integer
Example Request
POST /v1.1/voipstudio/ringgroups HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"users": [
12345,
56789
],
"ddis": [
44206123456,
48500123445
],
"strategy": "abcd",
"final_dst_type": "abcd",
"final_dst_id": 616,
"ring_time": 513,
"cli_prefix": true,
"moh_id": 457,
"number": 407
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 852,
"cli_prefix": true,
"final_dst_id": 2768,
"final_dst_type": 4,
"moh_id": 3818,
"name": "value",
"number": 4516,
"ring_time": 2015,
"strategy": 0
},
"links": {}
}
GET
/ringgroups/dictionaries Returns Dictionary for RingGroup resource
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ringgroups/dictionaries HTTP/1.1 Host: l7api.com
Responses
200 Success
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 5209,
"cli_prefix": true,
"final_dst_id": 2543,
"final_dst_type": 1,
"moh_id": 2088,
"name": "value",
"number": 1916,
"ring_time": 2292,
"strategy": 0
}
],
"total": 59
}
GET
/ringgroups/{id} Returns RingGroup resource for given Id
Parameters
Endpoint URL:
{id} integerRingGroup identifier
Example Request
GET /v1.1/voipstudio/ringgroups/81 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9983,
"cli_prefix": true,
"final_dst_id": 762,
"final_dst_type": 2,
"moh_id": 3791,
"name": "value",
"number": 7144,
"ring_time": 8877,
"strategy": 1
},
"links": {}
}
PATCH
/ringgroups/{id} Updates existing RingGroup resource
Parameters
Endpoint URL:
{id} integerRingGroup identifier
JSON body attributes:
name string
users array
Users that should be assigned to the ring group
Users that should be assigned to the ring group
ddis array
Numbers that should be assigned to the ring group in E164 format
Numbers that should be assigned to the ring group in E164 format
strategy string
final_dst_type string
final_dst_id integer
ring_time integer
cli_prefix boolean
moh_id integer
number integer
Example Request
PATCH /v1.1/voipstudio/ringgroups/19 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"users": [
12345,
56789
],
"ddis": [
44206123456,
48500123445
],
"strategy": "abcd",
"final_dst_type": "abcd",
"final_dst_id": 733,
"ring_time": 589,
"cli_prefix": true,
"moh_id": 860,
"number": 432
}
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4553,
"cli_prefix": true,
"final_dst_id": 2413,
"final_dst_type": 0,
"moh_id": 3107,
"name": "value",
"number": 6750,
"ring_time": 3458,
"strategy": 1
},
"links": {}
}
DELETE
/ringgroups/{id} Deletes existing RingGroup resource
Parameters
Endpoint URL:
{id} integerRingGroup identifier
Example Request
DELETE /v1.1/voipstudio/ringgroups/7 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/pickupgroups Returns collection of PickupGroup resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/pickupgroups HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 8605,
"name": "value",
"users": 7801
}
],
"total": 59
}
GET
/pickupgroups/{id} Returns PickupGroup resource for given Id
Parameters
Endpoint URL:
{id} integerPickupGroup identifier
Example Request
GET /v1.1/voipstudio/pickupgroups/7 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8671,
"name": "value",
"users": 1250
},
"links": {}
}
GET
/routingrules Returns collection of RoutingRule resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/routingrules HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 8484,
"action": "value",
"customer": 8289,
"destination": "value",
"direction": 0,
"final_dst": true,
"pos": 6545,
"source": "value",
"time_interval": "value"
}
],
"total": 59
}
POST
/routingrules Creates new routing rule resource
Parameters
JSON body attributes:
pos integer
source array
Array of sources depending on routing rule direction. E.g user ID, number in E164 format.
Array of sources depending on routing rule direction. E.g user ID, number in E164 format.
destination array
Array of destinations depending on routing rule direction. E.g number pattern ID, group.
Array of destinations depending on routing rule direction. E.g number pattern ID, group.
time_interval array
Array of time interval resources IDs
Array of time interval resources IDs
action string
Action that should be performed while matching rule, e.g. Block, redirect to IVR or user
Action that should be performed while matching rule, e.g. Block, redirect to IVR or user
direction string
Routing rule direction. Cannot be change with PATCH
Routing rule direction. Cannot be change with PATCH
Example Request
POST /v1.1/voipstudio/routingrules HTTP/1.1
Host: l7api.com
{
"pos": 808,
"source": [
"any",
56789
],
"destination": [
"48X",
56789
],
"time_interval": [
1234,
56789
],
"action": [
"U:XXX",
"B"
],
"direction": [
"in",
"out"
]
}
Responses
201 Created
400 Validation error
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 9827,
"action": "value",
"customer": 6596,
"destination": "value",
"direction": 0,
"final_dst": true,
"pos": 2089,
"source": "value",
"time_interval": "value"
},
"links": {}
}
GET
/routingrules/{id} Returns routing rule resource for given ID
Parameters
Endpoint URL:
{id} integerRoutingRule2 identifier
Example Request
GET /v1.1/voipstudio/routingrules/93 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1932,
"action": "value",
"customer": 1036,
"destination": "value",
"direction": 1,
"final_dst": true,
"pos": 3305,
"source": "value",
"time_interval": "value"
},
"links": {}
}
PATCH
/routingrules/{id} Updates existing routing rule resource
Parameters
Endpoint URL:
{id} integerRoutingRule2 identifier
JSON body attributes:
pos integer
source array
Array of sources depending on routing rule direction. E.g user ID, number in E164 format.
Array of sources depending on routing rule direction. E.g user ID, number in E164 format.
destination array
Array of destinations depending on routing rule direction. E.g number pattern ID, group.
Array of destinations depending on routing rule direction. E.g number pattern ID, group.
time_interval array
Array of time interval resources IDs
Array of time interval resources IDs
action string
Action that should be performed while matching rule, e.g. Block, redirect to IVR or user
Action that should be performed while matching rule, e.g. Block, redirect to IVR or user
direction string
Routing rule direction. Cannot be change with PATCH
Routing rule direction. Cannot be change with PATCH
Example Request
PATCH /v1.1/voipstudio/routingrules/47 HTTP/1.1
Host: l7api.com
{
"pos": 548,
"source": [
"any",
56789
],
"destination": [
"48X",
56789
],
"time_interval": [
1234,
56789
],
"action": [
"U:XXX",
"B"
],
"direction": [
"in",
"out"
]
}
Responses
200 Success
400 Validation error
404 Resource not found
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3664,
"action": "value",
"customer": 3906,
"destination": "value",
"direction": 1,
"final_dst": true,
"pos": 1080,
"source": "value",
"time_interval": "value"
},
"links": {}
}
GET
/ivrs Returns collection of Ivr resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/ivrs HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 5315,
"eight": "value",
"eight_sounds": "value",
"ext_dialing": true,
"final_dst_id": 3777,
"final_dst_type": 6,
"five": "value",
"five_sounds": "value",
"four": "value",
"four_sounds": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"nine_sounds": "value",
"number": 9914,
"one": "value",
"one_sounds": "value",
"post_sounds": "value",
"random_choice": true,
"random_dst": "value",
"repeats": 4720,
"ring_time": 868,
"seven": "value",
"seven_sounds": "value",
"six": "value",
"six_sounds": "value",
"sounds": "value",
"star": "value",
"three": "value",
"three_sounds": "value",
"timeout": 2640,
"two": "value",
"two_sounds": "value",
"zero": "value"
}
],
"total": 59
}
POST
/ivrs Creates new Ivr resource
Parameters
JSON body attributes:
name string
ring_time integer
post_sounds array
ddis array
timeout integer
repeats integer
ext_dialing boolean
language string
final_dst_type string
final_dst_id integer
number integer
random_choice boolean
Example Request
POST /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 135,
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 194,
"repeats": 978,
"ext_dialing": true,
"language": "abcd",
"final_dst_type": "abcd",
"final_dst_id": 610,
"number": 658,
"random_choice": true
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 2065,
"eight": "value",
"eight_sounds": "value",
"ext_dialing": true,
"final_dst_id": 7216,
"final_dst_type": 5,
"five": "value",
"five_sounds": "value",
"four": "value",
"four_sounds": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"nine_sounds": "value",
"number": 8326,
"one": "value",
"one_sounds": "value",
"post_sounds": "value",
"random_choice": true,
"random_dst": "value",
"repeats": 8674,
"ring_time": 2285,
"seven": "value",
"seven_sounds": "value",
"six": "value",
"six_sounds": "value",
"sounds": "value",
"star": "value",
"three": "value",
"three_sounds": "value",
"timeout": 5163,
"two": "value",
"two_sounds": "value",
"zero": "value"
},
"links": {}
}
GET
/ivrs/{id} Returns Ivr resource for given Id
Parameters
Endpoint URL:
{id} integerIvr identifier
Example Request
GET /v1.1/voipstudio/ivrs/16 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1586,
"eight": "value",
"eight_sounds": "value",
"ext_dialing": true,
"final_dst_id": 9629,
"final_dst_type": 4,
"five": "value",
"five_sounds": "value",
"four": "value",
"four_sounds": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"nine_sounds": "value",
"number": 9078,
"one": "value",
"one_sounds": "value",
"post_sounds": "value",
"random_choice": true,
"random_dst": "value",
"repeats": 6874,
"ring_time": 1462,
"seven": "value",
"seven_sounds": "value",
"six": "value",
"six_sounds": "value",
"sounds": "value",
"star": "value",
"three": "value",
"three_sounds": "value",
"timeout": 374,
"two": "value",
"two_sounds": "value",
"zero": "value"
},
"links": {}
}
PATCH
/ivrs/{id} Updates existing Ivr resource
Parameters
Endpoint URL:
{id} integerIvr identifier
JSON body attributes:
name string
ring_time integer
post_sounds array
ddis array
timeout integer
repeats integer
ext_dialing boolean
language string
final_dst_type string
final_dst_id integer
number integer
random_choice boolean
Example Request
PATCH /v1.1/voipstudio/ivrs/18 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 833,
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 893,
"repeats": 348,
"ext_dialing": true,
"language": "abcd",
"final_dst_type": "abcd",
"final_dst_id": 215,
"number": 114,
"random_choice": true
}
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4528,
"eight": "value",
"eight_sounds": "value",
"ext_dialing": true,
"final_dst_id": 9050,
"final_dst_type": 0,
"five": "value",
"five_sounds": "value",
"four": "value",
"four_sounds": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"nine_sounds": "value",
"number": 6867,
"one": "value",
"one_sounds": "value",
"post_sounds": "value",
"random_choice": true,
"random_dst": "value",
"repeats": 9922,
"ring_time": 2513,
"seven": "value",
"seven_sounds": "value",
"six": "value",
"six_sounds": "value",
"sounds": "value",
"star": "value",
"three": "value",
"three_sounds": "value",
"timeout": 4270,
"two": "value",
"two_sounds": "value",
"zero": "value"
},
"links": {}
}
DELETE
/ivrs/{id} Deletes existing Ivr resource
Parameters
Endpoint URL:
{id} integerIvr identifier
Example Request
DELETE /v1.1/voipstudio/ivrs/13 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/mohs/{id} Returns Moh resource for given Id
Parameters
Endpoint URL:
{id} integerMoh identifier
Example Request
GET /v1.1/voipstudio/mohs/75 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2685,
"locked": true,
"name": "value"
},
"links": {}
}
GET
/contactlabels Returns collection of ContactLabel resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/contactlabels HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 1728,
"color": "value",
"name": "value"
}
],
"total": 59
}
POST
/contactlabels Creates new ContactLabel resource
Parameters
JSON body attributes:
name string
color string
Example Request
POST /v1.1/voipstudio/contactlabels HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
Responses
201 Created
400 Validation error
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 4151,
"color": "value",
"name": "value"
},
"links": {}
}
GET
/contactlabels/{id} Returns ContactLabel resource for given Id
Parameters
Endpoint URL:
{id} integerContactLabel identifier
Example Request
GET /v1.1/voipstudio/contactlabels/44 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9060,
"color": "value",
"name": "value"
},
"links": {}
}
PATCH
/contactlabels/{id} Updates existing ContactLabel resource
Parameters
Endpoint URL:
{id} integerContactLabel identifier
JSON body attributes:
name string
color string
Example Request
PATCH /v1.1/voipstudio/contactlabels/55 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
Responses
200 Success
400 Validation error
404 Resource not found
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9322,
"color": "value",
"name": "value"
},
"links": {}
}
DELETE
/contactlabels/{id} Deletes existing ContactLabels resources
Parameters
Endpoint URL:
{id} integerContactLabel identifier
Example Request
DELETE /v1.1/voipstudio/contactlabels/52 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/contactgroups Returns collection of Contact group resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/contactgroups HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
GET
/contactoutcomes Returns collection of ContactOutcome resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/contactoutcomes HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 8411,
"_name": "value",
"created_at": "2023-08-02 16:51:47",
"description": "value",
"name": "value"
}
],
"total": 59
}
POST
/contactoutcomes Creates new ContactOutcome resource
Parameters
JSON body attributes:
name string
description string
Example Request
POST /v1.1/voipstudio/contactoutcomes HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"description": "abcd"
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 7096,
"_name": "value",
"created_at": "2018-09-01 11:38:45",
"description": "value",
"name": "value"
},
"links": {}
}
GET
/users Returns collection of User resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/users HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 7590,
"active": true,
"created_at": "2018-07-04 21:20:45",
"customer": 7004,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 1,
"visited_apps": "value"
}
],
"total": 59
}
PATCH
/users [BULK] Updates location and/or teams of existing User resources
Parameters
JSON body attributes:
id integer
location_id integer
groups array
Example Request
PATCH /v1.1/voipstudio/users HTTP/1.1
Host: l7api.com
[
{
"id": 143,
"location_id": 567,
"groups": "abcd"
},
{
"id": 7903,
"location_id": 567,
"groups": "abcd"
}
]
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1582,
"active": true,
"created_at": "2018-02-02 07:08:17",
"customer": 8034,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 0,
"visited_apps": "value"
},
"links": {}
}
GET
/callmeback/buttons/{id} Returns CallMeBackButton resource for given Id
Parameters
Endpoint URL:
{id} integerCallMeBackButton identifier
Example Request
GET /v1.1/voipstudio/callmeback/buttons/97 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
PATCH
/callmeback/buttons/{id} Updates existing CallMeBackButton resource
Parameters
Endpoint URL:
{id} integerCallMeBackButton identifier
Example Request
PATCH /v1.1/voipstudio/callmeback/buttons/26 HTTP/1.1 Host: l7api.com
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
DELETE
/callmeback/buttons/{id} Deletes existing resource
Parameters
Endpoint URL:
{id} integerCallMeBackButton identifier
Example Request
DELETE /v1.1/voipstudio/callmeback/buttons/45 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
401 Unauthorized
403 Access denied
Example Response
HTTP/1.1 204 OK
POST
/callmeback/buttons Creates new CallMeBackButton resource
Parameters
Example Request
POST /v1.1/voipstudio/callmeback/buttons HTTP/1.1 Host: l7api.com
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized