メッセージ一覧を取得する
トピックに投稿されたメッセージ一覧を取得します。
メソッド
GET
URL
https://typetalk.com/api/v1/topics/:topicId
スコープ
topic.read
URL パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
| topicId | 数値 | トピック ID |
クエリパラメーター
| 名前 | 型 | 説明 |
|---|---|---|
| count (任意) | 数値 | デフォルト値: 20、最大値: 200 |
| from (任意) | 数値 | 投稿 ID |
| direction (任意) | 文字列 | “backward” または “forward” |
レスポンスの例
{
"bookmark": {
"postId": 172371,
"updatedAt": "2019-03-11T08:37:40Z"
},
"exceedsAttachmentLimit": false,
"postContentsSettings": {
"collapsedAccountIds": []
},
"myTopic": {
"id": 15376,
"topicId": 3557,
"accountId": 2488,
"kind": "grouped",
"topicGroupId": 1703,
"exTopicGroupId": 1702,
"orderNo": 0,
"createdAt": "2019-02-13T08:27:22Z",
"updatedAt": "2019-02-13T08:27:22Z"
},
"topic": {
"createdAt": "2016-02-05T06:13:44Z",
"lastPostedAt": "2019-03-11T08:38:04Z",
"isArchived": false,
"suggestion": "UX改善",
"name": "UX改善",
"description": "UXの改善に関するトピックです。\nデザインやUX、その他気づいた点について気軽に話しましょう。\n\nサイト改善についてのまとめWiki\n- https://xxxxx.backlog.jp/wiki/WEBSITE/Kaizen\n\nまた、関連イベントの周知もこのトピックで行います。",
"isDirectMessage": false,
"id": 3557,
"updatedAt": "2018-10-18T01:54:18Z"
},
"onboarding": null,
"hasNext": false,
"team": null,
"mySpace": {
"space": {
"key": "XXXXXXX",
"name": "Nulab Inc",
"enabled": true,
"imageUrl": "https://apps.nulab.com/spaces/XXXXXXX/photo/large"
},
"myRole": "ADMIN",
"isPaymentAdmin": true,
"invitableRoles": [
"ADMIN",
"USER",
"GUEST"
],
"myPlan": {
"plan": {
"key": "typetalk.standard25",
"name": "スタンダード 25 ユーザー",
"limitNumberOfUsers": 25,
"limitNumberOfAllowedAddresses": 25,
"limitTotalAttachmentSize": 268435456000
},
"enabled": true,
"trial": null,
"numberOfUsers": 5,
"numberOfAllowedAddresses": 0,
"totalAttachmentSize": 14356,
"createdAt": "2016-01-19T09:29:10Z",
"updatedAt": "2019-08-28T08:19:49Z"
}
},
"favorite": true,
"posts": [
{
"attachments": [
{
"attachment": {
"contentType": "application/octet-stream",
"fileKey": "1",
"fileName": "1.jpg",
"fileSize": 472263
},
"webUrl": "https://typetalk.com/topics/3557/posts/154010/attachments/1/1.jpg",
"apiUrl": "https://typetalk.com/api/v1/topics/3557/posts/154010/attachments/1/1.jpg"
},
{
"attachment": {
"contentType": "application/octet-stream",
"fileKey": "2",
"fileName": "2.jpg",
"fileSize": 494376
},
"webUrl": "https://typetalk.com/topics/3557/posts/154010/attachments/2/2.jpg",
"apiUrl": "https://typetalk.com/api/v1/topics/3557/posts/154010/attachments/2/2.jpg"
},
{
"attachment": {
"contentType": "application/octet-stream",
"fileKey": "3",
"fileName": "5.jpg",
"fileSize": 218100
},
"webUrl": "https://typetalk.com/topics/3557/posts/154010/attachments/3/5.jpg",
"apiUrl": "https://typetalk.com/api/v1/topics/3557/posts/154010/attachments/3/5.jpg"
},
{
"attachment": {
"contentType": "application/octet-stream",
"fileKey": "4",
"fileName": "6.jpg",
"fileSize": 627926
},
"webUrl": "https://typetalk.com/topics/3557/posts/154010/attachments/4/6.jpg",
"apiUrl": "https://typetalk.com/api/v1/topics/3557/posts/154010/attachments/4/6.jpg"
}
],
"quotedPosts": [],
"message": "トップ画面の改善案できました。https://nulab.com/ja/",
"mention": null,
"createdAt": "2019-03-02T06:13:44Z",
"topicId": 3557,
"contents": null,
"mentions": [],
"talks": [],
"replyTo": null,
"links": [
{
"id": 3148,
"url": "https://nulab.com/ja/",
"contentType": "text/html; charset=UTF-8",
"title": "チームにさらなるコラボレーションを | ヌーラボ",
"description": "数百万人ものユーザーがヌーラボのサービスを使用して、チームのコミュニケーションを改善しています。ヌーラボのオンラインコラボレーションツールで、あなたのチームの仕事をもっと楽しくしましょう。",
"imageUrl": "https://nulab-inc.com/ogp_dft.png",
"embed": null,
"createdAt": "2015-06-15T06:41:24Z",
"updatedAt": "2017-03-03T10:11:08Z"
}
],
"id": 154010,
"account": {
"id": 2492,
"name": "hayashi",
"fullName": "hayashi",
"suggestion": "hayashi",
"imageUrl": "https://typetalk.com/accounts/2492/profile_image.png?t=1453871047310",
"isBot": false,
"createdAt": "2016-01-26T08:19:01Z",
"updatedAt": "2019-09-04T07:25:45Z"
},
"likes": [],
"updatedAt": "2019-03-02T06:13:44Z"
},
{
"attachments": [],
"quotedPosts": [],
"message": "まささん、この画面の色はどう思いますか？",
"mention": null,
"createdAt": "2019-03-03T06:13:44Z",
"topicId": 3557,
"contents": null,
"mentions": [],
"talks": [],
"replyTo": null,
"links": [],
"id": 154011,
"account": {
"id": 2489,
"name": "yoshizawa",
"fullName": "Yoshi",
"suggestion": "Yoshi",
"imageUrl": "https://typetalk.com/accounts/2489/profile_image.png?t=1564389095614",
"isBot": false,
"createdAt": "2016-01-26T08:18:12Z",
"updatedAt": "2019-09-04T07:25:45Z"
},
"likes": [],
"updatedAt": "2019-03-03T06:13:44Z"
}
]
}
レスポンスのフォーマットは全て JSON です。GET メソッドは ETag に対応しているので、If-None-Match ヘッダを付けて送ると、変更がない場合は 304 を返します。日付のフォーマットは ISO 8601 で、UTC です。 （例 : 2014-01-09T06:20:08Z ）