@pddo/firefox-api/dist/types.d.ts

Firefox 接码平台 SDK

/**
 * Firefox 接码平台 API 类型定义
 */
export interface BaseResponse {
    success: boolean;
    data?: string;
    error?: string;
    errorCode?: number;
}
export interface LoginParams {
    ApiName: string;
    PassWord: string;
}
export interface LoginResponse extends BaseResponse {
    token?: string;
}
export interface AccountInfoResponse extends BaseResponse {
    balance?: number;
    level?: number;
    points?: number;
}
export interface GetPhoneParams {
    token: string;
    iid: string;
    country?: string;
    did?: string;
    dock?: '0' | '1';
    maxPrice?: number;
    mobile?: string;
    pushUrl?: string;
}
export interface GetPhoneResponse extends BaseResponse {
    pkey?: string;
    getTime?: string;
    countryCode?: string;
    countryNum?: string;
    location?: string;
    port?: string;
    mobile?: string;
    dockCode?: string;
}
export interface GetMessageParams {
    token: string;
    pkey: string;
}
export interface GetMessageResponse extends BaseResponse {
    sms?: string;
    code?: string;
    time?: string;
}
export interface SendSmsParams {
    token: string;
    pkey: string;
    msg: string;
    voice?: '0' | '1';
}
export interface SendSmsResponse extends BaseResponse {
    sendId?: string;
}
export interface GetSmsStatusParams {
    token: string;
    sendId: string;
}
export interface GetSmsStatusResponse extends BaseResponse {
    status?: string;
}
export interface ReleasePhoneParams {
    token: string;
    pkey: string;
}
export interface BlacklistPhoneParams {
    token: string;
    pkey: string;
    reason: string;
}
export interface ApiReturnParams {
    token: string;
    pkey: string;
    remark: '0' | '-1' | '-2' | '-3' | string;
}
export interface SetAgainParams {
    token: string;
    pkey: string;
    min?: number;
}
export interface GetItemParams {
    key?: string;
}
export interface ItemInfo {
    Item_ID: string;
    Item_Name: string;
    Item_UPrice: number;
    Country_ID: string;
    Country_Title: string;
}
export interface GetItemResponse extends BaseResponse {
    items?: ItemInfo[];
}
export interface FirefoxApiConfig {
    baseUrl?: string;
    timeout?: number;
    retries?: number;
}
export declare const ERROR_CODES: {
    readonly LOGIN_EMPTY_USERNAME: -1;
    readonly LOGIN_USERNAME_LENGTH: -2;
    readonly LOGIN_USERNAME_INVALID_CHAR: -3;
    readonly LOGIN_USERNAME_NO_CHINESE: -4;
    readonly LOGIN_EMPTY_PASSWORD: -5;
    readonly LOGIN_PASSWORD_LENGTH: -6;
    readonly LOGIN_IP_WAIT: -7;
    readonly LOGIN_ACCOUNT_DISABLED: -8;
    readonly LOGIN_WRONG_CREDENTIALS: -9;
    readonly ACCOUNT_TOKEN_NOT_EXIST: -1;
    readonly ACCOUNT_TOKEN_EXPIRED: -2;
    readonly ACCOUNT_REQUEST_TOO_FREQUENT: -3;
    readonly PHONE_NO_AVAILABLE: -1;
    readonly PHONE_TOKEN_NOT_EXIST: -2;
    readonly PHONE_INVALID_PROJECT: -3;
    readonly PHONE_INVALID_COUNTRY: -4;
    readonly PHONE_PROJECT_NOT_APPROVED: -5;
    readonly PHONE_PROJECT_DISABLED: -6;
    readonly PHONE_USER_DISABLED: -7;
    readonly PHONE_INSUFFICIENT_BALANCE: -8;
    readonly PHONE_TOO_MANY_OCCUPIED: -9;
    readonly PHONE_NO_SPECIFY_ALLOWED: -10;
    readonly MESSAGE_TOKEN_NOT_EXIST: -1;
    readonly MESSAGE_INVALID_PKEY: -2;
    readonly MESSAGE_NO_MESSAGE: -3;
    readonly RELEASE_TOKEN_NOT_EXIST: -1;
    readonly RELEASE_INVALID_PKEY: -2;
    readonly RELEASE_PHONE_NOT_EXIST: -3;
    readonly RELEASE_ALREADY_CODED: -4;
    readonly RELEASE_SMS_SUBMITTED: -5;
    readonly RELEASE_EXCEED_LIMIT: -6;
    readonly BLACKLIST_TOKEN_NOT_EXIST: -1;
    readonly BLACKLIST_INVALID_PKEY: -2;
    readonly BLACKLIST_EMPTY_REASON: -3;
    readonly BLACKLIST_PHONE_NOT_EXIST: -4;
    readonly BLACKLIST_NOT_CODED: -5;
    readonly BLACKLIST_PERMISSION_DENIED: -6;
    readonly RETURN_TOKEN_NOT_EXIST: -1;
    readonly RETURN_INVALID_PKEY: -2;
    readonly RETURN_EMPTY_REMARK: -3;
    readonly RETURN_NO_PERMISSION: -4;
    readonly RETURN_NO_API_PERMISSION: -5;
    readonly AGAIN_TOKEN_NOT_EXIST: -1;
    readonly AGAIN_INVALID_PKEY: -2;
    readonly AGAIN_INVALID_MIN: -3;
    readonly AGAIN_PHONE_NOT_EXIST: -4;
    readonly AGAIN_NOT_CODED: -5;
};
export type ErrorCode = typeof ERROR_CODES[keyof typeof ERROR_CODES];
//# sourceMappingURL=types.d.ts.map