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": 3439,
"created_at": "2017-08-08 22:03:11",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 1206,
"user_id": 2280
}
],
"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
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
}
Responses
201 Created
400 Validation error
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 7853,
"created_at": "2016-09-06 06:03:10",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 8685,
"user_id": 5913
},
"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": 348,
"group_name": "abcd",
"labels": "abcd"
},
{
"id": 7813,
"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": 8874,
"created_at": "2018-01-29 23:01:36",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 664,
"user_id": 6950
},
"links": {}
}
GET
/contacts/{id} Returns Contact resource for given Id
Parameters
Endpoint URL:
{id} integerContact identifier
Example Request
GET /v1.1/voipstudio/contacts/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": 7410,
"created_at": "2020-01-31 11:42:27",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 9023,
"user_id": 2462
},
"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
Example Request
PATCH /v1.1/voipstudio/contacts/54 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
}
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": 2564,
"created_at": "2017-09-18 09:09:23",
"first_name": "value",
"global": true,
"group_name": "value",
"internal": true,
"last_name": "value",
"rel_user_id": 8709,
"user_id": 6562
},
"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/74,194,401 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": 4968,
"ann_join_leave": true,
"confno": 7548,
"confno_pstn": 1061,
"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": 3730,
"ann_join_leave": true,
"confno": 1739,
"confno_pstn": 4751,
"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/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": 23,
"ann_join_leave": true,
"confno": 809,
"confno_pstn": 3112,
"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/93 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": 6994,
"ann_join_leave": true,
"confno": 3170,
"confno_pstn": 3084,
"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/93 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": 2764,
"cli_hide": true,
"cli_prefix": 396,
"created_at": "2020-10-11 16:51:13",
"e164": "value",
"fax_email": "value",
"flag": "C",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 5.17,
"sms_enabled": true,
"status": "U",
"target_id": 9303,
"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": 3357,
"cli_hide": true,
"cli_prefix": 543,
"created_at": "2017-03-14 06:17:04",
"e164": "value",
"fax_email": "value",
"flag": "S",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 5.1,
"sms_enabled": true,
"status": "C",
"target_id": 4003,
"target_type": "F",
"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": 8873,
"cli_hide": true,
"cli_prefix": 898,
"created_at": "2016-07-15 20:55:29",
"e164": "value",
"fax_email": "value",
"flag": "P",
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 9.14,
"sms_enabled": true,
"status": "N",
"target_id": 9570,
"target_type": "F",
"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": 1801,
"ann_freq": 9449,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 8402,
"final_dst_type": "H",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 3367,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 5800,
"max_wait_time": 9773,
"moh": 8942,
"name": "value",
"number": 8229,
"pos_ann": true,
"retry": 9154,
"ring_strategy": "A",
"ring_time": 8909,
"skip_busy": true,
"users": 3722,
"wait_time_prefix": true,
"wrap_up_time": 8148
}
],
"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": 654,
"ivr_id": 455,
"ddis": "abcd",
"users": [
{
"id": "User ID",
"status": "Bool that indicates that user is logged in by default."
}
],
"name": "abcd",
"number": 436,
"cli_prefix": true,
"wait_time_prefix": true,
"agent_sounds": "abcd",
"caller_sounds": "abcd",
"max_wait_time": 310,
"max_callers": 416,
"join_empty": true,
"ring_strategy": "abcd",
"ring_time": 356,
"retry": 879,
"wrap_up_time": 315,
"skip_busy": true,
"language": "abcd",
"pos_ann": true,
"hold_ann": true,
"ann_freq": 669,
"final_dst_type": "abcd",
"final_dst_id": 959,
"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": 4998,
"ann_freq": 2386,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 3580,
"final_dst_type": "I",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 2857,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 3228,
"max_wait_time": 7432,
"moh": 377,
"name": "value",
"number": 5448,
"pos_ann": true,
"retry": 6306,
"ring_strategy": "H",
"ring_time": 3232,
"skip_busy": true,
"users": 5635,
"wait_time_prefix": true,
"wrap_up_time": 4131
},
"links": {}
}
GET
/queues/{id} Returns Queue resource for given Id
Parameters
Endpoint URL:
{id} integerQueue identifier
Example Request
GET /v1.1/voipstudio/queues/28 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": 9,
"ann_freq": 430,
"caller_sounds": "value",
"cli_prefix": true,
"final_dst_id": 757,
"final_dst_type": "I",
"hash_to_exit": true,
"hold_ann": true,
"ivr": 9888,
"join_empty": true,
"language": "value",
"liaf": true,
"max_callers": 2409,
"max_wait_time": 30,
"moh": 6061,
"name": "value",
"number": 347,
"pos_ann": true,
"retry": 6442,
"ring_strategy": "M",
"ring_time": 9582,
"skip_busy": true,
"users": 1369,
"wait_time_prefix": true,
"wrap_up_time": 9028
},
"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": 9418,
"name": "value",
"users": 5550
}
],
"total": 59
}
GET
/pickupgroups/{id} Returns PickupGroup resource for given Id
Parameters
Endpoint URL:
{id} integerPickupGroup identifier
Example Request
GET /v1.1/voipstudio/pickupgroups/91 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": 1649,
"name": "value",
"users": 3220
},
"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": 1049,
"action": "value",
"customer": 7721,
"destination": "value",
"direction": "in",
"pos": 7142,
"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/68 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": 7503,
"action": "value",
"customer": 3705,
"destination": "value",
"direction": "in",
"pos": 3212,
"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/50 HTTP/1.1
Host: l7api.com
{
"direction": "abcd",
"pos": 702,
"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": 2529,
"action": "value",
"customer": 2008,
"destination": "value",
"direction": "out",
"pos": 8160,
"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": 5926,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 4891,
"final_dst_type": "Q",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 4693,
"one": "value",
"post_sounds": "value",
"repeats": 7699,
"ring_time": 8234,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 7749,
"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": 244,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 568,
"repeats": 228,
"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": 888,
"number": 736
}
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": 3706,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 8440,
"final_dst_type": "H",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 6153,
"one": "value",
"post_sounds": "value",
"repeats": 2098,
"ring_time": 4623,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 7769,
"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/83 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": 1674,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 6951,
"final_dst_type": "C",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 4311,
"one": "value",
"post_sounds": "value",
"repeats": 7775,
"ring_time": 4747,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 9252,
"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/48 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"ring_time": 566,
"sounds": "abcd",
"post_sounds": "abcd",
"ddis": "abcd",
"timeout": 949,
"repeats": 632,
"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": 134,
"number": 177
}
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": 2468,
"eight": "value",
"ext_dialing": true,
"final_dst_id": 7426,
"final_dst_type": "U",
"five": "value",
"four": "value",
"hash": "value",
"language": "value",
"name": "value",
"nine": "value",
"number": 8673,
"one": "value",
"post_sounds": "value",
"repeats": 13,
"ring_time": 8002,
"seven": "value",
"six": "value",
"sounds": "value",
"star": "value",
"three": "value",
"timeout": 5332,
"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/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
/mohs/{id} Returns Moh resource for given Id
Parameters
Endpoint URL:
{id} integerMoh identifier
Example Request
GET /v1.1/voipstudio/mohs/33 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": 8375,
"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": 2156,
"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": 168,
"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/47 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": 9508,
"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/81 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": 2655,
"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/68 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