Add a Function Key Template

Adds a function key template.

Request URL

POST {base_url}/uc-cconfig/api/v1/function-key-templates

Request 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.
Body parameters
Parameter Required Type Description
name Yes String The name of the function key template. The value ranges from 1 to 127 characters.
remark No String The remark of the function key template. The maximum length is 1024 characters.
items No Array<Function_Key_Item> The function key list of the template.
Function_Key_Item
Parameter Required Type Description
id No String The ID of the function key.
pos Yes Integer The position of the function key.
type Yes String

The type of the function key.

Valid value:

  • n_a: A placeholder key, which has no actual function.
  • line: An account key, which is valid only for IP phones and is used to select an account or act as a line key.
  • blf: A BLF key, which monitors the extension status of the monitored object. valueType can be set to extension or feature_code.
  • speed_dial: A speed dial key, which quickly dials a specified number.
  • check_voicemail: A voicemail key, which accesses the voicemail menu of the current user or a specified extension.
  • park_retrieve: A park/retrieve key, which parks a call to a parking slot or retrieves a parked call.
  • intercom: An intercom key, which initiates an intercom call to a specified user.
  • dtmf: A DTMF key, which sends DTMF signals to the other party during a call.
  • agent_login_logout: An agent login/logout key, which sets the login or logout status of the user in a specified queue.
  • agent_pause_unpause: An agent pause/unpause key, which sets the pause or resume status of the user in a specified queue.
  • call_forward: A call forward key, which is valid only for IP phones and quickly sets the call forward switch of the phone.
  • action_url: An Action URL key, which is valid only for IP phones and sends an HTTP GET request to a specified URL from the phone.
value No String The parameter value of the function key.
label No String The display label of the function key.
isDefaultLabel No Integer

Whether the label is the default label.

Valid value:

  • 0: The label is generated by the system.
  • 1: The label is customized by the user.
valueType No String

The value type of the BLF key. This parameter is valid only when type is blf.

Valid value:

  • extension
  • feature_code

If not specified, an empty string is used.

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.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
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<Add_Result> The result of the request.
Add_Result
Parameter Type Description
id String The ID of the function key template.

Example

Request example

POST /uc-cconfig/api/v1/function-key-templates 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: jint
Content-Type: application/json
{
  "name": "fk-test-template-1",
  "remark": "Created for doc testing.",
  "items": [
    {
      "pos": 1,
      "type": "blf",
      "value": "1001",
      "label": "1001",
      "isDefaultLabel": 1,
      "valueType": "extension"
    },
    {
      "pos": 2,
      "type": "speed_dial",
      "value": "5500"
    }
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "0f13e3a5545717a4e2f818d98e048663",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "374465332446060544"
  }
}