{"_id":"56c6ad0c70e7660d004a899a","project":"54774d9af3736008009e9e0e","editedParams":true,"githubsync":"","parentDoc":null,"__v":0,"category":{"_id":"56c506a018f0c90d002808de","project":"54774d9af3736008009e9e0e","__v":16,"pages":["56c506c40fba010d0043074d","56c506d673eb9a1700fbc90a","56c506e20fba010d0043074f","56c50cd718f0c90d002808e7","56c51e58668eb01900719bc9","56c51ea57de3580d00bdaf29","56c51fcf6889720d0099db00","56c52090d70fed0d00160cd4","56c5218cd1b8770d00922298","56c522eed1b8770d0092229d","56c5244773eb9a1700fbc918","56c524a373eb9a1700fbc919","56c6ad0c70e7660d004a899a","56c6af8ff133430d00b34018","56c6b0489d75580d00026225","56c6b09b38991717009a81f3"],"version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-17T23:47:44.305Z","from_sync":false,"order":17,"slug":"push-notifications","title":"Push Notifications (GCM)"},"editedParams2":true,"user":"548193732dca603300bf6ea1","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"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-19T05:50:04.888Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n-H \"Content-Type: application/json\" \\\n-H \"X-API-KEY: API_KEY\" \\\n-d '{\"content\":{\"data\": {\"one\": 1, \"two\": 2}, \"environment\": \"development\"}}' \\ \n \"https://api.syncano.io/v1.1/instances/INSTANCE/push_notifications/gcm/devices/REGISTRATION_ID/send_message/\""},{"name":"Python","language":"python","code":"import syncano\nfrom syncano.models import GCMDevice, GCMMessage\n\nsyncano.connect(api_key=\"ACCOUNT_KEY\", instance_name=\"INSTANCE_NAME\") \n\ngcm_device = GCMDevice.please.get(\n    registration_id=\"86152312314401554\"\n)\n\nmessage = GCMMessage.please.create(\n    content={\n        'registration_ids': [\"123\"],  # maximum 1000 elements;\n    \t\t'environment': 'development',\n        'data': {\n      \t\t'one': 1,\n      \t\t'two': 2,\n        }\n    }\n)\n\n# or:\ngcm_device.send_message(\n  content={\n    \t\t'environment': 'development',\n        'data': {\n      \t\t'one': 1,\n      \t\t'two': 2,\n        }\n    }\n)\n"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar GCMDevice = connection.GCMDevice;\n\nvar query = {instanceName: \"INSTANCE_NAME\"};\nvar content = {\n  environment: 'development'  // or production,\n  data: {\n    one: 1,\n    two: 2\n  }\n};\n\nGCMDevice.please().sendMessage(query, content).then(function(message) {\n\tconsole.log('GCMMessage', message);\n});"}]},"method":"post","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"id\": 1, \n  \"status\": \"scheduled\", \n  \"content\": {\n    \"environment\": \"development\", \n    \"registration_ids\": [\n      \"123\"\n    ], \n    \"data\": {\n      \"one\": 1, \n      \"two\": 2\n    }\n  }, \n  \"result\": {}, \n  \"created_at\": \"2016-04-15T12:23:38.733380Z\", \n  \"updated_at\": \"2016-04-15T12:23:38.733407Z\", \n  \"links\": {\n    \"self\": \"/v1.1/instances/INSTANCE_NAME/push_notifications/gcm/messages/MESSAGE_ID/\"\n  }\n}"}]},"auth":"required","params":[{"_id":"56c51e58668eb01900719bcc","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance"},{"_id":"56c520258dc1c51900abc147","ref":"","in":"path","required":true,"desc":"Registration ID","default":"","type":"string","name":"registration_id"},{"_id":"56c6ad0c70e7660d004a899b","ref":"","in":"body","required":true,"desc":"production or development","default":"","type":"string","name":"environment"},{"_id":"56c51e58668eb01900719bcb","ref":"","in":"body","required":false,"desc":"Label","default":"","type":"string","name":"label"},{"_id":"56c51e58668eb01900719bca","ref":"","in":"body","required":false,"desc":"User ID","default":"","type":"int","name":"user"},{"_id":"56c520258dc1c51900abc146","ref":"","in":"body","required":false,"desc":"Device ID (Hex)","default":"","type":"string","name":"device_id"},{"_id":"56c520258dc1c51900abc145","ref":"","in":"body","required":false,"desc":"Metadata","default":"","type":"string","name":"metadata"},{"_id":"56c520258dc1c51900abc144","ref":"","in":"body","required":false,"desc":"Is active","default":"","type":"boolean","name":"is_active"}],"url":"/instances/:instance/push_notifications/gcm/devices/:registration_id/send_message/"},"isReference":true,"order":9,"body":"","excerpt":"Add new GCM Device","slug":"gcm-device-send-message","type":"endpoint","title":"GCM Device - send message"}

postGCM Device - send message

Add new GCM Device

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance:
required
string
Instance name
registration_id:
required
string
Registration ID

Body Params

environment:
required
string
production or development
label:
string
Label
user:
integer
User ID
device_id:
string
Device ID (Hex)
metadata:
string
Metadata
is_active:
boolean
Is active

Examples


Result Format


User Information

Try It Out

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