Skip to main content
GET
/
notifications
/
sms
/
v1
/
providers
/
custom
Get Custom Provider for SMS Notifications
curl --request GET \
  --url https://{appid}.api-{region}.cometchat.io/v3/notifications/sms/v1/providers/custom \
  --header 'apikey: <api-key>'
import requests

url = "https://{appid}.api-{region}.cometchat.io/v3/notifications/sms/v1/providers/custom"

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/sms/v1/providers/custom', 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/sms/v1/providers/custom",
  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/sms/v1/providers/custom"

	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/sms/v1/providers/custom")
  .header("apikey", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{appid}.api-{region}.cometchat.io/v3/notifications/sms/v1/providers/custom")

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
{
  "data": {
    "basicAuthPassword": "user888",
    "basicAuthUsername": "pass123",
    "isEnabled": true,
    "useBasicAuth": true,
    "useStoredPhNo": false,
    "webhookURL": "https://trigger-sms.example.com/cometchat"
  }
}

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 custom provider

The response is of type object.