メッセージを検索

このAPIを使って、トピックに投稿されたメッセージを検索することができます。

メソッド

GET

URL

https://typetalk.com/api/v2/search/posts

スコープ

topic.read

クエリパラメーター

Name Type Description
q 文字列 検索文字列
spaceKey 文字列 組織キー
topicIds (任意) 数値 検索対象のトピック。指定がなければ全てのトピックが対象。
hasAttachments (任意) 真偽値 添付ファイルを持っている投稿のみ検索。デフォルト値:false
accountIds (任意) 数値 アカウントID
from (任意) 日付時刻 検索範囲の起点となる日付時刻
to (任意) 日付時刻 検索範囲の終点となる日付時刻

レスポンスの例

{
    "count": 32,
    "posts": [
        {
            "id": 11842896,
            "topicId": 53692,
            "topic": {
                "id": 53692,
                "name": "Awesome project",
                "suggestion": "Awesome project",
                "isDirectMessage": false,
                "lastPostedAt": "2017-10-12T06:20:40Z",
                "createdAt": "2017-09-27T09:43:29Z",
                "updatedAt": "2017-10-12T06:22:28Z"
            },
            "replyTo": null,
            "message": "It is sunny today.",
            "account": {
                "id": 50117,
                "name": "Michael",
                "fullName": "Michael Buck",
                "suggestion": "Michael Buck",
                "imageUrl": "https://typetalk.com/accounts/50117/profile_image.png?t=1504408579564",
                "isBot": false,
                "createdAt": "2017-09-01T01:55:05Z",
                "updatedAt": "2017-10-12T07:15:40Z"
            },
            "attachments": [],
            "links": [],
            "directMessage": null,
            "createdAt": "2017-10-12T06:20:20Z",
            "updatedAt": "2017-10-12T06:20:20Z"
        }
    ],
    "isLimited": false
}

レスポンスのフォーマットは全てJSONです。GETメソッドはETagに対応しているので、If-None-Match ヘッダを付けて送ると、変更がない場合は304を返します。日付のフォーマットは ISO 8601 で、UTC です。 (例 : 2014-01-09T06:20:08Z )