[COMMAND]

Creating an Operator

The provisioning_create command can be used to add a new operator to an existing customer, based on supplied criteria.

Not all operator settings must be specified during this process; afterwards, many settings can be updated using the provisioning_set_values command.

Parameters

table
required		 string Set this to "vcc_operators".
use_template_id
required		 number

Determines the default settings for the new operator, if not otherwise specified.

  • -1 uses the default settings for the customer.
  • 0 uses the system's default settings.
  • Alternatively, if you use the ID of an existing operator, their settings will be applied to the new operator.
title
required		 string The new operator's display name.
web_username
required		 string The user name used by this operator to sign in to the system and the softphone interface.
web_password
required		 string

The password to be used in conjunction with the web user name.

If the operator is not required to sign in, this should be set to a randomised string to prevent unauthorised access.
external_id
required		 string

An ID used by a third-party to identify the data. If used, an external_id_type should also be specified.

If no ID is needed, use an empty string for this value.

external_id_type
required		 string

If an external_id applies to this operation, specify the third party to whom that ID belongs, e.g. "omniconsumerproducts".
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.
phone_number
optional		 string

(Not needed for VoIP operators)

If specified, the new operator will be classified as a phone operator, assigned the specified number. This should be in operator's 'local' phone number format, based on geographic conventions e.g. 212 555 0123 for the United States.

wrap_time
optional		 number

The automatic wrap time duration (in seconds) for the new operator, between 0-9999.

If not specified, the operator will use the system default wrap time.

ring_time
optional		 number

The automatic ring time duration (in seconds) for the new operator, between 1-600.

If not specified, the operator will use the system default ring time.

auto_logout_missed_calls
optional		 number

The number of calls (ranging from 0 to 9999) after which this operator will be automatically logged out of the system. A value of 0 means the operator will not be logged out for missing any number of calls.

If this is not specified, the operator will inherit the system's default value.
uses_voip
optional		 Boolean

Specifies whether the operator will use a TelXL VoIP softphone via the CC4Win client.

Defaults to 0 or empty string.

Example Request

Copy 
{"command":{"command_type":"provisioning_create", "table":"vcc_operators", "use_template_id":-1, "title":"Bobby Jo", "web_username":"bobbyjo", "web_password":"123456", "external_id_type":"a", "external_id":""}}

Responses

On Success:

After successful creation of an operator, a provisioning_values event is returned containing details of that operator.

On Failure:

Failure to complete this command will cause a provisioning_error event, containing a description of what went wrong.