Skip to main content

Api.SendEventAgentLoggedIn

daniel.haynes
  • Updated

SendEventAgentLoggedIn

Identifier
[mandatory]		 String The unique linking identifer to match the agent to a LiveVQ person. Usually this is the username of the agent.
Name
[mandatory *]		 String The display name of the agent. This is only mandatory when using Just In Time Provisioning
Team String May be used in the future to assist with Just In Time Provisioning
BusinessData Json  
CustomData Json  
Source String Can be used to identify the method in the code used to send this message from for debugging code purposes

 

Minimal

Code 

	let agentConfig = window.CCP.agent.getConfiguration();

	CyaraLiveVq.SendEventAgentLoggedIn({
		Identifier: agentConfig.username,
	});

Payload

{
	"type": "cyara-agent-event",
	"what": "loggedin",
	"details": {
		"username": "tobydux"
	},
	"publickey": "942cce9d-63a9-4908-aae5-ce617b1ea785",
	"by": "api",
	"source": "custom"
}

 

Custom

Code

	CyaraLiveVq.SendEventAgentLoggedIn({
		Identifier: agentConfig.username,
		Name: agentConfig.name,
		Team: agentConfig.routingProfile?.name,
		BusinessData: {},
		CustomData: {
			   AwsRoutingProfile: agentConfig.routingProfile?.name
		},
		Source: ''
	});

Payload

{
	"type": "cyara-agent-event",
	"what": "loggedin",
	"details": {
		"username": "tobydux",
		"name": "Toby",
		"team": "Dev",
		"businessdata": {},
		"customdata": {
			"AwsRoutingProfile": "Dev"
		}
	},
	"publickey": "942cce9d-63a9-4908-aae5-ce617b1ea785",
	"by": "api",
	"source": "custom"
}

 

BlackBox

Payload

{
	"type": "cyara-agent-event",
	"what": "agent-loggedin",
	"who": "tobydux",
	"agent": {
		"name": "Toby",
		"username": "tobydux",
		"softphoneEnabled": true,
		"softphoneAutoAccept": false,
		"extension": "",
		"routingProfile": {
		"name": "Dev",
		"routingProfileARN": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/routing-profile/d40ea3d9-030e-4e6d-ac82-0dfb6ec353c0",
		"defaultOutboundQueue": {
			"queueARN": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/queue/8d7fc2e9-cfc5-40d8-aa6b-bf27453cb931",
			"name": "Dev",
			"queueId": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/queue/8d7fc2e9-cfc5-40d8-aa6b-bf27453cb931"
		},
		"channelConcurrencyMap": {
			"VOICE": 1
		},
		"queues": [
			{
			"queueARN": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/queue/agent/fdee871d-51f8-41b2-92e5-bc7e9285e134",
			"name": null,
			"queueId": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/queue/agent/fdee871d-51f8-41b2-92e5-bc7e9285e134"
			},
			{
			"queueARN": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/queue/8d7fc2e9-cfc5-40d8-aa6b-bf27453cb931",
			"name": "Dev",
			"queueId": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/queue/8d7fc2e9-cfc5-40d8-aa6b-bf27453cb931"
			}
		],
		"routingProfileId": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/routing-profile/d40ea3d9-030e-4e6d-ac82-0dfb6ec353c0"
		},
		"agentPreferences": {},
		"dialableCountries": [
		"de",
		"jp",
		"gb",
		"pr",
		"il",
		"us",
		"au",
		"hk",
		"ca",
		"cn",
		"sg",
		"se",
		"mx"
		],
		"permissions": [
		"outboundCall"
		],
		"agentStates": [
		{
			"agentStateARN": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/agent-state/bf541b72-ab3f-4708-ae4e-07808636ab41",
			"type": "routable",
			"name": "Available",
			"startTimestamp": null
		},
		{
			"agentStateARN": "arn:aws:connect:us-east-1:359670509492:instance/227c5107-cee0-4044-9ec1-27e9c9a1bdb0/agent-state/7141256e-7dbe-4953-8c4e-831ed82198cf",
			"type": "offline",
			"name": "Offline",
			"startTimestamp": null
		}
		]
	},
	"by": "hey-cyara",
	"source": "api",
	"publickey": "942cce9d-63a9-4908-aae5-ce617b1ea785"
}

Related articles

Comments

0 comments

Please sign in to leave a comment.