Get Started
Usage API
More information

GET api/2.0/project/message/{messageid} This function requires authentication

Description

Returns the detailed information about a discussion message with the ID specified in the request.

Parameters
Name Description Type Example
messageid
sent in url
Message ID number 1234
Example
GET api/2.0/project/message/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Message

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": 10,
    "Title": "Sample Title",
    "Description": "Sample description",
    "ProjectOwner": {
      "Id": "123",
      "Title": "Sample project",
      "Status": 0,
      "IsPrivate": false
    },
    "Status": 0,
    "Text": "Hello, this is sample message",
    "Responsible": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "ResponsibleId": "00000000-0000-0000-0000-000000000000",
    "UpdatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "UpdatedById": "00000000-0000-0000-0000-000000000000",
    "Created": "2020-12-22T04:11:56.5658524Z",
    "CreatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "CreatedById": "00000000-0000-0000-0000-000000000000",
    "Updated": "2020-12-22T04:11:56.5658524Z",
    "CanEditFiles": true,
    "CanReadFiles": true,
    "Subscribers": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "UserName": "Mike.Zanyatski",
        "IsVisitor": false,
        "FirstName": "Mike",
        "LastName": "Zanyatski",
        "Email": "my@domain.com",
        "Birthday": "2008-04-10T06-30-00.000Z",
        "Sex": "male",
        "Status": 1,
        "ActivationStatus": 0,
        "Terminated": "2008-04-10T06-30-00.000Z",
        "Department": "Marketing",
        "WorkFrom": "2008-04-10T06-30-00.000Z",
        "Location": "Palo Alto",
        "Notes": "Notes to worker",
        "DisplayName": "Mike Zanyatski",
        "MobilePhone": "MobilePhone",
        "MobilePhoneActivationStatus": "1",
        "Title": "Manager",
        "Contacts": {
          "Type": "GTalk",
          "Value": "my@gmail.com"
        },
        "Groups": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Group Name",
          "Manager": "Jake.Zazhitski"
        },
        "AvatarMedium": "url to medium avatar",
        "Avatar": "url to big avatar",
        "IsAdmin": false,
        "IsLDAP": false,
        "ListAdminModules": [
          "projects",
          "crm"
        ],
        "IsOwner": false,
        "CultureName": "en-EN",
        "IsSSO": false,
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      }
    ],
    "Files": [
      {
        "RootFolderType": 2,
        "UpdatedBy": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "DisplayName": "Mike Zanyatski",
          "Title": "Manager",
          "AvatarSmall": "url to small avatar",
          "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
        },
        "Created": "2020-12-13T17:13:31.5902727Z",
        "CreatedBy": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "DisplayName": "Mike Zanyatski",
          "Title": "Manager",
          "AvatarSmall": "url to small avatar",
          "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
        },
        "Updated": "2020-12-13T17:13:31.5902727Z",
        "ProviderItem": true,
        "ProviderKey": "1234d",
        "ProviderId": 1234,
        "FolderId": 12334,
        "Version": 3,
        "VersionGroup": 1,
        "ContentLength": "12.06 KB",
        "PureContentLength": 12345,
        "FileStatus": 2,
        "ViewUrl": "http:\\/\\/www.onlyoffice.com\\/viewfile?fileid=2221",
        "WebUrl": "http:\\/\\/www.onlyoffice.com\\/viewfile?fileid=2221",
        "FileType": 7,
        "FileExst": ".txt",
        "Comment": null,
        "Encrypted": true,
        "Id": 857864274,
        "Title": "Some titile.txt",
        "Access": 1,
        "Shared": false
      }
    ],
    "Comments": [
      {
        "commentID": "12261949-db62-43c2-b956-91e12c412d5a",
        "userID": "15985c13-ad91-4f2c-9286-cf991448e796",
        "userPost": null,
        "userFullName": "Administrator",
        "userProfileLink": "\\/Products\\/People\\/Profile.aspx?user=administrator",
        "userAvatarPath": "\\/skins\\/default\\/images\\/default_user_photo_size_82-82.png",
        "commentBody": "das\\u000a",
        "inactive": false,
        "isRead": true,
        "isEditPermissions": true,
        "isResponsePermissions": true,
        "timeStampStr": "15:39 Today",
        "commentList": null,
        "attachments": null
      }
    ],
    "Project": {
      "Id": 10,
      "Title": "Sample Title",
      "Description": "Sample description",
      "Status": 0,
      "Responsible": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "ResponsibleId": "00000000-0000-0000-0000-000000000000",
      "IsPrivate": false,
      "TaskCount": 0,
      "TaskCountTotal": 0,
      "MilestoneCount": 0,
      "DiscussionCount": 0,
      "ParticipantCount": 0,
      "TimeTrackingTotal": "TimeTrackingTotal",
      "DocumentsCount": 0,
      "IsFollow": 0,
      "Tags": [
        "Tags1",
        "Tags2"
      ],
      "UpdatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "UpdatedById": "00000000-0000-0000-0000-000000000000",
      "Created": "2020-12-22T04:11:56.5658524Z",
      "CreatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "CreatedById": "00000000-0000-0000-0000-000000000000",
      "Updated": "2020-12-22T04:11:56.5658524Z",
      "CanEdit": false,
      "CanDelete": false,
      "Security": {
        "CanCreateMilestone": false,
        "CanCreateMessage": false,
        "CanCreateTask": false,
        "CanCreateTimeSpend": false,
        "CanEditTeam": false,
        "CanReadFiles": false,
        "CanReadMilestones": false,
        "CanReadMessages": false,
        "CanReadTasks": false,
        "CanLinkContact": false,
        "CanReadContacts": false,
        "CanEdit": false,
        "CanDelete": false,
        "IsInTeam": false
      },
      "ProjectFolder": 13234
    },
    "CanCreateComment": false,
    "CanEdit": true,
    "CommentsCount": 5
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>10</Id>
    <Title>Sample Title</Title>
    <Description>Sample description</Description>
    <ProjectOwner>
      <Id>123</Id>
      <Title>Sample project</Title>
      <Status>0</Status>
      <IsPrivate>False</IsPrivate>
    </ProjectOwner>
    <Status>0</Status>
    <Text>Hello, this is sample message</Text>
    <Responsible>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Responsible>
    <ResponsibleId>00000000-0000-0000-0000-000000000000</ResponsibleId>
    <UpdatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </UpdatedBy>
    <UpdatedById>00000000-0000-0000-0000-000000000000</UpdatedById>
    <Created>2020-12-22T04:11:56.5658524Z</Created>
    <CreatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreatedBy>
    <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
    <Updated>2020-12-22T04:11:56.5658524Z</Updated>
    <CanEditFiles>True</CanEditFiles>
    <CanReadFiles>True</CanReadFiles>
    <Subscribers>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <UserName>Mike.Zanyatski</UserName>
      <IsVisitor>False</IsVisitor>
      <FirstName>Mike</FirstName>
      <LastName>Zanyatski</LastName>
      <Email>my@domain.com</Email>
      <Birthday>2008-04-10T06-30-00.000Z</Birthday>
      <Sex>male</Sex>
      <Status>1</Status>
      <ActivationStatus>0</ActivationStatus>
      <Terminated>2008-04-10T06-30-00.000Z</Terminated>
      <Department>Marketing</Department>
      <WorkFrom>2008-04-10T06-30-00.000Z</WorkFrom>
      <Location>Palo Alto</Location>
      <Notes>Notes to worker</Notes>
      <DisplayName>Mike Zanyatski</DisplayName>
      <MobilePhone>MobilePhone</MobilePhone>
      <MobilePhoneActivationStatus>1</MobilePhoneActivationStatus>
      <Title>Manager</Title>
      <Contacts>
        <Type>GTalk</Type>
        <Value>my@gmail.com</Value>
      </Contacts>
      <Groups>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <Name>Group Name</Name>
        <Manager>Jake.Zazhitski</Manager>
      </Groups>
      <AvatarMedium>url to medium avatar</AvatarMedium>
      <Avatar>url to big avatar</Avatar>
      <IsAdmin>False</IsAdmin>
      <IsLDAP>False</IsLDAP>
      <ListAdminModules>projects</ListAdminModules>
      <ListAdminModules>crm</ListAdminModules>
      <IsOwner>False</IsOwner>
      <CultureName>en-EN</CultureName>
      <IsSSO>False</IsSSO>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Subscribers>
    <Files>
      <RootFolderType>2</RootFolderType>
      <UpdatedBy>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </UpdatedBy>
      <Created>2020-12-13T17:13:31.5902727Z</Created>
      <CreatedBy>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </CreatedBy>
      <Updated>2020-12-13T17:13:31.5902727Z</Updated>
      <ProviderItem>True</ProviderItem>
      <ProviderKey>1234d</ProviderKey>
      <ProviderId>1234</ProviderId>
      <FolderId>12334</FolderId>
      <Version>3</Version>
      <VersionGroup>1</VersionGroup>
      <ContentLength>12.06 KB</ContentLength>
      <PureContentLength>12345</PureContentLength>
      <FileStatus>2</FileStatus>
      <ViewUrl>http:\/\/www.onlyoffice.com\/viewfile?fileid=2221</ViewUrl>
      <WebUrl>http:\/\/www.onlyoffice.com\/viewfile?fileid=2221</WebUrl>
      <FileType>7</FileType>
      <FileExst>.txt</FileExst>
      <Comment />
      <Encrypted>True</Encrypted>
      <Id>857864274</Id>
      <Title>Some titile.txt</Title>
      <Access>1</Access>
      <Shared>False</Shared>
    </Files>
    <Comments>
      <commentID>12261949-db62-43c2-b956-91e12c412d5a</commentID>
      <userID>15985c13-ad91-4f2c-9286-cf991448e796</userID>
      <userPost />
      <userFullName>Administrator</userFullName>
      <userProfileLink>\/Products\/People\/Profile.aspx?user=administrator</userProfileLink>
      <userAvatarPath>\/skins\/default\/images\/default_user_photo_size_82-82.png</userAvatarPath>
      <commentBody>das\u000a</commentBody>
      <inactive>False</inactive>
      <isRead>True</isRead>
      <isEditPermissions>True</isEditPermissions>
      <isResponsePermissions>True</isResponsePermissions>
      <timeStampStr>15:39 Today</timeStampStr>
      <commentList />
      <attachments />
    </Comments>
    <Project>
      <Id>10</Id>
      <Title>Sample Title</Title>
      <Description>Sample description</Description>
      <Status>0</Status>
      <Responsible>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </Responsible>
      <ResponsibleId>00000000-0000-0000-0000-000000000000</ResponsibleId>
      <IsPrivate>False</IsPrivate>
      <TaskCount>0</TaskCount>
      <TaskCountTotal>0</TaskCountTotal>
      <MilestoneCount>0</MilestoneCount>
      <DiscussionCount>0</DiscussionCount>
      <ParticipantCount>0</ParticipantCount>
      <TimeTrackingTotal>TimeTrackingTotal</TimeTrackingTotal>
      <DocumentsCount>0</DocumentsCount>
      <IsFollow>0</IsFollow>
      <Tags>Tags1</Tags>
      <Tags>Tags2</Tags>
      <UpdatedBy>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </UpdatedBy>
      <UpdatedById>00000000-0000-0000-0000-000000000000</UpdatedById>
      <Created>2020-12-22T04:11:56.5658524Z</Created>
      <CreatedBy>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </CreatedBy>
      <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
      <Updated>2020-12-22T04:11:56.5658524Z</Updated>
      <CanEdit>False</CanEdit>
      <CanDelete>False</CanDelete>
      <Security>
        <CanCreateMilestone>False</CanCreateMilestone>
        <CanCreateMessage>False</CanCreateMessage>
        <CanCreateTask>False</CanCreateTask>
        <CanCreateTimeSpend>False</CanCreateTimeSpend>
        <CanEditTeam>False</CanEditTeam>
        <CanReadFiles>False</CanReadFiles>
        <CanReadMilestones>False</CanReadMilestones>
        <CanReadMessages>False</CanReadMessages>
        <CanReadTasks>False</CanReadTasks>
        <CanLinkContact>False</CanLinkContact>
        <CanReadContacts>False</CanReadContacts>
        <CanEdit>False</CanEdit>
        <CanDelete>False</CanDelete>
        <IsInTeam>False</IsInTeam>
      </Security>
      <ProjectFolder>13234</ProjectFolder>
    </Project>
    <CanCreateComment>False</CanCreateComment>
    <CanEdit>True</CanEdit>
    <CommentsCount>5</CommentsCount>
  </response>
</result>