Trendsic Platform Service

<back to all web services

ChatMessageRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET/v1/ChatMessage/{ChatMessageId}
POST,OPTIONS/v1/ChatMessage
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChatMessage:
    chat_message_id: Optional[str] = None
    chat_id: Optional[str] = None
    sender_user_id: Optional[str] = None
    message: Optional[str] = None
    attachment_id: Optional[str] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    sender_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChatMessageResponse:
    response_status: Optional[ResponseStatus] = None
    chat_message: List[ChatMessage] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChatMessageRequest:
    chat_message_id: Optional[str] = None
    chat_message: Optional[ChatMessage] = None

Python ChatMessageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/ChatMessage HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ChatMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChatMessage>
    <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
    <ChatId>00000000-0000-0000-0000-000000000000</ChatId>
    <ChatMessageId>00000000-0000-0000-0000-000000000000</ChatMessageId>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <Message>String</Message>
    <SenderName>String</SenderName>
    <SenderUserId>00000000-0000-0000-0000-000000000000</SenderUserId>
  </ChatMessage>
  <ChatMessageId>00000000-0000-0000-0000-000000000000</ChatMessageId>
</ChatMessageRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ChatMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChatMessage>
    <ChatMessage>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <ChatId>00000000-0000-0000-0000-000000000000</ChatId>
      <ChatMessageId>00000000-0000-0000-0000-000000000000</ChatMessageId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <Message>String</Message>
      <SenderName>String</SenderName>
      <SenderUserId>00000000-0000-0000-0000-000000000000</SenderUserId>
    </ChatMessage>
  </ChatMessage>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ChatMessageResponse>