Send Push Notification
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Pocket/SendPushNotification");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"AssociateIds\": [\n 123\n ],\n \"Message\": {\n \"Title\": \"<string>\",\n \"Message\": \"<string>\",\n \"Url\": \"<string>\",\n \"Silent\": true,\n \"TimeToLive\": 123,\n \"RecordId\": 123,\n \"Date\": \"2023-11-07T05:31:56Z\",\n \"Duration\": \"<string>\",\n \"ExtraValues\": {}\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({
AssociateIds: [123],
Message: {
Title: '<string>',
Message: '<string>',
Url: '<string>',
Silent: true,
TimeToLive: 123,
RecordId: 123,
Date: '2023-11-07T05:31:56Z',
Duration: '<string>',
ExtraValues: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Pocket/SendPushNotification', 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/SendPushNotification",
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([
'AssociateIds' => [
123
],
'Message' => [
'Title' => '<string>',
'Message' => '<string>',
'Url' => '<string>',
'Silent' => true,
'TimeToLive' => 123,
'RecordId' => 123,
'Date' => '2023-11-07T05:31:56Z',
'Duration' => '<string>',
'ExtraValues' => [
]
]
]),
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/SendPushNotification"
payload = {
"AssociateIds": [123],
"Message": {
"Title": "<string>",
"Message": "<string>",
"Url": "<string>",
"Silent": True,
"TimeToLive": 123,
"RecordId": 123,
"Date": "2023-11-07T05:31:56Z",
"Duration": "<string>",
"ExtraValues": {}
}
}
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({
AssociateIds: [123],
Message: {
Title: '<string>',
Message: '<string>',
Url: '<string>',
Silent: true,
TimeToLive: 123,
RecordId: 123,
Date: '2023-11-07T05:31:56Z',
Duration: '<string>',
ExtraValues: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Pocket/SendPushNotification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Send Push Notification
Send a push notification to one or more associates
NsApiSlow threshold: 5000 ms.
Send Push Notification
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Pocket/SendPushNotification");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"AssociateIds\": [\n 123\n ],\n \"Message\": {\n \"Title\": \"<string>\",\n \"Message\": \"<string>\",\n \"Url\": \"<string>\",\n \"Silent\": true,\n \"TimeToLive\": 123,\n \"RecordId\": 123,\n \"Date\": \"2023-11-07T05:31:56Z\",\n \"Duration\": \"<string>\",\n \"ExtraValues\": {}\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({
AssociateIds: [123],
Message: {
Title: '<string>',
Message: '<string>',
Url: '<string>',
Silent: true,
TimeToLive: 123,
RecordId: 123,
Date: '2023-11-07T05:31:56Z',
Duration: '<string>',
ExtraValues: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Pocket/SendPushNotification', 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/SendPushNotification",
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([
'AssociateIds' => [
123
],
'Message' => [
'Title' => '<string>',
'Message' => '<string>',
'Url' => '<string>',
'Silent' => true,
'TimeToLive' => 123,
'RecordId' => 123,
'Date' => '2023-11-07T05:31:56Z',
'Duration' => '<string>',
'ExtraValues' => [
]
]
]),
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/SendPushNotification"
payload = {
"AssociateIds": [123],
"Message": {
"Title": "<string>",
"Message": "<string>",
"Url": "<string>",
"Silent": True,
"TimeToLive": 123,
"RecordId": 123,
"Date": "2023-11-07T05:31:56Z",
"Duration": "<string>",
"ExtraValues": {}
}
}
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({
AssociateIds: [123],
Message: {
Title: '<string>',
Message: '<string>',
Url: '<string>',
Silent: true,
TimeToLive: 123,
RecordId: 123,
Date: '2023-11-07T05:31:56Z',
Duration: '<string>',
ExtraValues: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Pocket/SendPushNotification', 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
AssociateIds, Message
SendPushNotification: Send a push notification to one or more associates
Response
204
No Content
Was this page helpful?