Follow Me management

This XMLAPI functions can be used to manage Follow Me feature of an account. All these functions support trusted mode.

getFollowMeOptions()

Parameters:

• i_account - Integer. Required.

Parameters:

• i_account - Integer. Required.

Returns:

• result - OK means that operation was successful. String.
• followme_timeout - Integer.
• i_followme_mode - Integer. Possible values:
  • 1 - Always
  • 2 - On Unavailable
  • 3 - Off
  • 4 - On Busy
  • 5 - On No Answer
• followme_mode_name - Name of Follow Me mode. String.
• XMLRPC fault in case of any error.

setFollowMeOptions()

Parameters:

• i_account - Integer. Required.
• followme_timeout - Integer. Optional.
• i_followme_mode - Integer. Optional. Possible values:
  • 1 - Always
  • 2 - On Unavailable
  • 3 - Off
  • 4 - On Busy
  • 5 - On No Answer

Returns:

• result - OK means that operation was successful. String.
• XMLRPC fault in case of any error.

listFollowMeEntries()

Parameters:

• i_account - Integer. Required.

Returns:

• result - OK means that operation was successful. String.
• followme_entries - Array of Follow Me entries.
• XMLRPC fault in case of any error.

addFollowMeEntry()

Parameters:

• i_account - Integer. Required..
• cld - CLD number to follow. String. Required.
• preference - preference of Follow Me entry. Integer. Optional. Possible values:
  • last (default value)
  • first
  • #
• description - custom description. String. Optional
• timeout - Integer. Optional

Returns:

• result - OK means that operation successful. String.
• i_followme_entry - Integer. Id of added Follow Me entry.
• XMLRPC fault in case of any error.

updateFollowMeEntry()

Parameters:

• i_account - Integer. Required.
• i_followme_entry - Integer. Required.
• cld - CLD number. String. Optional.
• preference - preference of Follow Me entry. String. Optional. Possible values:
  • first
  • last
  • up
  • down
  • #
• description - custom description. String. Optional.
• timeout - Integer. Optional.

Returns:

• result - OK means that operation was successful. String.
• XMLRPC fault in case of any error.

deleteFollowMeEntry()

Parameters:

• i_account - Integer. Required.
• i_followme_entry - Integer. Required.

Returns:

• result - OK means that operation was successful. String.
• XMLRPC fault in case of any error.