Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "types/Request"

Index

Type aliases

AccountActivationCardPayload

AccountActivationCardPayload: { balance_type: BALANCE_TYPES; cardno: string }

Type declaration

GetSMSCostPayload

GetSMSCostPayload: { message: string; recipients: string | string[] }

Type declaration

  • message: string
  • recipients: string | string[]

GetSMSListPayload

GetSMSListPayload: { bulk_id?: undefined | number; date_from?: undefined | string; date_to?: undefined | string; limit?: undefined | number; messages_id?: string | string[]; offset?: undefined | number; recipients?: string[]; sender?: string | string[]; sort?: "asc" | "desc"; status?: undefined | string }

Type declaration

  • Optional bulk_id?: undefined | number
  • Optional date_from?: undefined | string
  • Optional date_to?: undefined | string
  • Optional limit?: undefined | number
  • Optional messages_id?: string | string[]
  • Optional offset?: undefined | number
  • Optional recipients?: string[]
  • Optional sender?: string | string[]
  • Optional sort?: "asc" | "desc"
  • Optional status?: undefined | string

GetSMSStatusPayload

GetSMSStatusPayload: { messages_id: string | string[] }

Type declaration

  • messages_id: string | string[]

Payload

RequestCredentials

RequestCredentials: { apikey: string; devkey?: undefined | string; test?: undefined | false | true; user: string }

Type declaration

  • apikey: string
  • Optional devkey?: undefined | string
  • Optional test?: undefined | false | true
  • user: string

SendSMSPayload

SendSMSPayload: { message: string; recipients: string | string[]; sender: string; sendtime?: undefined | string; urgent?: 0 | 1 }

Type declaration

  • message: string
  • recipients: string | string[]
  • sender: string
  • Optional sendtime?: undefined | string
  • Optional urgent?: 0 | 1

SubmitParams

SubmitParams: { method: METHODS; path: string; payload?: Payload }

Type declaration

Generated using TypeDoc