Update Chat Topic User Agents

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("[\n  {\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.PutAsync(request);

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

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      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:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent', 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 => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    [
        '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 => [
    "Authorization: Bearer <token>",
    "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:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent"

payload = [
    {
        "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 = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      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:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent', 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
  }
]

Update Chat Topic User Agents

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("[\n  {\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.PutAsync(request);

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

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      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:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent', 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 => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    [
        '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 => [
    "Authorization: Bearer <token>",
    "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:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent"

payload = [
    {
        "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 = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      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:53294/api/v1/ChatTopic/{chatTopicId}/UserAgent', 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
  }
]

Authorizations

Authorization

string

header

required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization

string

header

required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit

Authorization URL: https://online.superoffice.com/login/common/oauth/authorize

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.

Path Parameters

chatTopicId

integer<int32>

required

Id of the chat topic

Body

Users new/updated roles within the chat topic. Replaces existing roles

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

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