All applications bellow support trusted mode, i_customer = 1 should be supplied in that mode.

createVendorConnection()


This application is used to create a vendor connection.


Required parameters:
  • i_vendor - Integer.
  • name - String.
  • destination - String.


Optional parameters:

  • i_media_relay - Integer. See getSystemDictionary(media_relays)
  • username - String.
  • password - String.
  • translation_rule - CLD translation rule. String.
  • cli_translation_rule - String.
  • i_media_relay_type - Integer. See getSystemDictionary(media_relay_types)
  • capacity - Integer.
  • enforce_capacity - Boolean.
  • huntstop_scodes - String.
  • blocked - Boolean.
  • timeout_100 - Integer.
  • i_protocol - Integer. See getSystemDictionary(protocols) (up to version 2020)
  • i_proto_transport - Integer. See getSystemDictionary(proto_transports) (since version 2021)

  • qmon_acd_enabled - Boolean.

  • qmon_asr_enabled - Boolean.

  • qmon_pdd_enabled - Whether PDD monitoring is enabled. Boolean. Default is false. (since version 2021)

  • qmon_stat_window - Integer.

  • qmon_acd_threshold - Integer.

  • qmon_asr_threshold - Double.

  • qmon_pdd_threshold - Threshold for PDD monitoring in seconds. Double. Default is 0.01. (since version 2021)

  • qmon_retry_interval - Integer.

  • qmon_retry_batch - Integer.

  • qmon_action - String. See getSystemDictionary(qmon_actions)

  • qmon_notification_enabled - Boolean.

  • use_asserted_id - Use CLI as Privacy ID. Boolean.

  • asserted_id_translation - Privacy translation rule. String.

  • outbound_ip - Environment's IP address to send outbound traffic from. String.

  • max_cps - Double.

  • ignore_lrn - Boolean.

  • single_outbound_port - Boolean.

  • outbound_proxy - String.

  • accept_redirects - Boolean.

  • redirect_depth_limit - Integer.

  • from_domain - String.

  • enable_diversion - Boolean.
  • diversion_translation - String.
  • i_privacy_mode - Integer. See getSystemDictionary(privacy_modes) - Starting from 5.1
  • random_call_id - Boolean. Starting from 5.2
  • pass_ruri_params - String. Starting from 5.2
  • use_priv_id_as_cli - Use Privacy Id as CLI. Boolean. Optional. Default is False. (since version 2021)
  • trusted_privacy_domain - Controls if Privacy Id is sent to a vendor. Boolean. Optional. Default is True. (since version 2021)


Returns:

  • result - OK - String.
  • i_connection - ID of the newly created vendor connection. Integer.

  • XMLRPC fault in case of any error.

updateVendorConnection()


This application is used to update a vendor connection.


Required parameters:

  • i_connection - Integer. Required.

Optional parameters:
  • Any from createVendorConnection() except i_vendor.

Returns:
  • result - OK - String.
  • XMLRPC fault in case of any error.

deleteVendorConnection()


This application is used to remove a vendor connection.


Required parameters:

  • i_connection - Integer. Required.


Returns:

  • result - OK - String.
  • XMLRPC fault in case of any error.

getVendorConnectionInfo()


This application is used to get a vendor connection detail.


Parameters:
  • i_connection - Id of vendor connection. Integer. Required.


Returns:
  • result - OK - String.
  • vendor_connection - Structure with vendor connection's attributes.
  • XMLRPC fault in case of any error.


getVendorConnectionsList()


This application is used to list vendor connections.


Parameters:
  • i_vendor - Integer. Required.
  • name_pattern - Pattern to filter connections by name (SQL syntax for the LIKE operator is used). String. Optional.

Returns:
  • result - OK - String.
  • vendor_connections - Array of dictionaries.
  • XMLRPC fault in case of any error.