GET
/
notifications
/
v1
/
settings
List Settings
curl --request GET \
  --url https://{appid}.api-{region}.cometchat.io/v3/notifications/v1/settings \
  --header 'apikey: <api-key>'
{
  "data": {
    "preferences": {
      "group": {
        "messagesSetting": 2,
        "messageEditedSetting": 2,
        "messagesOverride": true,
        "repliesSetting": 2,
        "repliesOverride": 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,
        "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"
      },
      "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"
      },
      "interactiveFormTemplateDefault": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "{{message.data.interactiveData.title}}"
      },
      "interactiveFormTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "New message"
      },
      "interactiveCardTemplateDefault": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "{{message.data.interactiveData.text}}"
      },
      "interactiveCardTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}}",
        "body": "New message"
      },
      "interactiveSchedulerTemplateDefault": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "New invite"
      },
      "interactiveSchedulerTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "New invite"
      },
      "interactiveCustomTemplateDefault": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "New message"
      },
      "interactiveCustomTemplatePrivacy": {
        "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
        "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
        "body": "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."
      }
    }
  }
}

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

The response is of type object.