Settings module
Endpoints for managing PBX settings such us Telephone Numbers configuration, Contacts, Ring Group, IVRs etc.
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": 4552,
"created_at": "2018-07-16 23:20:56",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 9089,
"user_id": 1542
}
],
"total": 59
}
POST
/contacts Creates new Contact resource
Parameters
JSON body attributes:
group_name string
first_name string
last_name string
email string
tel string
speed_dial_phone string
mobile string
speed_dial_mobile string
notes string
labels array
global boolean
user_id integer
Example Request
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,
"user_id": 130
}
Responses
201 Created
400 Validation error
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 8264,
"created_at": "2019-10-09 23:58:22",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 309,
"user_id": 284
},
"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": 135,
"group_name": "abcd",
"labels": "abcd"
},
{
"id": 5216,
"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": 5728,
"created_at": "2020-11-05 04:47:25",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 8717,
"user_id": 8076
},
"links": {}
}
GET
/contacts/{id} Returns Contact resource for given Id
Parameters
Endpoint URL:
{id} integerContact identifier
Example Request
GET /v1.1/voipstudio/contacts/95 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": 3814,
"created_at": "2019-05-22 17:12:38",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 7267,
"user_id": 5917
},
"links": {}
}
PATCH
/contacts/{id} Updates existing Contact resource
Parameters
Endpoint URL:
{id} integerContact identifier
JSON body attributes:
group_name string
first_name string
last_name string
email string
tel string
speed_dial_phone string
mobile string
speed_dial_mobile string
notes string
labels array
global boolean
user_id integer
Example Request
PATCH /v1.1/voipstudio/contacts/11 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,
"user_id": 581
}
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": 4788,
"created_at": "2021-04-02 18:42:55",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 742,
"user_id": 2971
},
"links": {}
}
DELETE
/contacts/{ids} Deletes existing Contacts resources
Parameters
Endpoint URL:
{ids} comma separated list of integersContact identifiers
Example Request
DELETE /v1.1/voipstudio/contacts/81,177,414 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
/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": 4514,
"ann_join_leave": true,
"confno": 8200,
"confno_pstn": 5303,
"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": 6431,
"ann_join_leave": true,
"confno": 3772,
"confno_pstn": 1530,
"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/12 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": 5235,
"ann_join_leave": true,
"confno": 769,
"confno_pstn": 8944,
"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/31 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": 2257,
"ann_join_leave": true,
"confno": 934,
"confno_pstn": 4430,
"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/66 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": 9270,
"cli_hide": true,
"cli_prefix": 4185,
"created_at": "2018-02-02 23:30:03",
"e164": "value",
"fax_email": "value",
"flag": "D",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 5.25,
"sms_enabled": true,
"status": "T",
"target_id": 7005,
"target_type": "U",
"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": 8128,
"cli_hide": true,
"cli_prefix": 5677,
"created_at": "2018-12-03 09:10:44",
"e164": "value",
"fax_email": "value",
"flag": "R",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 6.13,
"sms_enabled": true,
"status": "U",
"target_id": 1668,
"target_type": "I",
"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": 2382,
"cli_hide": true,
"cli_prefix": 3673,
"created_at": "2017-06-30 07:31:54",
"e164": "value",
"fax_email": "value",
"flag": "D",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 6.5,
"sms_enabled": true,
"status": "P",
"target_id": 5376,
"target_type": "U",
"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": 394,
"ann_freq": 190,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 7776,
"final_dst_type": "R",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 9526,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 2059,
"max_wait_time": 6740,
"moh": 1970,
"name": "value",
"number": 8487,
"pos_ann": true,
"retry": 187,
"ring_strategy": "H",
"ring_time": 4512,
"skip_busy": true,
"users": 3399,
"wait_time_prefix": true,
"wrap_up_time": 2621
}
],
"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 string
caller_sounds string
max_wait_time integer
max_callers integer
join_empty boolean
ring_strategy string
ring_time integer
retry integer
wrap_up_time integer
skip_busy boolean
language string
pos_ann boolean
hold_ann boolean
ann_freq integer
final_dst_type string
final_dst_id integer
hash_to_exit boolean
liaf boolean
Example Request
POST /v1.1/voipstudio/queues HTTP/1.1
Host: l7api.com
{
"moh_id": 244,
"ivr_id": 266,
"ddis": "abcd",
"users": [
{
"id": "User ID",
"status": "Bool that indicates that user is logged in by default."
}
],
"name": "abcd",
"number": 255,
"cli_prefix": true,
"wait_time_prefix": true,
"agent_sounds": "abcd",
"caller_sounds": "abcd",
"max_wait_time": 262,
"max_callers": 751,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 755,
"retry": 293,
"wrap_up_time": 965,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 738,
"final_dst_type": "abcd",
"final_dst_id": 624,
"hash_to_exit": true,
"liaf": 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": 971,
"ann_freq": 7300,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 2201,
"final_dst_type": "Q",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 4212,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 9455,
"max_wait_time": 5061,
"moh": 1542,
"name": "value",
"number": 766,
"pos_ann": true,
"retry": 3817,
"ring_strategy": "M",
"ring_time": 7116,
"skip_busy": true,
"users": 4670,
"wait_time_prefix": true,
"wrap_up_time": 2015
},
"links": {}
}
GET
/queues/{id} Returns Queue resource for given Id
Parameters
Endpoint URL:
{id} integerQueue identifier
Example Request
GET /v1.1/voipstudio/queues/43 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": 3272,
"ann_freq": 9320,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 1425,
"final_dst_type": "V",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 2551,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 2891,
"max_wait_time": 9798,
"moh": 3990,
"name": "value",
"number": 88,
"pos_ann": true,
"retry": 4160,
"ring_strategy": "M",
"ring_time": 5633,
"skip_busy": true,
"users": 7636,
"wait_time_prefix": true,
"wrap_up_time": 4058
},
"links": {}
}
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": 5821,
"name": "value",
"users": 1703
}
],
"total": 59
}
GET
/pickupgroups/{id} Returns PickupGroup resource for given Id
Parameters
Endpoint URL:
{id} integerPickupGroup identifier
Example Request
GET /v1.1/voipstudio/pickupgroups/37 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": 8064,
"name": "value",
"users": 6070
},
"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": 8952,
"action": "value",
"customer": 6138,
"destination": "value",
"direction": "in",
"pos": 9717,
"source": "value",
"time_interval": "value"
}
],
"total": 59
}
GET
/routingrules/{id} Returns routing rule resource for given ID
Parameters
Endpoint URL:
{id} integerRoutingRule2 identifier
Example Request
GET /v1.1/voipstudio/routingrules/55 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": 1618,
"action": "value",
"customer": 3802,
"destination": "value",
"direction": "out",
"pos": 8657,
"source": "value",
"time_interval": "value"
},
"links": {}
}
PATCH
/routingrules/{id} Updates existing routing rule resource
Parameters
Endpoint URL:
{id} integerRoutingRule2 identifier
JSON body attributes:
direction string
pos integer
source undefined
destination undefined
time_interval array
action string
Example Request
PATCH /v1.1/voipstudio/routingrules/9 HTTP/1.1
Host: l7api.com
{
"direction": "abcd",
"pos": 793,
"source": "abcd",
"destination": "abcd",
"time_interval": "abcd",
"action": "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": 7332,
"action": "value",
"customer": 2336,
"destination": "value",
"direction": "out",
"pos": 8619,
"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": 7270,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 7002,
"final_dst_type": "Q",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 2361,
"one": "value",
"post_sounds": "value",
"repeats": 8608,
"ring_time": 8862,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 7285,
"two": "value",
"zero": "value"
}
],
"total": 59
}
POST
/ivrs Creates new Ivr resource
Parameters
JSON body attributes:
name string
ring_time integer
sounds array
post_sounds array
ddis array
timeout integer
repeats integer
ext_dialing boolean
language string
one string
two string
three string
four string
five string
six string
seven string
eight string
nine string
zero string
star string
hash string
final_dst_type string
final_dst_id integer
number integer
Example Request
POST /v1.1/voipstudio/ivrs HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 310,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 393,
"repeats": 328,
"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": 731,
"number": 933
}
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": 8350,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 6641,
"final_dst_type": "I",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 3336,
"one": "value",
"post_sounds": "value",
"repeats": 7251,
"ring_time": 4583,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 1457,
"two": "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/58 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": 5782,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 2730,
"final_dst_type": "R",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 70,
"one": "value",
"post_sounds": "value",
"repeats": 2590,
"ring_time": 8810,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 4121,
"two": "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
sounds array
post_sounds array
ddis array
timeout integer
repeats integer
ext_dialing boolean
language string
one string
two string
three string
four string
five string
six string
seven string
eight string
nine string
zero string
star string
hash string
final_dst_type string
final_dst_id integer
number integer
Example Request
PATCH /v1.1/voipstudio/ivrs/94 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 242,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 204,
"repeats": 316,
"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": 537,
"number": 434
}
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": 5854,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 5744,
"final_dst_type": "H",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 3949,
"one": "value",
"post_sounds": "value",
"repeats": 284,
"ring_time": 4996,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 8493,
"two": "value",
"zero": "value"
},
"links": {}
}
DELETE
/ivrs/{id} Deletes existing Ivr resource
Parameters
Endpoint URL:
{id} integerIvr identifier
Example Request
DELETE /v1.1/voipstudio/ivrs/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
/mohs/{id} Returns Moh resource for given Id
Parameters
Endpoint URL:
{id} integerMoh identifier
Example Request
GET /v1.1/voipstudio/mohs/41 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": 5845,
"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": 1903,
"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": 7176,
"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/40 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": 2250,
"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/62 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": 365,
"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/24 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