Register Device For Push Notification
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"DeviceInfo\": {\n \"DeviceName\": \"<string>\",\n \"DeviceIdentifier\": \"<string>\",\n \"PocketVersion\": \"<string>\",\n \"Language\": \"<string>\",\n \"PNSHandle\": \"<string>\",\n \"OSVersion\": \"<string>\",\n \"TimeZoneId\": 123\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
DeviceInfo: {
DeviceName: '<string>',
DeviceIdentifier: '<string>',
PocketVersion: '<string>',
Language: '<string>',
PNSHandle: '<string>',
OSVersion: '<string>',
TimeZoneId: 123
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'DeviceInfo' => [
'DeviceName' => '<string>',
'DeviceIdentifier' => '<string>',
'PocketVersion' => '<string>',
'Language' => '<string>',
'PNSHandle' => '<string>',
'OSVersion' => '<string>',
'TimeZoneId' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification"
payload = { "DeviceInfo": {
"DeviceName": "<string>",
"DeviceIdentifier": "<string>",
"PocketVersion": "<string>",
"Language": "<string>",
"PNSHandle": "<string>",
"OSVersion": "<string>",
"TimeZoneId": 123
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
DeviceInfo: {
DeviceName: '<string>',
DeviceIdentifier: '<string>',
PocketVersion: '<string>',
Language: '<string>',
PNSHandle: '<string>',
OSVersion: '<string>',
TimeZoneId: 123
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Register Device For Push Notification
Register a device that should receive push notifications when notable events occour
NsApiSlow threshold: 5000 ms.
Register Device For Push Notification
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"DeviceInfo\": {\n \"DeviceName\": \"<string>\",\n \"DeviceIdentifier\": \"<string>\",\n \"PocketVersion\": \"<string>\",\n \"Language\": \"<string>\",\n \"PNSHandle\": \"<string>\",\n \"OSVersion\": \"<string>\",\n \"TimeZoneId\": 123\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
DeviceInfo: {
DeviceName: '<string>',
DeviceIdentifier: '<string>',
PocketVersion: '<string>',
Language: '<string>',
PNSHandle: '<string>',
OSVersion: '<string>',
TimeZoneId: 123
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'DeviceInfo' => [
'DeviceName' => '<string>',
'DeviceIdentifier' => '<string>',
'PocketVersion' => '<string>',
'Language' => '<string>',
'PNSHandle' => '<string>',
'OSVersion' => '<string>',
'TimeZoneId' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification"
payload = { "DeviceInfo": {
"DeviceName": "<string>",
"DeviceIdentifier": "<string>",
"PocketVersion": "<string>",
"Language": "<string>",
"PNSHandle": "<string>",
"OSVersion": "<string>",
"TimeZoneId": 123
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
DeviceInfo: {
DeviceName: '<string>',
DeviceIdentifier: '<string>',
PocketVersion: '<string>',
Language: '<string>',
PNSHandle: '<string>',
OSVersion: '<string>',
TimeZoneId: 123
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Pocket/RegisterDeviceForPushNotification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Headers
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
DeviceInfo
RegisterDeviceForPushNotification: Register a device that should receive push notifications when notable events occour
Describes a device running Pocket CRM Carrier object for PocketDeviceInfo. Services for the PocketDeviceInfo Carrier is available from the Pocket Agent.
Show child attributes
Show child attributes
Response
204
No Content
Related topics
NSPocketAgentSet Push Notification Tags For DeviceGet Push Notification Tags For DevicePushNotificationService tableGet Registered DevicesManage notifications⌘I