Trendsic Platform Service

<back to all web services

ContactCommunicationsByHeaderRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET/v1/Communications/{ConversationHeaderId}
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 ContactCommunication:
    contact_id: int = 0
    contact_name: Optional[str] = None
    agent_id: int = 0
    agent_name: Optional[str] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    message: Optional[str] = None
    message_type: Optional[str] = None
    is_agent_message: bool = False
    sender: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactCommunicationsByHeaderRequest:
    conversation_header_id: Optional[str] = None

Python ContactCommunicationsByHeaderRequest DTOs

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

HTTP + OTHER

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

GET /v1/Communications/{ConversationHeaderId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Communications":[{"ContactId":0,"ContactName":"String","AgentId":0,"AgentName":"String","DateCreated":"0001-01-01T00:00:00.0000000","Message":"String","MessageType":"String","IsAgentMessage":false,"Sender":"String"}]}