Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Control/ Agent Operation Interfaces: onlineagent/ Resetting Skill Queues
Updated on 2023-09-27 GMT+08:00
View PDF

Resetting Skill Queues

Prerequisites

  • The agent has signed in.

Description

This interface is used to reset skill queues.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

URI

https://ip:port/agentgateway/resource/onlineagent/{agentid}/resetskill/{autoflag}?skillid={skillid}&phonelinkage={phonelinkage}

In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.

Table 1 Parameters in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

2

autoflag

boolean

Yes

Whether to sign in to all skill queues. The options are as follows:

  • true: Automatically sign in to the skill configured for the agent.
  • false: Sign in to a specified skill queue.

Values other than true are processed as false.

3

skillid

string

No

Skill queue ID.

When autoflag is set to false and skillid is left empty, the agent does not sign in to any skill queue. The value of skillid is a skill queue ID string group (for example, 1;2;3) and can contain a maximum of 4000 characters. The skill queue to which the agent logs in is the intersection of the skill queue specified by skillid and the configured skill queue.

4

phonelinkage

int

No

Whether to enable phone linkage (connection and hardphone linkage control). The options are as follows:

  • 1: yes
  • 0: no

Currently, only eSpace 7910 phones on the CC network are supported.

Method Name in Logs

resetSkill

Request Description

  • Message header
    Table 2 Parameters in the request message header

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    Content-Type

    string

    Yes

    Coding mode of the message body. The default value is application/json; charset=UTF-8.

    2

    Guid

    string

    Yes

    GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).
  • Message body

    None

Response Description

Table 3 Parameters in the message body

No.

Parameter

Value Type

Description

1

message

string

Description.

2

retcode

string

Error code. The options are as follows:

0: success

Other values: failure

3

result

object

Reserved field.

Triggered Event

  • None

Error Code

  • 000-002
  • 100-006
  • 100-007

Example

  • Message header 
    Content-Type:application/json; charset=UTF-8
Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter

    None

  • Response parameter 
    {
  "result": {},
  "message": "success",
  "retcode": "0"
}