Transfer Chat Session

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Chat/TransferChatSession");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"ChatSessionId\": 123,\n  \"ToAssociate\": \"<string>\"\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({ChatSessionId: 123, ToAssociate: '<string>'})
};

fetch('http://localhost:56350/api/v1/Agents/Chat/TransferChatSession', 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/TransferChatSession",
  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([
    'ChatSessionId' => 123,
    'ToAssociate' => '<string>'
  ]),
  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/TransferChatSession"

payload = {
    "ChatSessionId": 123,
    "ToAssociate": "<string>"
}
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({ChatSessionId: 123, ToAssociate: '<string>'})
};

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

{
  "ChatSessionId": 123,
  "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": {}
  },
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CustomerAlias": "<string>",
  "CustomerHost": "<string>",
  "CustomerName": "<string>",
  "CustomerEmail": "<string>",
  "CustomerPhone": "<string>",
  "CustomerConsented": true,
  "CustomerCompanyName": "<string>",
  "Status": "Invalid",
  "FirstMessage": "<string>",
  "LastMessage": "<string>",
  "WhenRequested": "2023-11-07T05:31:56Z",
  "WhenStarted": "2023-11-07T05:31:56Z",
  "WhenEnded": "2023-11-07T05:31:56Z",
  "WhenIdle": "2023-11-07T05:31:56Z",
  "WhenFetched": "2023-11-07T05:31:56Z",
  "SessionKey": "<string>",
  "InitialQueuePos": 123,
  "AlertLevel": 123,
  "Rank": 123,
  "Flags": "CustomerIsTyping",
  "Contact": {
    "ContactId": 123,
    "Name": "<string>",
    "OrgNr": "<string>",
    "Department": "<string>",
    "URL": "<string>",
    "City": "<string>",
    "DirectPhone": "<string>",
    "AssociateId": 123,
    "CountryId": 123,
    "EmailAddress": "<string>",
    "Kananame": "<string>",
    "EmailAddressName": "<string>",
    "URLName": "<string>",
    "AssociateFullName": "<string>",
    "BusinessName": "<string>",
    "CategoryName": "<string>",
    "CountryName": "<string>",
    "Address": {
      "Wgs84Latitude": 123,
      "Wgs84Longitude": 123,
      "LocalizedAddress": [
        [
          {
            "Name": "<string>",
            "Value": "<string>",
            "Tooltip": "<string>",
            "Label": "<string>",
            "ValueLength": 123,
            "AddressType": "<string>",
            "TableRight": {
              "Mask": "<string>",
              "Reason": "<string>"
            },
            "FieldProperties": {}
          }
        ]
      ],
      "Street": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Postal": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Formatted": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "FormattedAddress": "<string>",
    "FullName": "<string>",
    "IsOwnerContact": true,
    "ActiveErpLinks": 123,
    "Number1": "<string>",
    "Number2": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Project": {
    "ProjectId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "URL": "<string>",
    "Type": "<string>",
    "AssociateId": 123,
    "AssociateFullName": "<string>",
    "TypeId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Status": "<string>",
    "TextId": 123,
    "PublishTo": "2023-11-07T05:31:56Z",
    "PublishFrom": "2023-11-07T05:31:56Z",
    "IsPublished": true,
    "URLName": "<string>",
    "ProjectNumber": "<string>",
    "ActiveErpLinks": 123,
    "EventId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Sale": {
    "ContactName": "<string>",
    "SaleDate": "2023-11-07T05:31:56Z",
    "SaleId": 123,
    "Probability": 123,
    "Title": "<string>",
    "Amount": 123,
    "Currency": "<string>",
    "ProjectName": "<string>",
    "AssociateFullName": "<string>",
    "Description": "<string>",
    "Status": "Unknown",
    "WeightedAmount": 123,
    "ProjectId": 123,
    "EarningPercent": 123,
    "Earning": 123,
    "ContactId": 123,
    "AssociateId": 123,
    "PersonId": 123,
    "SaleTypeId": 123,
    "SaleTypeName": "<string>",
    "PersonFullName": "<string>",
    "Completed": "Unknown",
    "ActiveErpLinks": 123,
    "NextDueDate": "2023-11-07T05:31:56Z",
    "Number": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Ticket": {
    "TicketId": 123,
    "Title": "<string>",
    "CreatedAt": "2023-11-07T05:31:56Z",
    "LastChanged": "2023-11-07T05:31:56Z",
    "ReadByOwner": "2023-11-07T05:31:56Z",
    "ReadByCustomer": "2023-11-07T05:31:56Z",
    "FirstReadByUser": "2023-11-07T05:31:56Z",
    "Activate": "2023-11-07T05:31:56Z",
    "ClosedAt": "2023-11-07T05:31:56Z",
    "RepliedAt": "2023-11-07T05:31:56Z",
    "AlertTimeout": "2023-11-07T05:31:56Z",
    "Deadline": "2023-11-07T05:31:56Z",
    "CreatedBy": 123,
    "CreatedByName": "<string>",
    "Author": "<string>",
    "OwnedBy": 123,
    "OwnedByName": "<string>",
    "Category": 123,
    "CategoryName": "<string>",
    "CategoryFullname": "<string>",
    "Slevel": "Unknown",
    "Priority": 123,
    "PriorityName": "<string>",
    "BaseStatus": "Unknown",
    "TicketStatus": 123,
    "TicketStatusDisplayValue": "<string>",
    "Origin": "Unknown",
    "CustId": 123,
    "PersonFirstname": "<string>",
    "PersonMiddleName": "<string>",
    "PersonLastname": "<string>",
    "PersonFullname": "<string>",
    "AlertLevel": 123,
    "ConnectId": 123,
    "ReadStatus": "Unknown",
    "TimeToReply": 123,
    "RealTimeToReply": 123,
    "TimeToClose": 123,
    "RealTimeToClose": 123,
    "TimeSpentInternally": 123,
    "TimeSpentExternally": 123,
    "TimeSpentQueue": 123,
    "RealTimeSpentInternally": 123,
    "RealTimeSpentExternally": 123,
    "RealTimeSpentQueue": 123,
    "TimeSpent": 123,
    "HasAttachment": true,
    "NumReplies": 123,
    "NumMessages": 123,
    "FromAddress": "<string>",
    "ContactId": 123,
    "ContactName": "<string>",
    "OwnedByAssociateId": 123,
    "Language": "<string>",
    "Sentiment": 123,
    "SentimentConfidence": 123,
    "SaleId": 123,
    "ProjectId": 123,
    "SaleHeading": "<string>",
    "ProjectName": "<string>",
    "FormSubmissionId": 123,
    "TicketTypeId": 123,
    "TicketTypeName": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "TransferTo": {
    "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": {}
  },
  "ChatbotIsActive": true,
  "Rating": 123,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Transfer Chat Session

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Chat/TransferChatSession");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"ChatSessionId\": 123,\n  \"ToAssociate\": \"<string>\"\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({ChatSessionId: 123, ToAssociate: '<string>'})
};

fetch('http://localhost:56350/api/v1/Agents/Chat/TransferChatSession', 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/TransferChatSession",
  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([
    'ChatSessionId' => 123,
    'ToAssociate' => '<string>'
  ]),
  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/TransferChatSession"

payload = {
    "ChatSessionId": 123,
    "ToAssociate": "<string>"
}
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({ChatSessionId: 123, ToAssociate: '<string>'})
};

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

{
  "ChatSessionId": 123,
  "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": {}
  },
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CustomerAlias": "<string>",
  "CustomerHost": "<string>",
  "CustomerName": "<string>",
  "CustomerEmail": "<string>",
  "CustomerPhone": "<string>",
  "CustomerConsented": true,
  "CustomerCompanyName": "<string>",
  "Status": "Invalid",
  "FirstMessage": "<string>",
  "LastMessage": "<string>",
  "WhenRequested": "2023-11-07T05:31:56Z",
  "WhenStarted": "2023-11-07T05:31:56Z",
  "WhenEnded": "2023-11-07T05:31:56Z",
  "WhenIdle": "2023-11-07T05:31:56Z",
  "WhenFetched": "2023-11-07T05:31:56Z",
  "SessionKey": "<string>",
  "InitialQueuePos": 123,
  "AlertLevel": 123,
  "Rank": 123,
  "Flags": "CustomerIsTyping",
  "Contact": {
    "ContactId": 123,
    "Name": "<string>",
    "OrgNr": "<string>",
    "Department": "<string>",
    "URL": "<string>",
    "City": "<string>",
    "DirectPhone": "<string>",
    "AssociateId": 123,
    "CountryId": 123,
    "EmailAddress": "<string>",
    "Kananame": "<string>",
    "EmailAddressName": "<string>",
    "URLName": "<string>",
    "AssociateFullName": "<string>",
    "BusinessName": "<string>",
    "CategoryName": "<string>",
    "CountryName": "<string>",
    "Address": {
      "Wgs84Latitude": 123,
      "Wgs84Longitude": 123,
      "LocalizedAddress": [
        [
          {
            "Name": "<string>",
            "Value": "<string>",
            "Tooltip": "<string>",
            "Label": "<string>",
            "ValueLength": 123,
            "AddressType": "<string>",
            "TableRight": {
              "Mask": "<string>",
              "Reason": "<string>"
            },
            "FieldProperties": {}
          }
        ]
      ],
      "Street": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Postal": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Formatted": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "FormattedAddress": "<string>",
    "FullName": "<string>",
    "IsOwnerContact": true,
    "ActiveErpLinks": 123,
    "Number1": "<string>",
    "Number2": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Project": {
    "ProjectId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "URL": "<string>",
    "Type": "<string>",
    "AssociateId": 123,
    "AssociateFullName": "<string>",
    "TypeId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Status": "<string>",
    "TextId": 123,
    "PublishTo": "2023-11-07T05:31:56Z",
    "PublishFrom": "2023-11-07T05:31:56Z",
    "IsPublished": true,
    "URLName": "<string>",
    "ProjectNumber": "<string>",
    "ActiveErpLinks": 123,
    "EventId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Sale": {
    "ContactName": "<string>",
    "SaleDate": "2023-11-07T05:31:56Z",
    "SaleId": 123,
    "Probability": 123,
    "Title": "<string>",
    "Amount": 123,
    "Currency": "<string>",
    "ProjectName": "<string>",
    "AssociateFullName": "<string>",
    "Description": "<string>",
    "Status": "Unknown",
    "WeightedAmount": 123,
    "ProjectId": 123,
    "EarningPercent": 123,
    "Earning": 123,
    "ContactId": 123,
    "AssociateId": 123,
    "PersonId": 123,
    "SaleTypeId": 123,
    "SaleTypeName": "<string>",
    "PersonFullName": "<string>",
    "Completed": "Unknown",
    "ActiveErpLinks": 123,
    "NextDueDate": "2023-11-07T05:31:56Z",
    "Number": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Ticket": {
    "TicketId": 123,
    "Title": "<string>",
    "CreatedAt": "2023-11-07T05:31:56Z",
    "LastChanged": "2023-11-07T05:31:56Z",
    "ReadByOwner": "2023-11-07T05:31:56Z",
    "ReadByCustomer": "2023-11-07T05:31:56Z",
    "FirstReadByUser": "2023-11-07T05:31:56Z",
    "Activate": "2023-11-07T05:31:56Z",
    "ClosedAt": "2023-11-07T05:31:56Z",
    "RepliedAt": "2023-11-07T05:31:56Z",
    "AlertTimeout": "2023-11-07T05:31:56Z",
    "Deadline": "2023-11-07T05:31:56Z",
    "CreatedBy": 123,
    "CreatedByName": "<string>",
    "Author": "<string>",
    "OwnedBy": 123,
    "OwnedByName": "<string>",
    "Category": 123,
    "CategoryName": "<string>",
    "CategoryFullname": "<string>",
    "Slevel": "Unknown",
    "Priority": 123,
    "PriorityName": "<string>",
    "BaseStatus": "Unknown",
    "TicketStatus": 123,
    "TicketStatusDisplayValue": "<string>",
    "Origin": "Unknown",
    "CustId": 123,
    "PersonFirstname": "<string>",
    "PersonMiddleName": "<string>",
    "PersonLastname": "<string>",
    "PersonFullname": "<string>",
    "AlertLevel": 123,
    "ConnectId": 123,
    "ReadStatus": "Unknown",
    "TimeToReply": 123,
    "RealTimeToReply": 123,
    "TimeToClose": 123,
    "RealTimeToClose": 123,
    "TimeSpentInternally": 123,
    "TimeSpentExternally": 123,
    "TimeSpentQueue": 123,
    "RealTimeSpentInternally": 123,
    "RealTimeSpentExternally": 123,
    "RealTimeSpentQueue": 123,
    "TimeSpent": 123,
    "HasAttachment": true,
    "NumReplies": 123,
    "NumMessages": 123,
    "FromAddress": "<string>",
    "ContactId": 123,
    "ContactName": "<string>",
    "OwnedByAssociateId": 123,
    "Language": "<string>",
    "Sentiment": 123,
    "SentimentConfidence": 123,
    "SaleId": 123,
    "ProjectId": 123,
    "SaleHeading": "<string>",
    "ProjectName": "<string>",
    "FormSubmissionId": 123,
    "TicketTypeId": 123,
    "TicketTypeName": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "TransferTo": {
    "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": {}
  },
  "ChatbotIsActive": true,
  "Rating": 123,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

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

ChatSessionId, ToAssociate

TransferChatSession: Request to send the session to another user. If the session does not belong to the user, nothing happens.

ChatSessionId

integer<int32>

ToAssociate

string

Response

Chat sessions belong to a chat topic, and contain messages to/from users Carrier object for ChatSessionEntity. Services for the ChatSessionEntity Carrier is available from the Chat Agent.

ChatSessionId

integer<int32>

The primary key (auto-incremented)

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

Person

object

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

Show child attributes

CustomerAlias

string

The alias for the customer.

CustomerHost

string

The hostname or IP address for the customer.

CustomerName

string

The name of customer, if provided

CustomerEmail

string

The email address of the customer, if provided

CustomerPhone

string

The phone number of the customer, if provided

CustomerConsented

boolean

The customer consented when starting the session

CustomerCompanyName

string

The name of the customers company, if provided

Status

enum<string>

Enum indicating the status for the session (pending, active, closed, etc).

Available options:

Invalid,

PreChatForm,

Faq,

OfflineForm,

InQueue,

CustomerLast,

UserLast,

Finished,

Deleted,

Closed,

RequestPosted,

ClosedFromQueue

FirstMessage

string

A copy of the first message in the chat session

LastMessage

string

A copy of the last message in the chat session

WhenRequested

string<date-time>

When the session was requested by the customer.

WhenStarted

string<date-time>

When the session was accepted by a user.

WhenEnded

string<date-time>

When the session was ended.

WhenIdle

string<date-time>

The last time anyone sent a message for this session.

WhenFetched

string<date-time>

The last time the customer's client refetched the data. Used to detect 'dead' session.

SessionKey

string

Key used to authenticate the session.

InitialQueuePos

integer<int32>

The initial queue pos (i.e. the number of pending sessions + 1) when the session was requested.

AlertLevel

integer<int32>

The alert level for this chat session.

Rank

integer<int32>

Lowest possible unique number for active sessions for user. User for color index. Starting at 1.

Flags

enum<string>

Various flags for the chat session

Available options:

CustomerIsTyping,

UserIsTyping

Contact

object

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

Show child attributes

Project

object

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

Show child attributes

Sale

object

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

Show child attributes

Ticket

object

The ticket carrier is used for representing a service request. Carrier object for Ticket. Services for the Ticket Carrier is available from the Ticket Agent.

Show child attributes

TransferTo

object

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

Show child attributes

ChatbotIsActive

boolean

Indicates that a chatbot is active on the session. This will cause bot triggers to fire. Set to 0 when bot hands off to user.

Rating

integer<int32>

Rating of this chat conversation given by the customer

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes