Get Function Key Config Items
Retrieves the config items that are used to configure function keys, including users, queues, parking ranges, and function key types.
Request URL
GET {base_url}/uc-cconfig/api/v1/function-key-templates/config-itemsRequest parameters
- Headers
-
Parameter Required Type Description Authorization Yes String The access token used for authentication. Format: Bearer
{access_token}.x-tenant-code Yes String The tenant name. Note: You can obtain tenant name using the Query Tenants interface.
- Query parameters
-
Parameter Required Type Description types Yes String The types of config items to query, separated by commas.
Valid value:
userqueueparkingfunction_key
Response parameters
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The unique ID of the request, which can be used to quickly locate the request. |
| code | String | The HTTP status code of the request.
|
| message | String | The status message of the request. |
| detailMessage | String | The detailed error information. When the request is successful, this parameter returns empty. |
| result | Object<Config_Items_Result> | The config items of function keys. |
- Config_Items_Result
-
Parameter Type Description users Array<Config_Item> The list of user config items. queues Array<Config_Item> The list of queue config items. parkingRange Array<Config_Item> The list of parking range config items. functionKeys Array<Config_Item> The list of available function key types. This parameter is returned only when types contains function_keys.
- Config_Item
-
Parameter Type Description id String The ID of the resource. The value is 0 when the config item has no ID, such as a parking range or a function key type. name String The display name of the config item. value String The value of the config item. The value is the extension number for a user or a queue, and the corresponding value for a parking range or a function key type.
Example
Request example
GET /uc-cconfig/api/v1/function-key-templates/config-items?types=user,queue,parking,function_key HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM2ODE5MiwiaWF0IjoxNzkzMzQ2NTkyLCJqdGkiOiI5MGU4MWZjZi01ODc2LTRmNTgtYjYwYi1jY2NhMzhjZTliYTYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.XlXo7LeQsq2088wJwdAzGjcu8AEJV4E5TxIy0UVQT2i5aYH4287xiVmV-QLHOMBgb2MRf9OIgNdYo-dIIddmqaIYUkgqQ3TeYDfBToMAhjn3TxjcuE6myy3lnsBHrXvy9A4TmSbMe-dQTra186xjTVuwWuf-PiJJ7eHZByCzymN-rG_usOgOSUy1l7pO62YDdsVWrmdEdl7TmDRvxNYa73OKfGimMa5qe9t3-yyf_t-cpqOPGjzB3oCHHBzfagE64rMmgGZV4G7tVCwD67sHxYJSxqYHoL93L-hq3EBr-T4jQL0w4iJmzuI_B75llBFtxgqbW06X5kgCz6qwDYITcQ
x-tenant-code: jintResponse example
HTTP/1.1 200 OK { "requestId": "8a2c0f5e6d3c4b2a9e1d7f5c3b1a9e7d", "code": "200", "message": "SUCCESS", "detailMessage": "", "result": { "users": [ { "id": "338136731335409664", "name": "Leo Ball", "value": "1000" }, { "id": "342552093490561024", "name": "Terrell Smith", "value": "1001" }, { "id": "338855950145581056", "name": "Philip Huff", "value": "1002" }, { "id": "345441128009715712", "name": "Troy Daniel", "value": "1003" }, { "id": "345860923599089664", "name": "Example Lee", "value": "1004" }, { "id": "355531919887114240", "name": "w x", "value": "1005" } ], "queues": [ { "id": "338525424970997760", "name": "6400", "value": "6400" }, { "id": "338525903356534784", "name": "6401", "value": "6401" } ], "parkingRange": [ { "id": "0", "name": "6000", "value": "6000" }, { "id": "0", "name": "6001", "value": "6001" }, { "id": "0", "name": "6002", "value": "6002" }, { "id": "0", "name": "6003", "value": "6003" }, { "id": "0", "name": "6004", "value": "6004" }, { "id": "0", "name": "6005", "value": "6005" }, { "id": "0", "name": "6006", "value": "6006" }, { "id": "0", "name": "6007", "value": "6007" }, { "id": "0", "name": "6008", "value": "6008" }, { "id": "0", "name": "6009", "value": "6009" }, { "id": "0", "name": "6010", "value": "6010" }, { "id": "0", "name": "6011", "value": "6011" }, { "id": "0", "name": "6012", "value": "6012" }, { "id": "0", "name": "6013", "value": "6013" }, { "id": "0", "name": "6014", "value": "6014" }, { "id": "0", "name": "6015", "value": "6015" }, { "id": "0", "name": "6016", "value": "6016" }, { "id": "0", "name": "6017", "value": "6017" }, { "id": "0", "name": "6018", "value": "6018" }, { "id": "0", "name": "6019", "value": "6019" }, { "id": "0", "name": "6020", "value": "6020" }, { "id": "0", "name": "6021", "value": "6021" }, { "id": "0", "name": "6022", "value": "6022" }, { "id": "0", "name": "6023", "value": "6023" }, { "id": "0", "name": "6024", "value": "6024" }, { "id": "0", "name": "6025", "value": "6025" }, { "id": "0", "name": "6026", "value": "6026" }, { "id": "0", "name": "6027", "value": "6027" }, { "id": "0", "name": "6028", "value": "6028" }, { "id": "0", "name": "6029", "value": "6029" }, { "id": "0", "name": "6030", "value": "6030" }, { "id": "0", "name": "6031", "value": "6031" }, { "id": "0", "name": "6032", "value": "6032" }, { "id": "0", "name": "6033", "value": "6033" }, { "id": "0", "name": "6034", "value": "6034" }, { "id": "0", "name": "6035", "value": "6035" }, { "id": "0", "name": "6036", "value": "6036" }, { "id": "0", "name": "6037", "value": "6037" }, { "id": "0", "name": "6038", "value": "6038" }, { "id": "0", "name": "6039", "value": "6039" }, { "id": "0", "name": "6040", "value": "6040" }, { "id": "0", "name": "6041", "value": "6041" }, { "id": "0", "name": "6042", "value": "6042" }, { "id": "0", "name": "6043", "value": "6043" }, { "id": "0", "name": "6044", "value": "6044" }, { "id": "0", "name": "6045", "value": "6045" }, { "id": "0", "name": "6046", "value": "6046" }, { "id": "0", "name": "6047", "value": "6047" }, { "id": "0", "name": "6048", "value": "6048" }, { "id": "0", "name": "6049", "value": "6049" }, { "id": "0", "name": "6050", "value": "6050" }, { "id": "0", "name": "6051", "value": "6051" }, { "id": "0", "name": "6052", "value": "6052" }, { "id": "0", "name": "6053", "value": "6053" }, { "id": "0", "name": "6054", "value": "6054" }, { "id": "0", "name": "6055", "value": "6055" }, { "id": "0", "name": "6056", "value": "6056" }, { "id": "0", "name": "6057", "value": "6057" }, { "id": "0", "name": "6058", "value": "6058" }, { "id": "0", "name": "6059", "value": "6059" }, { "id": "0", "name": "6060", "value": "6060" }, { "id": "0", "name": "6061", "value": "6061" }, { "id": "0", "name": "6062", "value": "6062" }, { "id": "0", "name": "6063", "value": "6063" }, { "id": "0", "name": "6064", "value": "6064" }, { "id": "0", "name": "6065", "value": "6065" }, { "id": "0", "name": "6066", "value": "6066" }, { "id": "0", "name": "6067", "value": "6067" }, { "id": "0", "name": "6068", "value": "6068" }, { "id": "0", "name": "6069", "value": "6069" }, { "id": "0", "name": "6070", "value": "6070" }, { "id": "0", "name": "6071", "value": "6071" }, { "id": "0", "name": "6072", "value": "6072" }, { "id": "0", "name": "6073", "value": "6073" }, { "id": "0", "name": "6074", "value": "6074" }, { "id": "0", "name": "6075", "value": "6075" }, { "id": "0", "name": "6076", "value": "6076" }, { "id": "0", "name": "6077", "value": "6077" }, { "id": "0", "name": "6078", "value": "6078" }, { "id": "0", "name": "6079", "value": "6079" }, { "id": "0", "name": "6080", "value": "6080" }, { "id": "0", "name": "6081", "value": "6081" }, { "id": "0", "name": "6082", "value": "6082" }, { "id": "0", "name": "6083", "value": "6083" }, { "id": "0", "name": "6084", "value": "6084" }, { "id": "0", "name": "6085", "value": "6085" }, { "id": "0", "name": "6086", "value": "6086" }, { "id": "0", "name": "6087", "value": "6087" }, { "id": "0", "name": "6088", "value": "6088" }, { "id": "0", "name": "6089", "value": "6089" }, { "id": "0", "name": "6090", "value": "6090" }, { "id": "0", "name": "6091", "value": "6091" }, { "id": "0", "name": "6092", "value": "6092" }, { "id": "0", "name": "6093", "value": "6093" }, { "id": "0", "name": "6094", "value": "6094" }, { "id": "0", "name": "6095", "value": "6095" }, { "id": "0", "name": "6096", "value": "6096" }, { "id": "0", "name": "6097", "value": "6097" }, { "id": "0", "name": "6098", "value": "6098" }, { "id": "0", "name": "6099", "value": "6099" } ], "functionKeys": [ { "id": "0", "name": "n_a", "value": "n_a" }, { "id": "0", "name": "line", "value": "line" }, { "id": "0", "name": "blf", "value": "blf" }, { "id": "0", "name": "speed_dial", "value": "speed_dial" }, { "id": "0", "name": "check_voicemail", "value": "check_voicemail" }, { "id": "0", "name": "park_retrieve", "value": "park_retrieve" }, { "id": "0", "name": "intercom", "value": "intercom" }, { "id": "0", "name": "dtmf", "value": "dtmf" }, { "id": "0", "name": "agent_login_logout", "value": "agent_login_logout" }, { "id": "0", "name": "agent_pause_unpause", "value": "agent_pause_unpause" }, { "id": "0", "name": "call_forward", "value": "call_forward" }, { "id": "0", "name": "action_url", "value": "action_url" } ] } }
Note:
The response is condensed. The users array contains 6 items, the parkingRange array contains 100 items, and the functionKeys array contains 12 items.