HostedSuite

ListCallRecordsRequest

Retrieves call records for the specified client and date range

The following routes are available for this service:
POST	/api/calls

**ListCallRecordsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
StartDate	body	string	No	The start of the date range to list forms for
EndDate	body	string	No	The end of the date range to list forms for
ClientId	body	string	No	The ID of the client whose call records you want to list
CenterId	body	string	No	The ID of the center whose call records you want to list
CallRecordId	body	string	No	The ID of the call record you wish to retrieve
MinCallDuration	body	double	No	The minimum duration of the call in seconds (talk time only)
MaxCallDuration	body	double	No	The maximum duration of the call in seconds (talk time only)
CallType	body	ReceptionCallTypesApi?	No	Filter by call type (do not specify or use null to include both incoming and outgoing)

**PagedRequestBase<TITemType>** Parameters:
Name	Parameter	Data Type	Required
Page	form	int	No
ItemsPerPage	form	int	No
DisableStats	form	bool	No
SortField	form	string	No
SortDir	form	SortDir	No

**RequestBase<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerName	form	string	Yes	The HostedSuite Customer Name
UserName	form	string	Yes	The HostedSuite User Name. Data visibility and security is based on this user's permissions.
Password	form	string	Yes	The HostedSuite User's Password

**SortDir** Enum:
Asc
Desc

**CallRecordInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
ClientId	form	string	No
ClientName	form	string	No
CenterId	form	string	No
StartTime	form	string	No
CallerName	form	string	No
CallerNumber	form	string	No
TransferToName	form	string	No
TransferToNumber	form	string	No
Notes	form	string	No
DurationInSeconds	form	double	No
RingTimeInSeconds	form	double	No
HoldTimeInSeconds	form	double	No
HoldCount	form	int	No
Interactions	form	IList<CallRecordInteractionInfo>	No
AnsweredBy	form	string	No
Server	form	string	No
TalkTimeInSeconds	form	double	No
TransferTimeInSeconds	form	double	No
ScreenPop	form	string	No
CompletedFormIds	form	IList<string>	No
Flagged	form	bool	No
FlagNotes	form	string	No
Type	form	string	No
WorkTimeInSeconds	form	double	No

**CallRecordInteractionInfo** Parameters:
Name	Parameter	Data Type	Required
StartTime	form	string	No
Type	form	string	No
Description	form	string	No

**ReceptionCallTypesApi** Enum:
Incoming
Outgoing

**PagedResponseBase<TItemType>** Parameters:
Name	Parameter	Data Type	Required
Items	form	List<TItemType>	No
Page	form	int	No
TotalCount	form	long	No
TotalPages	form	int	No

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 /api/calls HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	StartDate: String,
	EndDate: String,
	ClientId: String,
	CenterId: String,
	CallRecordId: String,
	MinCallDuration: 0,
	MaxCallDuration: 0,
	CallType: Incoming,
	Page: 0,
	ItemsPerPage: 0,
	DisableStats: False,
	SortField: String,
	SortDir: Asc,
	CustomerName: String,
	UserName: String,
	Password: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Items: 
	[
		{
			Id: String,
			ClientId: String,
			ClientName: String,
			CenterId: String,
			StartTime: String,
			CallerName: String,
			CallerNumber: String,
			TransferToName: String,
			TransferToNumber: String,
			Notes: String,
			DurationInSeconds: 0,
			RingTimeInSeconds: 0,
			HoldTimeInSeconds: 0,
			HoldCount: 0,
			AnsweredBy: String,
			Server: String,
			TalkTimeInSeconds: 0,
			TransferTimeInSeconds: 0,
			ScreenPop: String,
			Flagged: False,
			FlagNotes: String,
			Type: String,
			WorkTimeInSeconds: 0
		}
	],
	Page: 0,
	TotalCount: 0,
	TotalPages: 0
}