Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel3
typeflat

...

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

1Working with Users in SupportBeeassignUser

Assigns a ticket to a user.

1Working with Users in SupportBeegetUserRetrieves a specified agent of the company.
1Working with Users in SupportBeelistAgentsRetrieves all confirmed agents of the company.

Operation details

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

Anchor
assignUser
assignUser
Assigning a ticket to a user

The assignUser operation assigns a ticket to a user.

Code Block
languagexml
titleassignUser
<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.
  
Anchor
request
request
Sample request

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

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

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

Anchor
getUser
getUser
Retrieving a specified agent of the company

The getUser operation retrieves a specified agent of the company.

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

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

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

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

Anchor
listAgents
listAgents
Retrieves all confirmed agents of the company

The listAgents operation retrieves all confirmed agents of the company.

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

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

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

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

Anchor
sampleconfiguration
sampleconfiguration
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.

Code Block
languagexml
titleSample 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>