{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance/push_notifications/apns/devices/:registration_id/send_message/","auth":"required","examples":{"codes":[{"code":"curl -X POST \\ \n-H \"Content-Type: application/json\" \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n-d '{\"content\": {\"environment\": \"development\",\"aps\": {\"alert\": \"hello\"}}' \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE/push_notifications/apns/devices/ID/send_message/\"","language":"curl"},{"code":"import syncano\nfrom syncano.models import APNSDevice, APNSMessage\n\nsyncano.connect(api_key=\"ACCOUNT_KEY\", instance_name=\"INSTANCE_NAME\")\n\ndevice = APNSDevice.please.get(\n    registration_id=86152312314401554\n)\n\nmessage = APNSMessage.please.create(\n    content={\n        'registration_ids': [gcm_device.registration_id],  # maximum 1000 elements;\n    \t\t'environment': 'development',\n        'aps': {'alert': 'hello'}\n    }\n)\n\n# or:\n\ndevice.send_message(\n    content={\n          'environment': 'development',\n          'aps': {'alert': 'hello'}\n      }\n)","language":"python","name":"Python"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar APNSDevice = connection.APNSDevice;\n\nvar query = {instanceName: \"INSTANCE_NAME\", registration_id: \"REGISTRATION_ID\"};\nvar content = {\n  environment: \"development\"  // or production,\n  aps: {alert: \"hello\"}\n};\n\nAPNSDevice.please().sendMessage(query, content).then(function(message) {\n\tconsole.log('Message', message);\n});"}]},"method":"post","params":[{"name":"instance","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"56c51e58668eb01900719bcc"},{"name":"registration_id","type":"string","default":"","desc":"Registration ID","required":true,"in":"path","ref":"","_id":"56c520258dc1c51900abc147"},{"name":"environment","type":"string","default":"","desc":"production or development","required":true,"in":"body","ref":"","_id":"56c6ad0c70e7660d004a899b"},{"name":"label","type":"string","default":"","desc":"Label","required":false,"in":"body","ref":"","_id":"56c51e58668eb01900719bcb"},{"name":"user","type":"int","default":"","desc":"User ID","required":false,"in":"body","ref":"","_id":"56c51e58668eb01900719bca"},{"name":"device_id","type":"string","default":"","desc":"Device ID (Hex)","required":false,"in":"body","ref":"","_id":"56c520258dc1c51900abc146"},{"name":"metadata","type":"string","default":"","desc":"Metadata","required":false,"in":"body","ref":"","_id":"56c520258dc1c51900abc145"},{"name":"is_active","type":"boolean","default":"","desc":"Is active","required":false,"in":"body","ref":"","_id":"56c520258dc1c51900abc144"}],"results":{"codes":[{"name":"","code":"{\n    \"id\": 1, \n    \"status\": \"scheduled\", \n    \"content\": {\n        \"environment\": \"development\", \n        \"aps\": {\n            \"alert\": \"hello\"\n        }, \n        \"registration_ids\": [\n            \"ID\"\n        ]\n    }, \n    \"result\": {}, \n    \"created_at\": \"2016-04-15T13:25:07.313414Z\", \n    \"updated_at\": \"2016-04-15T13:25:07.313438Z\", \n    \"links\": {\n        \"self\": \"/v1.1/instances/INSTANCE/push_notifications/apns/messages/ID/\"\n    }\n}","language":"json","status":200}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"APNS Device - send message","type":"endpoint","slug":"apns-device-send-message","excerpt":"Add new APNS Device","body":"","updates":[],"order":10,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"570f9ebad6c6f00e00b987f1","parentDoc":null,"__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Push Notifications (APNS)","slug":"push-notifications-apns","order":18,"from_sync":false,"reference":true,"_id":"56c6b0baf795cf0d003ec13e","createdAt":"2016-02-19T06:05:46.171Z","__v":0,"project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635"},"createdAt":"2016-04-14T13:44:26.614Z","editedParams":true,"version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"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"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"project":"54774d9af3736008009e9e0e","editedParams2":true,"githubsync":"","user":"54ad3a04f6f5b10b0066dc61"}

postAPNS Device - send message

Add new APNS 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 }}