Add Chat Topic User Agent

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"ChatTopicId\": 123,\n  \"Useragent\": {\n    \"TopicId\": 123,\n    \"User\": {\n      \"AssociateId\": 123,\n      \"Name\": \"<string>\",\n      \"PersonId\": 123,\n      \"Rank\": 123,\n      \"Tooltip\": \"<string>\",\n      \"GroupIdx\": 123,\n      \"FullName\": \"<string>\",\n      \"FormalName\": \"<string>\",\n      \"Deleted\": true,\n      \"EjUserId\": 123,\n      \"UserName\": \"<string>\",\n      \"ExtraFields\": {},\n      \"CustomFields\": {},\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    },\n    \"CanListen\": true,\n    \"CanRespond\": true,\n    \"CanManage\": true,\n    \"CanNotify\": true\n  }\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ChatTopicId: 123,
    Useragent: {
      TopicId: 123,
      User: {
        AssociateId: 123,
        Name: '<string>',
        PersonId: 123,
        Rank: 123,
        Tooltip: '<string>',
        GroupIdx: 123,
        FullName: '<string>',
        FormalName: '<string>',
        Deleted: true,
        EjUserId: 123,
        UserName: '<string>',
        ExtraFields: {},
        CustomFields: {},
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      },
      CanListen: true,
      CanRespond: true,
      CanManage: true,
      CanNotify: true
    }
  })
};

fetch('http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ChatTopicId' => 123,
    'Useragent' => [
        'TopicId' => 123,
        'User' => [
                'AssociateId' => 123,
                'Name' => '<string>',
                'PersonId' => 123,
                'Rank' => 123,
                'Tooltip' => '<string>',
                'GroupIdx' => 123,
                'FullName' => '<string>',
                'FormalName' => '<string>',
                'Deleted' => true,
                'EjUserId' => 123,
                'UserName' => '<string>',
                'ExtraFields' => [
                                
                ],
                'CustomFields' => [
                                
                ],
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ],
        'CanListen' => true,
        'CanRespond' => true,
        'CanManage' => true,
        'CanNotify' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent"

payload = {
    "ChatTopicId": 123,
    "Useragent": {
        "TopicId": 123,
        "User": {
            "AssociateId": 123,
            "Name": "<string>",
            "PersonId": 123,
            "Rank": 123,
            "Tooltip": "<string>",
            "GroupIdx": 123,
            "FullName": "<string>",
            "FormalName": "<string>",
            "Deleted": True,
            "EjUserId": 123,
            "UserName": "<string>",
            "ExtraFields": {},
            "CustomFields": {},
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        },
        "CanListen": True,
        "CanRespond": True,
        "CanManage": True,
        "CanNotify": True
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ChatTopicId: 123,
    Useragent: {
      TopicId: 123,
      User: {
        AssociateId: 123,
        Name: '<string>',
        PersonId: 123,
        Rank: 123,
        Tooltip: '<string>',
        GroupIdx: 123,
        FullName: '<string>',
        FormalName: '<string>',
        Deleted: true,
        EjUserId: 123,
        UserName: '<string>',
        ExtraFields: {},
        CustomFields: {},
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      },
      CanListen: true,
      CanRespond: true,
      CanManage: true,
      CanNotify: true
    }
  })
};

fetch('http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "TopicId": 123,
  "User": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CanListen": true,
  "CanRespond": true,
  "CanManage": true,
  "CanNotify": true
}

Add Chat Topic User Agent

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"ChatTopicId\": 123,\n  \"Useragent\": {\n    \"TopicId\": 123,\n    \"User\": {\n      \"AssociateId\": 123,\n      \"Name\": \"<string>\",\n      \"PersonId\": 123,\n      \"Rank\": 123,\n      \"Tooltip\": \"<string>\",\n      \"GroupIdx\": 123,\n      \"FullName\": \"<string>\",\n      \"FormalName\": \"<string>\",\n      \"Deleted\": true,\n      \"EjUserId\": 123,\n      \"UserName\": \"<string>\",\n      \"ExtraFields\": {},\n      \"CustomFields\": {},\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    },\n    \"CanListen\": true,\n    \"CanRespond\": true,\n    \"CanManage\": true,\n    \"CanNotify\": true\n  }\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ChatTopicId: 123,
    Useragent: {
      TopicId: 123,
      User: {
        AssociateId: 123,
        Name: '<string>',
        PersonId: 123,
        Rank: 123,
        Tooltip: '<string>',
        GroupIdx: 123,
        FullName: '<string>',
        FormalName: '<string>',
        Deleted: true,
        EjUserId: 123,
        UserName: '<string>',
        ExtraFields: {},
        CustomFields: {},
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      },
      CanListen: true,
      CanRespond: true,
      CanManage: true,
      CanNotify: true
    }
  })
};

fetch('http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ChatTopicId' => 123,
    'Useragent' => [
        'TopicId' => 123,
        'User' => [
                'AssociateId' => 123,
                'Name' => '<string>',
                'PersonId' => 123,
                'Rank' => 123,
                'Tooltip' => '<string>',
                'GroupIdx' => 123,
                'FullName' => '<string>',
                'FormalName' => '<string>',
                'Deleted' => true,
                'EjUserId' => 123,
                'UserName' => '<string>',
                'ExtraFields' => [
                                
                ],
                'CustomFields' => [
                                
                ],
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ],
        'CanListen' => true,
        'CanRespond' => true,
        'CanManage' => true,
        'CanNotify' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent"

payload = {
    "ChatTopicId": 123,
    "Useragent": {
        "TopicId": 123,
        "User": {
            "AssociateId": 123,
            "Name": "<string>",
            "PersonId": 123,
            "Rank": 123,
            "Tooltip": "<string>",
            "GroupIdx": 123,
            "FullName": "<string>",
            "FormalName": "<string>",
            "Deleted": True,
            "EjUserId": 123,
            "UserName": "<string>",
            "ExtraFields": {},
            "CustomFields": {},
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        },
        "CanListen": True,
        "CanRespond": True,
        "CanManage": True,
        "CanNotify": True
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ChatTopicId: 123,
    Useragent: {
      TopicId: 123,
      User: {
        AssociateId: 123,
        Name: '<string>',
        PersonId: 123,
        Rank: 123,
        Tooltip: '<string>',
        GroupIdx: 123,
        FullName: '<string>',
        FormalName: '<string>',
        Deleted: true,
        EjUserId: 123,
        UserName: '<string>',
        ExtraFields: {},
        CustomFields: {},
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      },
      CanListen: true,
      CanRespond: true,
      CanManage: true,
      CanNotify: true
    }
  })
};

fetch('http://localhost:56350/api/v1/Agents/Chat/AddChatTopicUserAgent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "TopicId": 123,
  "User": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CanListen": true,
  "CanRespond": true,
  "CanManage": true,
  "CanNotify": true
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

ChatTopicId, Useragent

AddChatTopicUserAgent: Add a user to a chat topic

ChatTopicId

integer<int32>

Useragent

object

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent. Services for the ChatTopicAgent Carrier is available from the Chat Agent.

Show child attributes

Response

TopicId

integer<int32>

The reference to the associated chat topic.

User

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

CanListen

boolean

True of a user can listen in on this topic

CanRespond

boolean

True if the user can respond to chats in this topic

CanManage

boolean

True if the user is a manager for this topic

CanNotify

boolean

True if the user should receive notifications for this topic