Register push token

Register a push token for the given auth token.

POST /notifications/push/v1/tokens

Register push token

cURL

curl --request POST \
  --url https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/tokens \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "providerId": "fcm-provider-2",
  "fcmToken": "<string>",
  "authToken": "cometchat-uid-3_1710141033938cf7e3c67cc44465440d",
  "timezone": "Asia/Kolkata"
}
'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/tokens"

payload = {
    "providerId": "fcm-provider-2",
    "fcmToken": "<string>",
    "authToken": "cometchat-uid-3_1710141033938cf7e3c67cc44465440d",
    "timezone": "Asia/Kolkata"
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    providerId: 'fcm-provider-2',
    fcmToken: '<string>',
    authToken: 'cometchat-uid-3_1710141033938cf7e3c67cc44465440d',
    timezone: 'Asia/Kolkata'
  })
};

fetch('https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/tokens', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/tokens",
  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([
    'providerId' => 'fcm-provider-2',
    'fcmToken' => '<string>',
    'authToken' => 'cometchat-uid-3_1710141033938cf7e3c67cc44465440d',
    'timezone' => 'Asia/Kolkata'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/tokens"

	payload := strings.NewReader("{\n  \"providerId\": \"fcm-provider-2\",\n  \"fcmToken\": \"<string>\",\n  \"authToken\": \"cometchat-uid-3_1710141033938cf7e3c67cc44465440d\",\n  \"timezone\": \"Asia/Kolkata\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/tokens")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"providerId\": \"fcm-provider-2\",\n  \"fcmToken\": \"<string>\",\n  \"authToken\": \"cometchat-uid-3_1710141033938cf7e3c67cc44465440d\",\n  \"timezone\": \"Asia/Kolkata\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"providerId\": \"fcm-provider-2\",\n  \"fcmToken\": \"<string>\",\n  \"authToken\": \"cometchat-uid-3_1710141033938cf7e3c67cc44465440d\",\n  \"timezone\": \"Asia/Kolkata\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "success": true
  }
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json

PlatformFCM

PlatformAPNS

PlatformVOIP

Response data

platform · enum<string>

FCM push token platform.

Available options: fcm_android, fcm_ios, fcm_web, fcm_flutter_android, fcm_flutter_ios, fcm_react_native_android, fcm_react_native_ios, fcm_ionic_cordova_android, fcm_ionic_cordova_ios

providerId · string

Example:

"fcm-provider-2"

fcmToken · string

authToken · string

Example:

"cometchat-uid-3_1710141033938cf7e3c67cc44465440d"

timezone · string

Example:

"Asia/Kolkata"

Response

200 - application/json

A list of push notification's settings

data · any[]

meta · object