Streaming

Streaming API is for getting real-time data, which requires WebSocket protocol. See also Streaming API Samples.

NOTE: Streaming API is currently in its beta version.

Method

GET

URL

wss://message.typetalk.com/api/v1/streaming

Scope

topic.read

Message Example

There are various types of streaming messages. This is an example of a posted message.

{
  "type": "postMessage",
  "data": {
    "topic": {
      "id": 208,
      "name": "IT Peeps",
      "suggestion": "IT Peeps",
      "lastPostedAt": "2014-07-25T03:38:45Z",
      "createdAt": "2014-06-10T02:32:29Z",
      "updatedAt": "2014-06-10T02:32:29Z"
    },
    "post": {
      "id": 333,
      "topicId": 208,
      "replyTo": null,
      "message": "Let's party like it's 1999!",
      "account": {
        "id": 100,
        "name": "jessica",
        "fullName": "Jessica Fitzherbert",
        "suggestion": "Jessica Fitzherbert",
        "imageUrl": "https://typetalk.com/accounts/100/profile_image.png?t=1403577149000",
        "createdAt": "2014-06-24T02:32:29Z",
        "updatedAt": "2014-06-24T02:32:29Z"
      },
      "mention": null,
      "attachments": [],
      "likes": [],
      "talks": [],
      "links": [],
      "createdAt": "2014-07-25T03:38:45Z",
      "updatedAt": "2014-07-25T03:38:45Z"
    }
  }
}

The date and time format is ISO 8601, and the timezone is UTC (eg. 2014-01-09T06:20:08Z).