[COMMAND]

Updating Values for a Queue

The provisioning_set_values command can be used to update one or more details about a single queue.

To identify which queue to update, you will need to specify either:

  • Its id.
  • Its external_id and external_id_type (if applicable).

Parameters

table
required		 string

Set this to "ut_operatorQueue".
id
required		 string

The unique ID automatically assigned to the intended queue when it was created.

If you prefer to identify the queue using its third party external_id, this parameter is not needed.
external_id
required		 string

If a third-party has assigned their own ID to the intended queue, you can use it to identify the queue here. For this to work, you will also need to specify the third party using the external_id_type parameter.

If you use this parameter, you do not need to also provide an id.
external_id_type
required		 string

Only needed if you are identifying the queue using its external_id. Specify the organisation that provided that external ID here.
names_and_values
required		 array (string)

An array containing the information you want to update. Each entry in this array should consist of the following paired items:

  • name – a string containing the name of the table field representing the intended setting.

  • value – a string containing a new, appropriate value for the setting.
request_id
optional		 string

If specified, this value will be returned as part of the response event. It can be used to help a calling application associate a request with its response.

Example Request

Copy 
{"command": {"command_type": "provisioning_set_values","table": "ut_operatorQueue", "id":182382, "names_and_values": [ {"name":"ops1groupList", "value":"6140"},{"name":"ops2groupList", "value":""}, {"name":"ops3groupList", "value":"6092"} ]}}

Responses

On Success:

After a successful update, a provisioning_values event is returned containing details of the updated queue.

On Failure:

Failure to update the chosen queue will cause a provisioning_error event, containing an error code as well as a description of what went wrong.