Setting Up and Configuring the WebSocket API

The following process describes the steps required for a partner organisation to enable the TelXL WebSocket API on behalf of a customer. Any phases that have already been completed should be skipped.

Enabling a partner organisation to access the admin portal and complete most other phases of this process.

  1. As a partner, you need access to the admin portal. If this has not already been granted, you will need to contact TelXL's Business Development team to request access.
  2. As part of the provisioning phase, partners are assigned one or more administrator accounts, which can be used to log in and complete the rest of this process.

Creating the customer organisation and granting their users access to the admin portal and API.

  1. Log into the portal.
  2. Create a customer organisation. This step includes creating an initial service for the customer.
  3. Enable the Websocket API option under the customer's settings page, and assign it an appropriate Price List for that customer.
  4. Create one or more website users to allow members of the customer organisation to access the portal.
  5. Create another website user to act as a proxy for WebSocket API interactions. Management of this user, including the password expiry policy, should be accounted for when recognising the impact on the API itself.

Configuring aspects of the customer's account that may need to be consumed by the API.

This phase may be completed by the customer instead, using the website user accounts provided to them.

  1. Add any further services required by the customer, allocating additional numbers where needed.
  2. Configure any IVRs—including paths and operator queues—for relevant services.
  3. Create an initial operator. This will initially only be used to create a configuration in the next phase, but you can set it up as a 'template' operator as described in phase 6, if needed.

Creating the configuration that will allow an API session to be initialised.

  1. Provision the required number of API User licenses and CC4Web licenses.

    Any type of configuration licence can also be used to operate a WebSocket API session, if needed. As long as you have a customer has a free configuration licence, you they can use that with the API. API licences are cheaper, however, so consideration should be given to ensuring the correct type of licence is available whenever possible.

  2. Create a new CC4Web configuration based on MASTER CC4Web WebSocket Config v1.0.
  3. Launch the duplicate configuration using the operator created in phase 3.

    4. When viewing the list of available configurations:

    1. If you don't want the configuration to appear in a new window, un-tick the first check box.
    2. Use the first drop-down to select the name of an operator to simulate when you launch the configuration.
    3. Locate the configuration you want to access, and click its Launch button.

    Always remember to save any intended changes before exiting this mode.

  4. Click Enter Design Mode.
  5. Locate the Queue Stack View widget and click its Properties button.
  6. Ensure the General tab for the widget is selected, and under the Scope option, select General Scopes > Everything for the Current Customer.
  7. Click Save Changes.
  8. Repeat steps 6 and 7 for the Recent/Current Calls and Operator Management List widgets.
  9. Return to the configuration.

Establishing the actual connection to the API.

  1. Configure the third-party application to connect to the customer instance using a session_start command that includes the config_id associated with the configuration created in phase 4, and the user name and password of the proxy user created in phase 2.
  2. Establish and test your connection to the API by referencing the endpoint ws://WebSocket.call-view.com/api/v1/cc4web/socket.
  3. Once a WebSocket session has been opened, test the connection using either the session_start or the session_test command.

    See also: API Reference: Sessions

Creating additional resources, with or without use of the API.

  1. Create any additional operators required. This can be done using either the admin portal or the WebSocket API.

    Regardless of how you intend to create these operators, it is often quickest to create a small set of 'template' operators with common settings (e.g. outbound call privileges, group memberships, tariffs, VoIP status, CLIs, company details), then create more by duplicating these originals.

    If you plan to create duplicate operators using the API, make sure you note down the IDs of the template operators, which can be found in the customer's operator list.