GET api.ashx/v2/conversations/{id}/messages.{json|xml}
LIST all conversation messages for the specified conversation.
Scopes
Conversations › Read Conversation Messages conversations.messages.readonly
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
EndDate | DateTime? | End Date | Optional | |||
Id | string | Id | Required | |||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. If not specified the default is 0. | Optional | |||
PageSize | int? | Specify the number of results to return per page. If not set the default is 20. The max is 100. | Optional | |||
SortOrder | string | Options include Ascending, Descending. Default is Ascending. | Optional | |||
StartDate | DateTime? | Start Date | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/conversations/{id}/messages.json', data: { 'id': 'id' } }).then(function(response) { // use response });
Example Responses
JSON
{ "PageSize": 2, "PageIndex": 0, "TotalCount": 2, "Messages": [ { "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ConversationId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": null, "Body": "body", "CreatedDate": null, "ReplyCount": 6, "Group": null, "AttachedUrl": "attachedurl", "HasReplies": null, "ContentId": "fe65240b-044c-4292-9946-f10e0361ecff", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": null, "Id": "fe65240b-044c-4292-9946-f10e0361ecff" }, "Id": 25 }, "Body": "body", "CreatedDate": "2012-01-04T00:00:00", "ReplyCount": 8, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-05-02T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 4, "Url": "url", "TotalMembers": 7, "HasGroups": true, "GroupCount": 27, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContainerTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 32 }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "CreatedDate": "2012-06-04T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ApplicationTypeId": "fe65240b-044c-4292-9946-f10e0361ecff", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": null } }, "Id": "2d525bad-c4df-470d-a193-a1c6d66e5c3e" }, "Id": 52 }, "CreatedDate": "2011-05-28T00:00:00", "Subject": "subject", "Body": "body", "Url": "url" }, { "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ConversationId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": null, "Body": "body", "CreatedDate": null, "ReplyCount": 19, "Group": null, "AttachedUrl": "attachedurl", "HasReplies": null, "ContentId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": null, "Id": "e3715662-2528-4ba1-84a7-bfcd9d548f80" }, "Id": 112 }, "Body": "body", "CreatedDate": "2011-12-09T00:00:00", "ReplyCount": 61, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-03-29T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 18, "Url": "url", "TotalMembers": 76, "HasGroups": true, "GroupCount": 6, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContainerTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 25 }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContentTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "CreatedDate": "2012-04-19T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ApplicationTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": null } }, "Id": "6cdcf200-3bad-476d-af45-97b52545c337" }, "Id": 8 }, "CreatedDate": "2012-01-16T00:00:00", "Subject": "subject", "Body": "body", "Url": "url" } ], "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Messages PageSize="2" PageIndex="0" TotalCount="2"> <Message> <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id> <ConversationId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ConversationId> <Author> <Id>52</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id> <Author> <Id>25</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id> <Body>body</Body> <CreatedDate /> <ReplyCount>6</ReplyCount> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> </CurrentStatus> </Author> <Body>body</Body> <CreatedDate>2012-01-04T00:00:00</CreatedDate> <ReplyCount>8</ReplyCount> <Group> <Id>32</Id> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated>2012-05-02T00:00:00</DateCreated> <Description>description</Description> <Key>key</Key> <Name>name</Name> <ParentGroupId>4</ParentGroupId> <Url>url</Url> <TotalMembers>7</TotalMembers> <HasGroups>true</HasGroups> <GroupCount>27</GroupCount> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes /> <ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId> <Container> <ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId> <ContainerTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <CreatedByUser> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> </CreatedByUser> <ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId> <ContentTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentTypeId> <CreatedDate>2012-06-04T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationId> <ApplicationTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Application> </Content> </CurrentStatus> </Author> <CreatedDate>2011-05-28T00:00:00</CreatedDate> <Subject>subject</Subject> <Body>body</Body> <Url>url</Url> </Message> <Message> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <ConversationId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ConversationId> <Author> <Id>8</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>6cdcf200-3bad-476d-af45-97b52545c337</Id> <Author> <Id>112</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>e3715662-2528-4ba1-84a7-bfcd9d548f80</Id> <Body>body</Body> <CreatedDate /> <ReplyCount>19</ReplyCount> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> </CurrentStatus> </Author> <Body>body</Body> <CreatedDate>2011-12-09T00:00:00</CreatedDate> <ReplyCount>61</ReplyCount> <Group> <Id>25</Id> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated>2012-03-29T00:00:00</DateCreated> <Description>description</Description> <Key>key</Key> <Name>name</Name> <ParentGroupId>18</ParentGroupId> <Url>url</Url> <TotalMembers>76</TotalMembers> <HasGroups>true</HasGroups> <GroupCount>6</GroupCount> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes /> <ContainerId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerId> <Container> <ContainerId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContainerId> <ContainerTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <CreatedByUser> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> </CreatedByUser> <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId> <ContentTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentTypeId> <CreatedDate>2012-04-19T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ApplicationId> <ApplicationTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Application> </Content> </CurrentStatus> </Author> <CreatedDate>2012-01-16T00:00:00</CreatedDate> <Subject>subject</Subject> <Body>body</Body> <Url>url</Url> </Message> </Messages> </Response>