This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Working with Users in SupportBee

Owned by Former user (Deleted)
Last updated: Jun 12, 2015
2 min read

Overview

The following operations allow you to work with users. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with users, see Sample configuration. 

OperationDescription

assignUser

Assigns a ticket to a user.

getUserRetrieves a specified agent of the company.
listAgentsRetrieves all confirmed agents of the company.

Operation details

This section provides further details on the operations related to users.

Assigning a ticket to a user

The assignUser operation assigns a ticket to a user.

assignUser
<supportbee.assignUser>
    <ticketId>{$ctx:ticketId}</ticketId>
	<userId>{$ctx:userId}</userId>
</supportbee.assignUser>
Properties
  • ticketId: The ID of the ticket to which the agent is assigned.
  • userId: The ID of the user to whom the ticket would be assigned.
   Sample request

Following is a sample REST/JSON request that can be handled by the assignUser operation.

Sample Request for assignUser 
{
    "apiUrl": "https://globalitanywhere.supportbee.com",
    "authToken": "XsnedoEipoufygveyV6F",
    "ticketId": 5333133,
    "userId": 1629587
}
Related SupportBee documentation

https://developers.supportbee.com/api#ticket_actions

Retrieving a specified agent of the company

The getUser operation retrieves a specified agent of the company.

getUser
<supportbee.getUser>
	<userId>{$ctx:userId}</userId>
</supportbee.getUser>
Properties
  • userId: The ID of the user to retrieve.
Sample request

Following is a sample REST/JSON request that can be handled by the getUser operation.

Sample Request for getUser 
{
    "apiUrl": "https://globalitanywhere.supportbee.com",
    "authToken": "XsnedoEipoufygveyV6F",
    "userId": 1629587
}
Related SupportBee documentation

https://developers.supportbee.com/api#get_user

Retrieves all confirmed agents of the company

The listAgents operation retrieves all confirmed agents of the company.

listAgents
<supportbee.listAgents>
	<withInvited>{$ctx:withInvited}</withInvited>
</supportbee.listAgents>
Properties
  • withInvited: Indicates whether or not to include invited agents.
Sample request

Following is a sample REST/JSON request that can be handled by the listAgents operation.

Sample Request for listAgents 
{
    "apiUrl": "https://globalitanywhere.supportbee.com",
    "authToken": "XsnedoEipoufygveyV6F",
    "withInvited": true
}
Related SupportBee documentation

https://developers.supportbee.com/api#fetching_agents

Sample configuration

Following is a sample proxy service that illustrates how to connect to SupportBee with the init operation and use the assignUser operation. The sample request for this proxy can be found in the assignUser sample request.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy name="supportbee_assignUser" startOnLoad="true" statistics="disable" trace="disable" transports="https,http" xmlns="http://ws.apache.org/ns/synapse">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="apiUrl" expression="json-eval($.apiUrl)"/>
         <property name="authToken" expression="json-eval($.authToken)"/>
         <property name="ticketId" expression="json-eval($.ticketId)"/>
         <property name="userId" expression="json-eval($.userId)"/>
         <supportbee.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <authToken>{$ctx:authToken}</authToken>
         </supportbee.init>
         <supportbee.assignUser>
            <ticketId>{$ctx:ticketId}</ticketId>
            <userId>{$ctx:userId}</userId>
         </supportbee.assignUser>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>