Evo Voice

<back to all web services

AgentStateReport

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
All Verbs/reports/agent-state
AgentStateReport Parameters:
NameParameterData TypeRequiredDescription
StartDatequerystringNo
EndDatequerystringNo
TimeZoneIdquerystringNo
ReportRequest Parameters:
NameParameterData TypeRequiredDescription
AccountIdformstringNoThe account ID this report should be run for
EmailAddressToNotifyformstringNoThe email address to notify after the report is run
WebhookUrlformstringNoThe webhook to call after the report is complete with the data from the report
ReportInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
StatusformReportStatusesNo
StatusMessageformstringNo
DateCreatedformstringNo
DateUpdatedformstringNo
DownloadLinkformstringNo
JobIdformstringNo
EmailAddressToNotifyformstringNo
ServerformstringNo
ReportStatuses Enum:
Queued
Running
Completed
Error

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /reports/agent-state HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	startDate: String,
	endDate: String,
	timeZoneId: String,
	accountId: String,
	emailAddressToNotify: String,
	webhookUrl: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	name: String,
	status: Queued,
	statusMessage: String,
	dateCreated: String,
	dateUpdated: String,
	downloadLink: String,
	jobId: String,
	emailAddressToNotify: String,
	server: String
}