Sippy Software, Inc.

Available since version SoftSwitch 2025 and FreightSwitch 2025.

All applications below support trusted mode, i_customer should be supplied in that mode.

The application has a related extension - Connection Group Members (CgMembers), described below.

Note: Connection groups attached to a trunk are not returned by getConnectionGroupsList() and cannot be updated or deleted by these APIs.

createConnectionGroup()

This application is used to create a connection group.

Required parameters:

• name - a name of connection group. String.

Optional parameters:

• description - String.
• policy - group policy. See getSystemDictionary(trunk_policies). String. Default is 'ordered'.

Returns:

• result - OK - String.
• i_connection_group - Id of the newly created connection group. Integer.

• XMLRPC fault in case of any error.

updateConnectionGroup()

This application is used to update a connection group.

Required parameters:

• i_connection_group - Id of a connection group to update. Integer.

Optional parameters:

• name - a name of connection group. String.
• description - String.
• policy - group policy. See getSystemDictionary(trunk_policies). String.

Returns:

• result - OK - String.
• i_connection_group - Id of the updated connection group. Integer.

• XMLRPC fault in case of any error.

deleteConnectionGroup()

This application is used to remove a connection group.

Required parameters:

• i_connection_group - Id of a connection group to delete. Integer.

Returns:

• result - OK - String.
• i_connection_group - Id of the deleted connection group. Integer.

• XMLRPC fault in case of any error.

getConnectionGroupInfo()

This application is used to get a connection group detail.

Required parameters:

• i_connection_group - Id of a connection group. Integer.

Returns:

• result - OK - String.
• connection_group - Structure with connection group attributes.

• XMLRPC fault in case of any error.

getConnectionGroupsList()

This application is used to list connection groups.

Optional parameters:

• name_pattern - Pattern to filter by name (SQL syntax for the ILIKE operator is used). String.
• include_members_count - When true, each list entry includes members_count. Boolean.

Returns:

• result - OK - String.
• connection_groups - Array of structures with connection group attributes.
• connection_groups.members_count - Present only if include_members_count is true. Integer.

• XMLRPC fault in case of any error.

createCgMember()

This application is used to create a connection group member.

Required parameters:

• i_connection_group - Id of a connection group the member belongs to. Integer.
• i_connection - Id of a vendor connection to add. Integer.

Optional parameters:

• order_no - order no. Default is 'last'. Possible values:
  • # - set order no to #. Integer.
  • first - make the connection the first entry in order. String.
  • last - make the connection the last entry in order. String.

Notes:

• This API is for vendor connections. To manage trunk connections, use createTrunkConnection() / updateTrunkConnection().

Returns:

• result - OK - String.
• i_cg_member - Id of the newly created connection group member. Integer.

• XMLRPC fault in case of any error.

updateCgMember()

This application is used to update a connection group member.

Required parameters:

• i_cg_member - Id of the connection group member to update. Integer.
• order_no - order no. Possible values:
  • # - set order no to #. Integer.
  • first - make the connection the first entry in order. String.
  • last - make the connection the last entry in order. String.
  • up - increase the order no by 1. String.
  • down - decrease the order no by 1. String.

Optional parameters:

• i_connection - Id of a vendor connection. Integer.

Notes:

• This API is for vendor connections. To manage trunk connections, use updateTrunkConnection().

Returns:

• result - OK - String.
• i_cg_member - Id of the updated connection group member. Integer.

• XMLRPC fault in case of any error.

deleteCgMember()

This application is used to remove a connection group member.

Required parameters:

• i_cg_member - Id of the connection group member to delete. Integer.

Returns:

• result - OK - String.
• i_cg_member - Id of the deleted connection group member. Integer.

• XMLRPC fault in case of any error.

getCgMemberInfo()

This application is used to get a connection group member detail.

Required parameters:

• i_cg_member - Id of a connection group member. Integer.

Returns:

• result - OK - String.
• cg_member - Structure with connection group member attributes.

• XMLRPC fault in case of any error.

getCgMembersList()

This application is used to list connection group members.

Required parameters:

• i_connection_group - Id of a connection group. Integer.

Returns:

• result - OK - String.
• cg_members - Array of structures with connection group member attributes.

• XMLRPC fault in case of any error.