Save Twilio credentials

Store the Twilio credentials for the given app.

POST /notifications/sms/v1/providers/twilio

Save Twilio credentials

cURL

curl --request POST \
  --url https://{appId}.api-{region}.cometchat.io/v3/notifications/sms/v1/providers/twilio \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "twilioAccountSID": "AC91e67951ff7e5e7be8122184e76ae0e6",
  "twilioAuthToken": "71c2301435733997e83db7a3445bc57",
  "twilioSenderPhoneNumber": "[phone]",
  "isEnabled": true
}
'

import requests

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

payload = {
    "twilioAccountSID": "AC91e67951ff7e5e7be8122184e76ae0e6",
    "twilioAuthToken": "71c2301435733997e83db7a3445bc57",
    "twilioSenderPhoneNumber": "[phone]",
    "isEnabled": True
}
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({
    twilioAccountSID: 'AC91e67951ff7e5e7be8122184e76ae0e6',
    twilioAuthToken: '71c2301435733997e83db7a3445bc57',
    twilioSenderPhoneNumber: '[phone]',
    isEnabled: true
  })
};

fetch('https://{appId}.api-{region}.cometchat.io/v3/notifications/sms/v1/providers/twilio', 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/twilio",
  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([
    'twilioAccountSID' => 'AC91e67951ff7e5e7be8122184e76ae0e6',
    'twilioAuthToken' => '71c2301435733997e83db7a3445bc57',
    'twilioSenderPhoneNumber' => '[phone]',
    'isEnabled' => true
  ]),
  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/sms/v1/providers/twilio"

	payload := strings.NewReader("{\n  \"twilioAccountSID\": \"AC91e67951ff7e5e7be8122184e76ae0e6\",\n  \"twilioAuthToken\": \"71c2301435733997e83db7a3445bc57\",\n  \"twilioSenderPhoneNumber\": \"[phone]\",\n  \"isEnabled\": true\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/sms/v1/providers/twilio")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"twilioAccountSID\": \"AC91e67951ff7e5e7be8122184e76ae0e6\",\n  \"twilioAuthToken\": \"71c2301435733997e83db7a3445bc57\",\n  \"twilioSenderPhoneNumber\": \"[phone]\",\n  \"isEnabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"twilioAccountSID\": \"AC91e67951ff7e5e7be8122184e76ae0e6\",\n  \"twilioAuthToken\": \"71c2301435733997e83db7a3445bc57\",\n  \"twilioSenderPhoneNumber\": \"[phone]\",\n  \"isEnabled\": true\n}"

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

200

{
  "data": {
    "twilioAccountSID": "AC91e67951ff7e5e7be8122184e76ae0e6=",
    "twilioAuthToken": "71c2301435733997e83db7a3445bc57",
    "twilioSenderPhoneNumber": "[phone]"
  }
}

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

twilioAccountSID · string · required

The Twilio Account SID

Example:

"AC91e67951ff7e5e7be8122184e76ae0e6"

twilioAuthToken · string · required

The Twilio Auth Token

Example:

"71c2301435733997e83db7a3445bc57"

twilioSenderPhoneNumber · string · required

The Twilio sender phone number

Example:

"[phone]"

isEnabled · boolean

Enable Twilio

Response

200 - application/json

A list of push notification's settings

data · any[]

meta · object