API Request to add user device Player ID or Subscriber ID for push notifications
Request URL
https://yourgrupowebsiteaddress/api_request/
Request body
| Field | Description/Values | Required/Optional |
|---|---|---|
| api_secret_key | Your Grupo API Secret Key. For API Secret Key, Click on Menu > Select Settings > Select General Settings > Find API Secret Key | Required |
| add | push_subscriber | Required |
| user | Username/Email Address of the user | Required |
| device_token | Onesignal Player ID or WebPushr Subscriber ID | Required |
Response Body
| KEY | Description/Values |
|---|---|
| success | This returns true on success and false on failure. |
| error_message | Returns a relevant error message |
| error_key | This method returns the error key associated with the error |
Example PHP Code
<?php
$grupo_web_address = 'https://yourgrupowebsiteaddress';
$post_fields=[
'api_secret_key' => 'Your_Grupo_API_Secret_Key',
'add' => 'push_subscriber',
'user' => 'username/email_address',
'device_token' => 'PlayerID/SID',
];
$api_request_url = rtrim($grupo_web_address, '/').'/'.'api_request/';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => $api_request_url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
CURLOPT_USERAGENT=>'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:99.0) Gecko/20100101 Firefox/99.0'
));
$response = curl_exec($curl);
curl_close($curl);
if (!empty($response)) {
$response = json_decode($response);
if (!empty($response)) {
if (isset($response->error_message)) {
echo $response->error_message;
} else {
echo "Device Added Successfully";
}
}
}
?>