curl --request POST \
  --url https://api.liara.ir/v1/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "sms",
  "interestedNotifications": [
    "LowCredit",
    "ServicesHaveBeenFrozen"
  ],
  "metaData": {
    "phone": "09120000000",
    "token": "123456"
  }
}
'

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "You have reached your maximum number of allowed channels.",
  "data": null
}

{
  "error": "Unauthorized."
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Invalid token.",
  "data": null
}

Notification Channels

Add a notification channel

Adds a channel that receives the notification types you choose.

SMS or email: first send a code with POST /v1/channels/send-phone-token or POST /v1/channels/send-email-token, then send it here as metaData.token (SMS codes are valid for 2 minutes, email codes for 3).
Telegram: send your numeric Telegram chat ID as metaData.chatID.

Your subscription plan limits how many channels of each type you can have. Your account must be verified. With teamID, this needs the team.manage permission.

POST

channels

curl --request POST \
  --url https://api.liara.ir/v1/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "sms",
  "interestedNotifications": [
    "LowCredit",
    "ServicesHaveBeenFrozen"
  ],
  "metaData": {
    "phone": "09120000000",
    "token": "123456"
  }
}
'

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "You have reached your maximum number of allowed channels.",
  "data": null
}

{
  "error": "Unauthorized."
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Invalid token.",
  "data": null
}

Authorizations

Authorization

string

header

required

Send your API token as Authorization: Bearer <api-token>.

Query Parameters

teamID

string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

type

enum<string>

required

Available options:

sms,

email,

telegram

interestedNotifications

string[]

required

Notification types to send to this channel. For sms, use values from SMSNotificationType; for email and telegram, values from EmailNotificationType.

Minimum array length: 1

metaData

SMS · object

required

Show child attributes

Response

The channel was added. The response body is empty.

Introduction

Authentication & Account

Teams & Access

Billing & Subscription

Support & Notifications

Add a notification channel

Authorizations

Query Parameters

Body

Response