4. Lines

VirtualQ.Lines

Check if virtualQ is active for a line

In order to offer virtualQ to callers in a service line, the call center should check if virtualQ is currently active for that line. virtualQ could be active or in-active for several reasons, for example the current expected waiting time, the number of agents present, or if the service is closed. The following method queries virtualQ about the state of the service.

Method Call

    public async Task<Result<bool>> IsVirtualQActive(long lineId)

Response

Value	Description
true	active
false	in-active

API Request

http://docs.virtualq.io/#show-a-line

---

List Lines

This method can be used to query all lines from a given Call Center or Line Group.

Method Call

    public async Task<Result<IEnumerable<LineResult>>> ListLines(ListLinesParameters attributes)

ListLinesParameters

Parameter	Type	Description
CallCenterId	long	(required) Call Center ID
LineGroupId	Nullable<long>	Only list lines within this line group

Response

Value	Description
{ ... }	Array of LineResult objects

LineResult

Only relevant parameters are listed.

Property	Type	Description
Id	Nullable<long>	Line ID
Name	string	Line Name
LineGroupId	Nullable<long>	ID of the LineGroup for this line
ServicePhoneNumber	string	Phone number of service
VirtualqPhoneNumber	string	(Optional) Special phone number for virtualQ

API Request

http://docs.virtualq.io/#list-lines

---

Notify that a call was offered

For accurate computation of waiting times, virtualQ needs to know the total number of calls offered by the call center. virtualQ can compute this value, when it is notified of every call coming into the call center. This is independent of callers actually using virtualQ.

Method Call

    public async Task<Result> NewCallOffered(long lineId)

Parameter	Type	Description
LineId	long	(required) Line ID

API Request

https://docs.virtualq.io/#signal-incoming-call

---