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
}
'

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