1. References
  2. VoxEngine
  3. VoximplantApi
  4. SmartQueueInterface
Rate this page:

SmartQueueInterface

Props

getSQState

Copy URL
getSQState: 
(request: GetSQStateRequest) => Promise<GetSQStateResponse>

Gets the current state of the specified SmartQueue.

getSmartQueueDayHistory

Copy URL
getSmartQueueDayHistory: 
(request: GetSmartQueueDayHistoryRequest) => Promise<GetSmartQueueDayHistoryResponse>

Gets the metrics for the specified SmartQueue for the last 2 days. Refer to the SmartQueue reporting guide to learn more.

getSmartQueueRealtimeMetrics

Copy URL
getSmartQueueRealtimeMetrics: 
(request: GetSmartQueueRealtimeMetricsRequest) => Promise<GetSmartQueueRealtimeMetricsResponse>

Gets the metrics for the specified SmartQueue for the last 30 minutes. Refer to the SmartQueue reporting guide to learn more.

requestSmartQueueHistory

Copy URL
requestSmartQueueHistory: 
(request: RequestSmartQueueHistoryRequest) => Promise<RequestSmartQueueHistoryResponse>

Gets history for the specified SmartQueue. Refer to the SmartQueue reporting guide to learn more.

sQ_AddQueue

Copy URL
sQ_AddQueue: 
(request: SQ_AddQueueRequest) => Promise<SQ_AddQueueResponse>

Adds a new queue.

sQ_AddSkill

Copy URL
sQ_AddSkill: 
(request: SQ_AddSkillRequest) => Promise<SQ_AddSkillResponse>

Adds a new skill to the app.

sQ_BindAgent

Copy URL
sQ_BindAgent: 
(request: SQ_BindAgentRequest) => Promise<SQ_BindAgentResponse>

Binds agents to a queue.

sQ_BindSkill

Copy URL
sQ_BindSkill: 
(request: SQ_BindSkillRequest) => Promise<SQ_BindSkillResponse>

Binds skills to agents.

sQ_DelQueue

Copy URL
sQ_DelQueue: 
(request: SQ_DelQueueRequest) => Promise<SQ_DelQueueResponse>

Deletes a queue.

sQ_DelSkill

Copy URL
sQ_DelSkill: 
(request: SQ_DelSkillRequest) => Promise<SQ_DelSkillResponse>

Deletes a skill and detaches it from agents.

sQ_DeleteAgentCustomStatusMapping

Copy URL
sQ_DeleteAgentCustomStatusMapping: 
(request: SQ_DeleteAgentCustomStatusMappingRequest) => Promise<SQ_DeleteAgentCustomStatusMappingResponse>

Removes a mapping from the mapping table. If there is no such mapping, does nothing.

sQ_GetAgentCustomStatusMapping

Copy URL
sQ_GetAgentCustomStatusMapping: 
(request: SQ_GetAgentCustomStatusMappingRequest) => Promise<SQ_GetAgentCustomStatusMappingResponse>

Returns the mapping list of SQ statuses and custom statuses. SQ statuses are returned whether or not they have mappings to custom statuses.

sQ_GetAgents

Copy URL
sQ_GetAgents: 
(request: SQ_GetAgentsRequest) => Promise<SQ_GetAgentsResponse>

Gets agents.

sQ_GetQueues

Copy URL
sQ_GetQueues: 
(request: SQ_GetQueuesRequest) => Promise<SQ_GetQueuesResponse>

Gets the queue(s).

sQ_GetSkills

Copy URL
sQ_GetSkills: 
(request: SQ_GetSkillsRequest) => Promise<SQ_GetSkillsResponse>

Gets the skill(s).

sQ_SetAgentCustomStatusMapping

Copy URL
sQ_SetAgentCustomStatusMapping: 
(request: SQ_SetAgentCustomStatusMappingRequest) => Promise<SQ_SetAgentCustomStatusMappingResponse>

Adds a status if there is no match for the given internal status and renames it if there is a match. It means that if the passed sq_status_name parameter is not in the mapping table, a new entry is created in there; if it is, the name field in its mapping is replaced with custom_status_name.

sQ_SetAgentInfo

Copy URL
sQ_SetAgentInfo: 
(request: SQ_SetAgentInfoRequest) => Promise<SQ_SetAgentInfoResponse>

Edits the agent settings.

sQ_SetQueueInfo

Copy URL
sQ_SetQueueInfo: 
(request: SQ_SetQueueInfoRequest) => Promise<SQ_SetQueueInfoResponse>

Edits an existing queue.

sQ_SetSkillInfo

Copy URL
sQ_SetSkillInfo: 
(request: SQ_SetSkillInfoRequest) => Promise<SQ_SetSkillInfoResponse>

Edits an existing skill.

sQ_UnbindAgent

Copy URL
sQ_UnbindAgent: 
(request: SQ_UnbindAgentRequest) => Promise<SQ_UnbindAgentResponse>

Unbinds agents from queues.

sQ_UnbindSkill

Copy URL
sQ_UnbindSkill: 
(request: SQ_UnbindSkillRequest) => Promise<SQ_UnbindSkillResponse>

Unbinds skills from agents.