Dixa
    Nothing Found

Teams

Add members

Add agents/admins to a team.

SecurityApiKeyAuth
Request
path Parameters
teamId
required
string <uuid>

The team id

Request Body schema: application/json
required

List of agent/admin ids to add to the specified team

agentIds
Array of strings <uuid>
Responses
200
400

Invalid value for: path parameter teamId, Invalid value extracted from request context, Invalid value for: body

500

Internal failure during request processing

patch/v1/teams/{teamId}/agents
Request samples
application/json
{
  • "agentIds": [
    • "912d5148-6918-4420-b23a-8584b896c8ae",
    • "a8080cf3-9d55-41dd-a8ef-b02414399e7a"
    ]
}
Response samples
application/json
{
  • "message": "Invalid value in request"
}

Create team

Create a team.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The team name

name
required
string
Responses
201

The created team

400

Invalid value extracted from request context, Invalid value for: body

500

Internal failure during request processing

post/v1/teams
Request samples
application/json
{
  • "name": "Team A"
}
Response samples
application/json
{
  • "data": {
    • "id": "005e7108-c85c-41d1-a945-4a8dc58c4399",
    • "name": "Team A"
    }
}

Delete team

Delete a team.

SecurityApiKeyAuth
Request
path Parameters
teamId
required
string <uuid>

The team id

Responses
204

The team was successfully deleted

400

Invalid value for: path parameter teamId, Invalid value extracted from request context

500

Internal failure during request processing

delete/v1/teams/{teamId}
Request samples 
Response samples 
application/json
{
  • "message": "Invalid value in request"
}
Get team
Get a team by id.


SecurityApiKeyAuth 
Request 
path Parameters
teamId
required
string <uuid> 
The team id


 
Responses 
200
The team


400
Invalid value for: path parameter teamId, Invalid value extracted from request context


404
An entity in this request could not be found


get/v1/teams/{teamId}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "005e7108-c85c-41d1-a945-4a8dc58c4399",
    • "name": "Team A"
    }
}
List members
Lists all agents/admins in a team.


SecurityApiKeyAuth 
Request 
path Parameters
teamId
required
string <uuid> 
The team id


 
Responses 
200
List of agents/admins in the specified team


400
Invalid value for: path parameter teamId, Invalid value extracted from request context


500
Internal failure during request processing


get/v1/teams/{teamId}/agents
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "e8333378-62ed-4062-93b5-fadae6f41175",
      • "name": "Agent A",
      • "email": "aa@example.org"
      },
    • {
      • "id": "40735745-9fde-4b6d-8941-e82e4e6d5001",
      • "name": "Agent B",
      • "email": "ab@example.org"
      }
    ]
}
List presence
List the presence status of all agents/admins in a team.


SecurityApiKeyAuth 
Request 
path Parameters
teamId
required
string <uuid> 
The team id


 
query Parameters
pageKey
string
Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.


 
pageLimit
integer <int32> 
Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.


 
Responses 
200
List of agents/admins presence status in the specified team


400
Invalid value for: path parameter teamId, Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey


404
An entity in this request could not be found


500
Internal failure during request processing


get/v1/teams/{teamId}/presence
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "userId": "d53dbec1-e79c-4736-b9a1-15f6dce71ed4",
      • "requestTime": "2021-12-01T12:46:35.935",
      • "lastSeen": "2021-12-01T12:46:35.935",
      • "presenceStatus": "Working",
      • "connectionStatus": "Online",
      • "activeChannels": [
        • "Email",
        • "FacebookMessenger"
        ]
      },
    • {
      • "userId": "e8ecd53b-2f6c-4471-a3a0-34d94caff8c8",
      • "requestTime": "2021-12-01T12:46:35.935",
      • "lastSeen": "2021-12-01T12:46:35.935",
      • "presenceStatus": "Working",
      • "connectionStatus": "Online",
      • "activeChannels": [
        • "Email",
        • "FacebookMessenger"
        ]
      }
    ]
}
List teams
Lists all teams in an organization.


SecurityApiKeyAuth 
Responses 
200
The list of teams in an organization


400
Invalid value extracted from request context


500
Internal failure during request processing


get/v1/teams
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "005e7108-c85c-41d1-a945-4a8dc58c4399",
      • "name": "Team A"
      },
    • {
      • "id": "83cc3c21-9d28-4250-b6ea-b3a6333c5c73",
      • "name": "Team B"
      }
    ]
}
Remove members
Remove agents/admins from a team.


SecurityApiKeyAuth 
Request 
path Parameters
teamId
required
string <uuid> 
The team id


 
Request Body schema: application/json
required
List of agent/admin ids to remove from the specified team


agentIds
Array of strings <uuid> 
 
Responses 
204
The agents/admins were successfully removed from the team


400
Invalid value for: path parameter teamId, Invalid value extracted from request context, Invalid value for: body


500
Internal failure during request processing


delete/v1/teams/{teamId}/agents
Request samples 
application/json
{
  • "agentIds": [
    • "a8080cf3-9d55-41dd-a8ef-b02414399e7a",
    • "d53dbec1-e79c-4736-b9a1-15f6dce71ed4"
    ]
}
Response samples 
application/json
{
  • "message": "Invalid value in request"
}
Why Dixa
Product
Capabilities
Resources
Solutions
Company
Call us now 
© Dixa 2024