List Settings

List CometChat app notification settings with REST API, including preferences, templates, and sounds.

GET /notifications/v1/settings

List Settings

cURL

curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/settings \
  --header 'apikey: <api-key>'

import requests

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

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/settings', 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/v1/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/settings")
  .header("apikey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

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

200

{
  "data": {
    "preferences": {
      "group": {
        "messagesSetting": 2,
        "messageEditedSetting": 2,
        "messagesOverride": true,
        "repliesSetting": 2,
        "repliesOverride": true,
        "quotedRepliesSetting": 2,
        "quotedRepliesOverride": true,
        "messageDeletedSetting": 2,
        "reactionsSetting": 2,
        "reactionsOverride": true,
        "memberLeftSetting": 1,
        "memberLeftOverride": true,
        "memberAddedSetting": 1,
        "memberAddedOverride": true,
        "memberJoinedSetting": 1,
        "memberJoinedOverride": true,
        "memberKickedSetting": 1,
        "memberKickedOverride": true,
        "memberBannedSetting": 1,
        "memberBannedOverride": true,
        "memberUnbannedSetting": 1,
        "memberUnbannedOverride": true,
        "memberScopeChangedSetting": 1,
        "memberScopeChangedOverride": true
      },
      "bypassPreferencesForMentions": false,
      "call": {
        "busySetting": 1,
        "cancelledSetting": 1,
        "endedSetting": 1,
        "initiatedSetting": 1,
        "ongoingSetting": 1,
        "rejectedSetting": 1,
        "unansweredSetting": 1,
        "initiatedOverride": false,
        "ongoingOverride": false,
        "cancelledOverride": false,
        "rejectedOverride": false,
        "unansweredOverride": false,
        "busyOverride": false,
        "endedOverride": false
      },
      "oneOnOne": {
        "messagesSetting": 2,
        "messagesOverride": true,
        "repliesSetting": 2,
        "repliesOverride": true,
        "quotedRepliesSetting": 2,
        "quotedRepliesOverride": true,
        "messageEditedSetting": 2,
        "messageDeletedSetting": 2,
        "reactionsSetting": 2,
        "reactionsOverride": true
      },
      "mute": {
        "dndPreferenceSetting": 1,
        "dndPreferenceOverride": true,
        "schedulePreferenceSetting": {
          "monday": {
            "from": 0,
            "to": 2359,
            "dnd": false
          },
          "tuesday": {
            "from": 0,
            "to": 2359,
            "dnd": false
          },
          "wednesday": {
            "from": 0,
            "to": 2359,
            "dnd": false
          },
          "thursday": {
            "from": 0,
            "to": 2359,
            "dnd": false
          },
          "friday": {
            "from": 0,
            "to": 2359,
            "dnd": false
          },
          "saturday": {
            "from": 0,
            "to": 2359,
            "dnd": false
          },
          "sunday": {
            "from": 0,
            "to": 2359,
            "dnd": false
          }
        },
        "schedulePreferenceOverride": true,
        "mutedGroupsOverride": true,
        "mutedOneOnOnesOverride": true
      },
      "email": {
        "notifyForUnreadOnly": true,
        "intervalInSeconds": 7200,
        "maxPerDay": 20,
        "maxPerDayPerConversation": 2
      },
      "sms": {
        "notifyForUnreadOnly": true,
        "intervalInSeconds": 7200,
        "maxPerDay": 20,
        "maxPerDayPerConversation": 2
      },
      "push": {
        "includeMessageObjectSetting": false,
        "includeSenderMetadataSetting": true,
        "includeReceiverMetadataSetting": true,
        "trimTextFieldSetting": false,
        "includeMessageMetadataSetting": true,
        "customJson": {
          "hello": "world"
        }
      }
    },
    "sound": {
      "chat": "default",
      "call": "default"
    },
    "templates": {
      "usePrivacyTemplate": 3,
      "textMessageTemplateDefault": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "{{message.data.text}}"
      },
      "textMessageTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "New message"
      },
      "mediaMessageTemplateDefault": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body_audio": "🔈 Has sent an audio",
        "body_file": "📄 Has sent a file",
        "body_image": "📷 Has sent an image",
        "body_video": "🎥 Has sent a video"
      },
      "mediaMessageTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body_audio": "New audio message",
        "body_file": "New file message",
        "body_image": "New image message",
        "body_video": "New video message"
      },
      "pollMessageTemplateDefault": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "{{message.data.text}}",
        "body_fallback": ""
      },
      "pollMessageTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "{{message.data.text}}",
        "body_fallback": ""
      },
      "reminderMessageTemplateDefault": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "{{message.data.text}}",
        "body_fallback": ""
      },
      "reminderMessageTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "{{message.data.text}}",
        "body_fallback": ""
      },
      "customMessageTemplateDefault": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "{{message.data.text}}",
        "body_fallback": "New message"
      },
      "customMessageTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "New message",
        "body_fallback": "New message"
      },
      "emailSubjectTemplateDefault": {
        "subjectGroup": "New messages in {{groupDetails.name}}",
        "subjectOneOnOne": "New messages from {{senderDetails.name}}"
      },
      "emailSubjectTemplatePrivacy": {
        "subjectGroup": "New messages in {{groupDetails.name}}",
        "subjectOneOnOne": "New messages from {{senderDetails.name}}"
      },
      "smsContentTemplateDefault": {
        "bodyGroup": "You've received {{messages.length}} message(s) in {{groupDetails.name}}! Read them at https://your-website.com.",
        "bodyOneOnOne": "You've received {{messages.length}} message(s) from {{senderDetails.name}}! Read them at https://your-website.com."
      },
      "smsContentTemplatePrivacy": {
        "bodyGroup": "You've received {{messages.length}} message(s) in {{groupDetails.name}}! Read them at https://your-website.com.",
        "bodyOneOnOne": "You've received {{messages.length}} message(s) from {{senderDetails.name}}! Read them at https://your-website.com."
      }
    }
  }
}

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).

Response

200 - application/json

A list of push notification's settings

data · object[]

Show child attributes

meta · object