TCN API

ListAgentProfileGroups

POST

https://api.cbf.tcn.com/api/v1alpha1/org/users/listagentprofilegroups

UsersService

ListAgentProfileGroups returns the agent profile groups associated with the current organization

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

object {0}

Example

{}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/org/users/listagentprofilegroups' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200OK

application/json

Success

Body

Response message for the ListAgentProfileGroups rpc.

agent_profile_groups

array[object (AgentProfileGroup) {6}]

agent_profile_groups

optional

List of agent profile groups belonging to the org ID.

last_updated

string <date-time>

last_updated

optional

last time agent profile group was updated

Examples:

1s1.000340012s

string

optional

org_id

string

org_id

optional

name

string

name

optional

priority_groups

array[object (PriorityGroup) {2}]

priority_groups

optional

default_group

boolean

default_group

optional

Example

{
  "agent_profile_groups": [
    {
      "last_updated": "1s",
      "id": "string",
      "org_id": "string",
      "name": "string",
      "priority_groups": [
        {
          "channel_type": "CHANNEL_TYPE_EMAIL",
          "threshold": 0
        }
      ],
      "default_group": true
    }
  ]
}

🔴500Server Error

GetAgentProfileGroup

UpdateAgentProfileGroup