API Message Reference

UA - User Authenticate

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose This message is sent by the control application to CallGem to authenticate as an Agent.
Example UA\TDlandlord\ANSYSTEM\PWSYSTEM
Explanation The SYSTEM agent is authenticating with password SYSTEM as a landlord user.
Notes
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AK AuthKey string false 1 1024 From V10.7.915 - Authenticated session key. Used internally for alternate form of authenticating a socket connection to CallGem.
AN AgentIdentifier string false 1 80 If we are authenticating as an endpoint this parameter may be passed, in which case password is not required.
CK CheckAuthentication boolean false 0 0 This parameter indicates that the originator socket does not wish to change its authentication (and priveleges) but wishes to validate the authenticity of another agent.
LN LicenseToken string false 1 80 This parameter is reserved for Sytel's use
PW Password string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
QI UserIdentifier string false 1 80 From V10.7.128 - Identifies the user that we are authenticating as. User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
TD TenantDescriptor string true 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TK Token string false 1 80 Token parameter

 

Copyright © 2004 - 2019  Sytel Limited