Implementation Process

Updated on 2024-03-05 GMT+08:00

View PDF

Involved Interfaces

login
Request method: PUT

Request URL: https://ip:port/agentgateway/resource/onlineagent/{agentid}

For details, see Signing In.
forceLogin
Request method: PUT

Request URL: https://ip:port/agentgateway/resource/onlineagent/{agentid}/forcelogin

For details, see Forcibly Signing In.
resetSkill
Request method: POST

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

For details, see Resetting Skill Queues.
getAgentEvent
Request method: GET

Request URL: https://ip:port/agentgateway/resource/agentevent/{agentid}

For details, see Obtaining Events of One Agent in Polling Mode.

Sending an HTTP PUT Request

For details, see the MainTest.java file.

/**
     * Send http's PUT request
     * @param url  the address of the request
     * @param entityParams the paramters of entity 
     * @param headers the field is used to set the header of http request
     * @return
     */
    public Map<string, string> put(string url, Map<string, Object> entityParams, Map<string, string> headers)

Sending an HTTP POST Request

For details, see the MainTest.java file.

/**
     * Send http's POST request
     * @param url the address of the request
     * @param entityParams the paramters of entity
     * @param headers the field is used to set the header of http request
     * @return
     */
     public Map<string, string> post(string url, Map<string, Object> entityParams, Map<string, string> headers)

Sending an HTTP GET Request

For details, see the MainTest.java file.

/**
     * Send http's POST request
     * @param url the address of the request
     * @param entityParams the paramters of entity
     * @param headers the field is used to set the header of http request
     * @return
     */
    public Map<string, string> get(string url, Map<string, Object> entityParams, Map<string, string> headers)

Implementing the login Interface

For details, see the MainTest.java file.

    /**
     * log in
     * @param workNo  the work no of the agent
     * @param password the password of the agent
     * @param phoneNumber the phone number of the agent
     * @return
     */
    public Map<string, string> login(string workNo, string password, string phoneNumber)

Implementing the forceLogin Interface

For details, see the MainTest.java file.

/**
     * When agent has logged in, call the interface to forcibly log in
     * @param workNo  the work no of the agent
     * @param password the password of the agent
     * @param phoneNumber the phone number of the agent
     * @return
     */
    public Map<string, string> forceLogin(string workNo, string password, string phoneNumber)

Implementing the resetSkill Interface

For details, see the MainTest.java file.

/**
     * After log in, reset the skills
     * @param workNo the work no of the agent
     * @param autoFlag Is automatically signed into the skill queue
     * @param skillId the id of the skill. if has more than one skill that need to be sign, it's split by;
     * @param headers the field is used to set the header of http request
     * @return
     */
    public Map<string, string> resetSkill(string workNo, boolean autoFlag, 
            string skillId, Map<string, string> headers)

Implementing the getAgentEvent Interface

For details, see the MainTest.java file.

/**
* Get the agent's event
* @param workNo workNo the work no of the agent
* @param headers the field is used to set the header of http request
* @return
*/
public Map<string, string> getAgentEvent(string workNo, Map<string, string> headers)

Parent topic: Developing Applications for the First Time

Previous topic: Prerequisites

Next topic: Implementation Example