Skip to main content
GET
/
apps
/
{appId}
/
extensions
/
widget
/
v2
/
settings
Chat Widgets List
curl --request GET \
  --url https://apimgmt.cometchat.io/apps/{appId}/extensions/widget/v2/settings \
  --header 'key: <key>' \
  --header 'secret: <secret>'
import requests

url = "https://apimgmt.cometchat.io/apps/{appId}/extensions/widget/v2/settings"

headers = {
    "key": "<key>",
    "secret": "<secret>"
}

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

print(response.text)
const options = {method: 'GET', headers: {key: '<key>', secret: '<secret>'}};

fetch('https://apimgmt.cometchat.io/apps/{appId}/extensions/widget/v2/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://apimgmt.cometchat.io/apps/{appId}/extensions/widget/v2/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 => [
    "key: <key>",
    "secret: <secret>"
  ],
]);

$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://apimgmt.cometchat.io/apps/{appId}/extensions/widget/v2/settings"

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

	req.Header.Add("key", "<key>")
	req.Header.Add("secret", "<secret>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://apimgmt.cometchat.io/apps/{appId}/extensions/widget/v2/settings")
  .header("key", "<key>")
  .header("secret", "<secret>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://apimgmt.cometchat.io/apps/{appId}/extensions/widget/v2/settings")

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

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

response = http.request(request)
puts response.read_body
{
  "data": {
    "statusCode": 200,
    "success": true,
    "body": {
      "data": [
        {
          "configuration": {
            "name": "Test Chat Widget",
            "style": {
              "docked_layout_icon_background": "#03a9f4",
              "custom_js": "v2",
              "docked_layout_icon_close": "https://widget-js.cometchat.io/v2/resources/chat_close.svg",
              "custom_css": "string",
              "docked_layout_icon_open": "https://widget-js.cometchat.io/v2/resources/chat_bubble.svg",
              "primary_color": "#03A9F4",
              "foreground_color": "#000000",
              "background_color": "#FFFFFF",
              "override_system_background_colors": true
            },
            "main": {
              "allow_message_reactions": true,
              "enable_collaborative_whiteboard": true,
              "enable_collaborative_document": true,
              "enable_video_calling": true,
              "enable_editing_messages": true,
              "enable_sending_messages": true,
              "allow_moderator_to_delete_member_messages": true,
              "join_or_leave_groups": true,
              "block_user": true,
              "enable_voice_calling": true,
              "send_emojis": true,
              "send_files": true,
              "view_shared_media": true,
              "enable_sound_for_messages": true,
              "send_photos_videos": true,
              "show_stickers": true,
              "enable_sound_for_calls": true,
              "show_call_notifications": true,
              "view_group_members": true,
              "allow_delete_groups": true,
              "allow_kick_ban_members": true,
              "hide_join_leave_notifications": true,
              "enable_message_translation": true,
              "send_message_in_private_to_group_member": true,
              "create_groups": true,
              "show_typing_indicators": true,
              "show_user_presence": true,
              "allow_add_members": true,
              "enable_deleting_messages": true,
              "enable_threaded_replies": true,
              "show_delivery_read_indicators": true,
              "hide_deleted_messages": true,
              "allow_creating_polls": true,
              "allow_promote_demote_members": true,
              "share_live_reactions": true,
              "show_emojis_in_larger_size": true,
              "allow_mention_members": false,
              "enable_replying_to_messages": false,
              "enable_share_copy_forward_messages": false,
              "highlight_messages_from_moderators": false,
              "show_call_recording_option": false,
              "send_voice_notes": true,
              "send_gifs": false,
              "share_location": false,
              "set_groups_in_qna_mode_by_moderators": false,
              "send_reply_in_private_to_group_member": false
            },
            "version": "v2",
            "sidebar": {
              "group_listing": "public_and_password_protected_groups",
              "start_a_new_conversation": "all_chats",
              "user_settings": true,
              "calls": true,
              "chats": true,
              "user_listing": "all_users",
              "groups": true,
              "recent_chat_listing": "all_chats",
              "sidebar_navigation_sequence": [
                "chats",
                "users",
                "groups",
                "calls",
                "settings"
              ],
              "users": true
            },
            "appId": "564663ddb71bbb"
          },
          "widgetId": "c59766f0-5318-4c82-b6b3-fa09ee80a506"
        }
      ]
    },
    "responseTime": 0.11409401893615723
  }
}
For the complete error reference, see Error Guide.

Headers

​
key
string
required

Authorization Key

​
secret
string
required

Authorization Secret

Path Parameters

​
appId
string
required

AppID in which the extension has to be enabled/disabled

Response

200 - application/json

Create Chat Widget

​
object
​
meta
object