Class TelegramClient

constructor

• new TelegramClient(tgId, token, baseUrl?, debug?): TelegramClient

• Parameters

  • tgId: string
  • token: string
  • Optional baseUrl: string
  • debug: boolean = true

  Returns TelegramClient

axios

activateService

• activateService(serviceId): Promise<GetDataResponse>

• Parameters

  • serviceId: string

  Returns Promise<GetDataResponse>

avatar

• avatar(phone): Promise<AvatarResult>

• Parameters

  • phone: string

  Returns Promise<AvatarResult>

checkNick

• checkNick(nick): Promise<Record<string, unknown>>

• Parameters

  • nick: string

  Returns Promise<Record<string, unknown>>

checkPhone

• checkPhone(phone): Promise<Record<string, unknown>>

• Parameters

  • phone: string

  Returns Promise<Record<string, unknown>>

clearMessagesQueue

• clearMessagesQueue(): Promise<ClearMessagesQueueResult>

• Returns Promise<ClearMessagesQueueResult>

contacts

• contacts(): Promise<unknown[]>

• Returns Promise<unknown[]>

contactsDeleteDuplicates

• contactsDeleteDuplicates(): Promise<Record<string, unknown>>

• Returns Promise<Record<string, unknown>>

contactsReconciliation

• contactsReconciliation(): Promise<Record<string, unknown>>

• Returns Promise<Record<string, unknown>>

deactivateService

• deactivateService(serviceId): Promise<GetDataResponse>

• Parameters

  • serviceId: string

  Returns Promise<GetDataResponse>

deleteMessage

• deleteMessage(params): Promise<ApiStatusResponse>

• Parameters

  • params: ToMessageParams

  Returns Promise<ApiStatusResponse>

editMessage

• editMessage(params): Promise<ApiStatusResponse>

• Parameters

  • params: EditMessageParams

  Returns Promise<ApiStatusResponse>

getAuthorizePageUrl

• getAuthorizePageUrl(): Promise<AuthorizePageUrlResult>

• Returns Promise<AuthorizePageUrlResult>

getContactById

• getContactById(userId): Promise<Record<string, unknown>>

• Parameters

  • userId: string

  Returns Promise<Record<string, unknown>>

getDialogs

• getDialogs(): Promise<Record<string, unknown>>

• Returns Promise<Record<string, unknown>>

getLastMessageStatus

• getLastMessageStatus(phone, offset?): Promise<LastMessageStatusResult>

• Parameters

  • phone: string
  • Optional offset: number

  Returns Promise<LastMessageStatusResult>

getMessage

• getMessage(messageId, chatId): Promise<Record<string, unknown>>

• Parameters

  • messageId: string
  • chatId: string

  Returns Promise<Record<string, unknown>>

getMessageStatus

• getMessageStatus(messageId): Promise<MessageStatusResult>

• Parameters

  • messageId: string

  Returns Promise<MessageStatusResult>

getStatus

• getStatus(): Promise<InstanceStatus>

• Returns Promise<InstanceStatus>

getTgFlag

• getTgFlag(flag): Promise<GetTgFlagResult>

• Parameters

  • flag: string

  Returns Promise<GetTgFlagResult>

getUserId

• getUserId(to): Promise<GetUserIdResult>

• Parameters

  • to: string

  Returns Promise<GetUserIdResult>

importGroupContacts

• importGroupContacts(params): Promise<ImportGroupContactsResult>

• Parameters

  • params: ImportGroupContactsParams

  Returns Promise<ImportGroupContactsResult>

importSingleContact

• importSingleContact(params): Promise<ImportSingleContactResult>

• Parameters

  • params: ImportSingleContactParams

  Returns Promise<ImportSingleContactResult>

lastImportContact

• lastImportContact(to): Promise<Record<string, unknown>>

• Parameters

  • to: string

  Returns Promise<Record<string, unknown>>

markRead

• markRead(params): Promise<ApiStatusResponse>

• Parameters

  • params: MarkReadParams

  Returns Promise<ApiStatusResponse>

resolvePhone

• resolvePhone(phone): Promise<Record<string, unknown>>

• Parameters

  • phone: string

  Returns Promise<Record<string, unknown>>

sendFile

• sendFile(params): Promise<SendMessageResult>

• Parameters

  • params: SendFileParams

  Returns Promise<SendMessageResult>

sendMessage

• sendMessage(params): Promise<SendMessageResult>

• Parameters

  • params: SendMessageParams

  Returns Promise<SendMessageResult>

setArchive

• setArchive(): Promise<ApiStatusResponse>

• Returns Promise<ApiStatusResponse>

setReaction

• setReaction(params): Promise<ApiStatusResponse>

• Parameters

  • params: SetReactionParams

  Returns Promise<ApiStatusResponse>

showMessagesQueue

• showMessagesQueue(): Promise<ShowMessagesQueueResult>

• Returns Promise<ShowMessagesQueueResult>

unsetReaction

• unsetReaction(params): Promise<ApiStatusResponse>

• Parameters

  • params: ToMessageParams

  Returns Promise<ApiStatusResponse>