@netgsm/sms
Version:
Netgsm API Client for SMS sending and reporting
105 lines (104 loc) • 3.67 kB
JavaScript
/**
* @module Enums
* @description Netgsm SMS API enumerations
*/
/**
* SMS status codes
* @enum {number}
*/
export var SmsStatus;
(function (SmsStatus) {
/** Message pending */
SmsStatus[SmsStatus["PENDING"] = 0] = "PENDING";
/** Message sent */
SmsStatus[SmsStatus["SENT"] = 1] = "SENT";
/** Message expired */
SmsStatus[SmsStatus["EXPIRED"] = 2] = "EXPIRED";
/** Invalid or restricted number */
SmsStatus[SmsStatus["INVALID_NUMBER"] = 3] = "INVALID_NUMBER";
/** Not sent to operator */
SmsStatus[SmsStatus["NOT_SENT"] = 4] = "NOT_SENT";
/** Message rejected */
SmsStatus[SmsStatus["REJECTED"] = 11] = "REJECTED";
/** Delivery error */
SmsStatus[SmsStatus["DELIVERY_ERROR"] = 12] = "DELIVERY_ERROR";
/** Duplicate message */
SmsStatus[SmsStatus["DUPLICATE"] = 13] = "DUPLICATE";
/** Blacklisted number */
SmsStatus[SmsStatus["BLACKLISTED"] = 14] = "BLACKLISTED";
/** IYS rejected */
SmsStatus[SmsStatus["IYS_REJECTED"] = 16] = "IYS_REJECTED";
/** IYS error */
SmsStatus[SmsStatus["IYS_ERROR"] = 17] = "IYS_ERROR";
/** All messages */
SmsStatus[SmsStatus["ALL"] = 100] = "ALL";
})(SmsStatus || (SmsStatus = {}));
/**
* API error codes
* @enum {string}
*/
export var ApiErrorCode;
(function (ApiErrorCode) {
/** Success */
ApiErrorCode["SUCCESS"] = "00";
/** Invalid username, password or API access */
ApiErrorCode["INVALID_AUTH"] = "30";
/** Invalid header */
ApiErrorCode["INVALID_HEADER"] = "40";
/** Insufficient balance/credit */
ApiErrorCode["INSUFFICIENT_BALANCE"] = "50";
/** System error */
ApiErrorCode["SYSTEM_ERROR"] = "51";
/** Parameter error */
ApiErrorCode["PARAMETER_ERROR"] = "70";
/** Invalid date format */
ApiErrorCode["INVALID_DATE"] = "80";
/** Time error */
ApiErrorCode["TIME_ERROR"] = "85";
/** SMS cancellation error */
ApiErrorCode["CANCEL_ERROR"] = "60";
})(ApiErrorCode || (ApiErrorCode = {}));
/**
* Balance query type codes
* @enum {number}
*/
export var BalanceType;
(function (BalanceType) {
/** Package/campaign information */
BalanceType[BalanceType["PACKAGE"] = 1] = "PACKAGE";
/** Credit information */
BalanceType[BalanceType["CREDIT"] = 2] = "CREDIT";
})(BalanceType || (BalanceType = {}));
/**
* Operator codes
* @enum {number}
*/
export var OperatorCode;
(function (OperatorCode) {
/** Vodafone */
OperatorCode[OperatorCode["VODAFONE"] = 10] = "VODAFONE";
/** Türk Telekom */
OperatorCode[OperatorCode["TURK_TELEKOM"] = 20] = "TURK_TELEKOM";
/** Turkcell */
OperatorCode[OperatorCode["TURKCELL"] = 30] = "TURKCELL";
/** Netgsm STH */
OperatorCode[OperatorCode["NETGSM_STH"] = 40] = "NETGSM_STH";
/** Netgsm Mobil */
OperatorCode[OperatorCode["NETGSM_MOBIL"] = 41] = "NETGSM_MOBIL";
/** Türktelekom Sabit */
OperatorCode[OperatorCode["TURKTELEKOM_SABIT"] = 60] = "TURKTELEKOM_SABIT";
/** Tanımsız Operator */
OperatorCode[OperatorCode["TANIMSIZ"] = 70] = "TANIMSIZ";
/** KKTC Vodafone */
OperatorCode[OperatorCode["KKTC_VODAFONE"] = 160] = "KKTC_VODAFONE";
/** Yurtdışı */
OperatorCode[OperatorCode["YURTDISI_1"] = 212] = "YURTDISI_1";
/** Yurtdışı */
OperatorCode[OperatorCode["YURTDISI_2"] = 213] = "YURTDISI_2";
/** Yurtdışı */
OperatorCode[OperatorCode["YURTDISI_3"] = 214] = "YURTDISI_3";
/** Yurtdışı */
OperatorCode[OperatorCode["YURTDISI_4"] = 215] = "YURTDISI_4";
/** KKTC Turkcell */
OperatorCode[OperatorCode["KKTC_TURKCELL"] = 880] = "KKTC_TURKCELL";
})(OperatorCode || (OperatorCode = {}));