API Message Guide

US - User Status

Layer Campaign
Direction From CallGem
Type of Service CG
Interface ID CA
Message Purpose This message is sent to indicate user authentication status.
Example US\TDlandlord\ANSYSTEM\RS0\PG65535
Explanation CallGem is responding to a request authenticate the SYSTEM agent detailing successful authentication with all permissions.
Notes This message is sent in response to the User Authenticate [UA] message.
Last Changed 10.0.0.16
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AN AgentIdentifier string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
PG PermissionFlags int true 0 65535 This parameter is a bit flag field describing user permissions. This parameter may have the following values:
1Agent
2Supervisor
4Configuration
8System
256Super User
512Job Control
65535Campaign Admin
RS ResourceStatus int true 0 4 The parameter may have the value 0 or 1 in this context.
0User was authenticated.
1User Authentication failed - user does not exist
2User Authentication failed - bad password
3User Authentication failed - badly-formed parameter(s)
4User Authentication failed - proxy does not have SYSTEM permissions.
TD TenantDescriptor string true 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.