Native
Synchronous
No Custom Parameters
Logs a user into a device with a device profile.
The Login action will log a user into a device using a device profile. The device profile can either already be associated with the user account, in which case the DeviceProfile action parameter need not be specified, or the action can explicitly specify a device profile that is not associated with the user.
This action will invoke the Login Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node.
| 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. | |
| UserId * | System.String | The user to log in the specified device. | |
| DeviceName * | System.String | The name of the device, of the form SEPXXXXXXXXXXXX | |
| DeviceProfile | System.String | The name of the profile to apply to the device. If not specified, then the UserId specified must already have a device profile associated with that account. | |
| Timeout | System.Int32 | The amount of time in minutes to lease this device for. Once the amount of minutes has elapsed, the Extension Mobility service will log the user and accompanying device profile out of the device. | |
| NoTimeout | System.Boolean | False | NoTimeout determines if Timeout should be respected. This field must be not be set to true if Timeout is specified. If this field is true, then the Extension Mobility service will not automatically log the user and accompanying device profile out of the device. |
| 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 a CallManager node with the Extension Mobility service running, 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:
|
| 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
No description.
No description.