{"_id":"56c50633bdcde80d004986be","version":{"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z","categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"API v1.1","version_clean":"0.1.1","version":"0.1.1"},"githubsync":"","parentDoc":null,"project":"54774d9af3736008009e9e0e","category":{"_id":"56c50628bdcde80d00498645","version":"56c50626bdcde80d00498635","__v":1,"project":"54774d9af3736008009e9e0e","pages":["56c50633bdcde80d004986b7","56c50633bdcde80d004986b8","56c50633bdcde80d004986b9","56c50633bdcde80d004986ba","56c50633bdcde80d004986bb","56c50633bdcde80d004986bc","56c50633bdcde80d004986bd","56c50633bdcde80d004986be","56c50633bdcde80d004986bf"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-05-21T13:12:14.654Z","from_sync":false,"order":19,"slug":"channels","title":"Channels"},"editedParams":true,"__v":0,"editedParams2":true,"user":"54774c47f3736008009e9e0c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-22T11:37:13.490Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X GET \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"X-USER-KEY: <USER_KEY>\" \\\n-d '{\"room\":\"<ROOM_NAME>\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance>/channels/<channel_name>/history/\"","name":"","gist":"47d76024a9729f415058"},{"language":"python","code":"import syncano\nfrom syncano.models import Message\n\nsyncano.connect(api_key=\"API_KEY\", user_key=\"USER_KEY\", instance_name=\"INSTANCE_NAME\")\n\nchannel_histories = Message.please.all(channel_name='CHANNEL_NAME')\n\nfor channel_history in channel_histories:\n    payload = channel_history.payload\n    metadata = channel_history.metadata\n"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({apiKey: \"API_KEY\", userKey: \"USER_KEY\"});\nvar Channel = connection.Channel;\n\nChannel.please().history({instanceName: \"INSTANCE_NAME\", name: \"NAME\"}).then(callback);"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"prev\": null,\n  \"objects\": [\n    {\n      \"room\": \"secret-room\",\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/channels/witchers/history/54/\"\n      },\n      \"author\": {\n        \"admin\": 8\n      },\n      \"created_at\": \"2016-03-17T20:14:45.800039Z\",\n      \"payload\": {\n        \"message\": \"Hello Witchers!\",\n        \"type\": \"welcome\"\n      },\n      \"action\": \"custom\",\n      \"id\": 54,\n      \"metadata\": {\n        \"type\": \"message\"\n      }\n    },\n    {\n      \"room\": \"secret-room\",\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/channels/witchers/history/53/\"\n      },\n      \"author\": {\n        \"admin\": 8\n      },\n      \"created_at\": \"2016-03-17T20:13:46.695378Z\",\n      \"payload\": {\n        \"message\": \"Hello Witchers!\",\n        \"type\": \"welcome\"\n      },\n      \"action\": \"custom\",\n      \"id\": 53,\n      \"metadata\": {\n        \"type\": \"message\"\n      }\n    },\n    {\n      \"room\": \"secret-room\",\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/channels/witchers/history/52/\"\n      },\n      \"author\": {\n        \"admin\": 8\n      },\n      \"created_at\": \"2016-03-17T20:13:09.628389Z\",\n      \"payload\": {\n        \"content\": \"Hello Witchers!\",\n        \"type\": \"welcome\"\n      },\n      \"action\": \"custom\",\n      \"id\": 52,\n      \"metadata\": {\n        \"type\": \"message\"\n      }\n    }\n  ],\n  \"next\": null\n}","language":"json","status":200},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Not found\"\n}"}]},"auth":"required","params":[{"_id":"555ddf718ab3180d001ac55f","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"555e12ab06dfec0d00d39063","ref":"","in":"path","required":true,"desc":"Channel name","default":"","type":"string","name":"channel_name"},{"_id":"555f1e40df54680d0018032e","ref":"","in":"query","required":false,"desc":"Room name. Shouldn't be passed if Channel type is `default`. If Channel is of `separate_rooms` type then room name should be added.","default":"","type":"string","name":"room"}],"url":"/instances/:instance_name/channels/:channel_name/history/"},"isReference":true,"order":7,"body":"Get a history of notification messages that were sent to a Channel with a given name.","excerpt":"","slug":"channels-history","type":"endpoint","title":"Channels - history"}

getChannels - history


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
channel_name:
required
string
Channel name

Query Params

room:
string
Room name. Shouldn't be passed if Channel type is `default`. If Channel is of `separate_rooms` type then room name should be added.

Examples


Result Format


Documentation

Get a history of notification messages that were sent to a Channel with a given name.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}