Logout

Logout
Prev	Actions	Next

Logout

Metreos.Native.CiscoExtensionMobility.Logout

Native
Synchronous
No Custom Parameters

Summary: Logs out a user from a device.
Usage: The Logout action will log a user out of a device, if the user's device profile is currently logged into a device.
Remarks: This action will invoke the Logout Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node.

Action Parameters
Parameter Name	.NET Type	Default	Description
AppId *	`System.String`		The name of a user configured in Cisco Unified Communications Manager that has the necessary permissions to invoke methods on the Extension Mobility service.
AppCertificate *	`System.String`		The password of the user specified by `AppId`.
DeviceName *	`System.String`		The name of the device to log the user out of. This value is typically of the form SEPXXXXXXXXXXXX.
Url	`System.String`		The URL for the Extension Mobility Service. This field should only be specified if the Extension Mobility Service is in a non-default location. This field is also completely ignored if any non-null value is specified as the `CallManagerHost`.
CallManagerHost	`System.String`		The IP address and port of the publisher CallManager IP, in the form '[IP]:[Port]'. Note that the Extension Mobility service is on port 80 by default in 3.x/4.x, and on port 8080 by default in 5.x/6.x.
Version	`Metreos.Native.CiscoExtensionMobility.CcmVersion`	Undefined	The version of Cisco Unified Communications Manager. This version is used in conjuction with `CallManagerHost` to build the URL of the Extension Mobility Service. The possible values are described below: other Specifiy `other` if the Cisco Unified Communications Manager version is anything above `3.3`. v333 Specify `v333` if the Cisco Unified Communications Manager version is `3.3.3`, `3.3.4`, or `3.3.5`. Undefined This is the default value to when nothing is specified for the `Version` field. It is strongly recommended that this value not be used because the behavior is undefined as well.

Result Data
Parameter Name	.NET Type	Description
ErrorCode	`System.Int32`	The Cisco-specific error code if this action fails If 0 is returned on failure, then the action was never able to communicate with CallManager
ErrorMessage	`System.String`	A Cisco-specific error message returned by the Extension Mobility service. If it is null, then the action never communicated with CallManager

Branch Conditions

Success: No description.
Failure: No description.

Prev	Up	Next
Login	Home	QueryDevices