@line/bot-sdk

---

@line/bot-sdk / Client

Class: Client

Defined in: lib/client.ts:21

Deprecated

Use clients generated by openapi spec instead.

Constructors

Constructor

new Client(config): Client

Defined in: lib/client.ts:27

Parameters

config

ClientConfig

Returns

Client

Properties

config

config: ClientConfig

Defined in: lib/client.ts:22

Methods

broadcast()

broadcast(messages, notificationDisabled): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:137

Parameters

messages

Message | Message[]

notificationDisabled

boolean = false

Returns

Promise<MessageAPIResponseBase>

---

changeAudienceGroupAuthorityLevel()

changeAudienceGroupAuthorityLevel(authorityLevel): Promise<{ }>

Defined in: lib/client.ts:787

Parameters

authorityLevel

AudienceGroupAuthorityLevel

Returns

Promise<{ }>

---

createClickAudienceGroup()

createClickAudienceGroup(clickAudienceGroup): Promise<object & object>

Defined in: lib/client.ts:694

Parameters

clickAudienceGroup

clickUrl?

string

description

string

requestId

string

Returns

Promise<object & object>

---

createImpAudienceGroup()

createImpAudienceGroup(impAudienceGroup): Promise<object & object>

Defined in: lib/client.ts:711

Parameters

impAudienceGroup

description

string

requestId

string

Returns

Promise<object & object>

---

createRichMenu()

createRichMenu(richMenu): Promise<string>

Defined in: lib/client.ts:367

Parameters

richMenu

RichMenu

Returns

Promise<string>

---

createRichMenuAlias()

createRichMenuAlias(richMenuId, richMenuAliasId): Promise<{ }>

Defined in: lib/client.ts:395

Parameters

richMenuId

string

richMenuAliasId

string

Returns

Promise<{ }>

---

createUploadAudienceGroup()

createUploadAudienceGroup(uploadAudienceGroup): Promise<{ audienceGroupId: number; created: number; description: string; type: string; }>

Defined in: lib/client.ts:620

Parameters

uploadAudienceGroup

audiences?

object[]

description

string

isIfaAudience?

boolean

uploadDescription?

string

Returns

Promise<{ audienceGroupId: number; created: number; description: string; type: string; }>

---

createUploadAudienceGroupByFile()

createUploadAudienceGroupByFile(uploadAudienceGroup): Promise<{ audienceGroupId: number; created: number; description: string; type: "UPLOAD"; }>

Defined in: lib/client.ts:637

Parameters

uploadAudienceGroup

description

string

file

Readable | Buffer<ArrayBufferLike>

isIfaAudience?

boolean

uploadDescription?

string

Returns

Promise<{ audienceGroupId: number; created: number; description: string; type: "UPLOAD"; }>

---

deleteAudienceGroup()

deleteAudienceGroup(audienceGroupId): Promise<{ }>

Defined in: lib/client.ts:740

Parameters

audienceGroupId

string

Returns

Promise<{ }>

---

deleteDefaultRichMenu()

deleteDefaultRichMenu(): Promise<{ }>

Defined in: lib/client.ts:505

Returns

Promise<{ }>

---

deleteRichMenu()

deleteRichMenu(richMenuId): Promise<any>

Defined in: lib/client.ts:375

Parameters

richMenuId

string

Returns

Promise<any>

---

deleteRichMenuAlias()

deleteRichMenuAlias(richMenuAliasId): Promise<{ }>

Defined in: lib/client.ts:409

Parameters

richMenuAliasId

string

Returns

Promise<{ }>

---

getAudienceGroup()

getAudienceGroup(audienceGroupId): Promise<AudienceGroup>

Defined in: lib/client.ts:747

Parameters

audienceGroupId

string

Returns

Promise<AudienceGroup>

---

getAudienceGroupAuthorityLevel()

getAudienceGroupAuthorityLevel(): Promise<{ authorityLevel: AudienceGroupAuthorityLevel; }>

Defined in: lib/client.ts:780

Returns

Promise<{ authorityLevel: AudienceGroupAuthorityLevel; }>

---

getAudienceGroups()

getAudienceGroups(page, description?, status?, size?, createRoute?, includesExternalPublicGroups?): Promise<{ audienceGroups: AudienceGroups; hasNextPage: boolean; page: number; readWriteAudienceGroupTotalCount: number; size: number; totalCount: number; }>

Defined in: lib/client.ts:754

Parameters

page

number

description?

string

status?

AudienceGroupStatus

size?

number

createRoute?

AudienceGroupCreateRoute

includesExternalPublicGroups?

boolean

Returns

Promise<{ audienceGroups: AudienceGroups; hasNextPage: boolean; page: number; readWriteAudienceGroupTotalCount: number; size: number; totalCount: number; }>

---

getBotFollowersIds()

getBotFollowersIds(): Promise<string[]>

Defined in: lib/client.ts:294

Returns

Promise<string[]>

---

getBotInfo()

getBotInfo(): Promise<BotInfoResponse>

Defined in: lib/client.ts:797

Returns

Promise<BotInfoResponse>

---

getDefaultRichMenuId()

getDefaultRichMenuId(): Promise<string>

Defined in: lib/client.ts:498

Returns

Promise<string>

---

getFriendDemographics()

getFriendDemographics(): Promise<FriendDemographics>

Defined in: lib/client.ts:593

Returns

Promise<FriendDemographics>

---

getGroupMemberIds()

getGroupMemberIds(groupId): Promise<string[]>

Defined in: lib/client.ts:286

Parameters

groupId

string

Returns

Promise<string[]>

---

getGroupMemberProfile()

getGroupMemberProfile(groupId, userId): Promise<Profile>

Defined in: lib/client.ts:252

Parameters

groupId

string

userId

string

Returns

Promise<Profile>

---

getGroupMembersCount()

getGroupMembersCount(groupId): Promise<MembersCountResponse>

Defined in: lib/client.ts:311

Parameters

groupId

string

Returns

Promise<MembersCountResponse>

---

getGroupSummary()

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Defined in: lib/client.ts:329

Parameters

groupId

string

Returns

Promise<GroupSummaryResponse>

---

getLinkToken()

getLinkToken(userId): Promise<string>

Defined in: lib/client.ts:509

Parameters

userId

string

Returns

Promise<string>

---

getMessageContent()

getMessageContent(messageId): Promise<Readable>

Defined in: lib/client.ts:338

Parameters

messageId

string

Returns

Promise<Readable>

---

getNarrowcastProgress()

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Defined in: lib/client.ts:543

Parameters

requestId

string

Returns

Promise<NarrowcastProgressResponse>

---

getNumberOfFollowers()

getNumberOfFollowers(date): Promise<NumberOfFollowersResponse>

Defined in: lib/client.ts:584

Parameters

date

string

Returns

Promise<NumberOfFollowersResponse>

---

getNumberOfMessageDeliveries()

getNumberOfMessageDeliveries(date): Promise<NumberOfMessageDeliveriesResponse>

Defined in: lib/client.ts:575

Parameters

date

string

Returns

Promise<NumberOfMessageDeliveriesResponse>

---

getNumberOfMessagesSentThisMonth()

getNumberOfMessagesSentThisMonth(): Promise<NumberOfMessagesSentThisMonth>

Defined in: lib/client.ts:559

Returns

Promise<NumberOfMessagesSentThisMonth>

---

getNumberOfSentBroadcastMessages()

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesSentResponse>

Defined in: lib/client.ts:566

Parameters

date

string

Returns

Promise<NumberOfMessagesSentResponse>

---

getNumberOfSentMulticastMessages()

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesSentResponse>

Defined in: lib/client.ts:534

Parameters

date

string

Returns

Promise<NumberOfMessagesSentResponse>

---

getNumberOfSentPushMessages()

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesSentResponse>

Defined in: lib/client.ts:525

Parameters

date

string

Returns

Promise<NumberOfMessagesSentResponse>

---

getNumberOfSentReplyMessages()

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesSentResponse>

Defined in: lib/client.ts:516

Parameters

date

string

Returns

Promise<NumberOfMessagesSentResponse>

---

getProfile()

getProfile(userId): Promise<Profile>

Defined in: lib/client.ts:234

Parameters

userId

string

Returns

Promise<Profile>

---

getRichMenu()

getRichMenu(richMenuId): Promise<RichMenuResponse>

Defined in: lib/client.ts:358

Parameters

richMenuId

string

Returns

Promise<RichMenuResponse>

---

getRichMenuAlias()

getRichMenuAlias(richMenuAliasId): Promise<GetRichMenuAliasResponse>

Defined in: lib/client.ts:386

Parameters

richMenuAliasId

string

Returns

Promise<GetRichMenuAliasResponse>

---

getRichMenuAliasList()

getRichMenuAliasList(): Promise<GetRichMenuAliasListResponse>

Defined in: lib/client.ts:379

Returns

Promise<GetRichMenuAliasListResponse>

---

getRichMenuIdOfUser()

getRichMenuIdOfUser(userId): Promise<string>

Defined in: lib/client.ts:429

Parameters

userId

string

Returns

Promise<string>

---

getRichMenuImage()

getRichMenuImage(richMenuId): Promise<Readable>

Defined in: lib/client.ts:467

Parameters

richMenuId

string

Returns

Promise<Readable>

---

getRichMenuList()

getRichMenuList(): Promise<RichMenuResponse[]>

Defined in: lib/client.ts:485

Returns

Promise<RichMenuResponse[]>

---

getRoomMemberIds()

getRoomMemberIds(roomId): Promise<string[]>

Defined in: lib/client.ts:290

Parameters

roomId

string

Returns

Promise<string[]>

---

getRoomMemberProfile()

getRoomMemberProfile(roomId, userId): Promise<Profile>

Defined in: lib/client.ts:259

Parameters

roomId

string

userId

string

Returns

Promise<Profile>

---

getRoomMembersCount()

getRoomMembersCount(roomId): Promise<MembersCountResponse>

Defined in: lib/client.ts:320

Parameters

roomId

string

Returns

Promise<MembersCountResponse>

---

getStatisticsPerUnit()

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<StatisticsPerUnit>

Defined in: lib/client.ts:609

Parameters

customAggregationUnit

string

from

string

to

string

Returns

Promise<StatisticsPerUnit>

---

getTargetLimitForAdditionalMessages()

getTargetLimitForAdditionalMessages(): Promise<TargetLimitForAdditionalMessages>

Defined in: lib/client.ts:552

Returns

Promise<TargetLimitForAdditionalMessages>

---

getUserInteractionStatistics()

getUserInteractionStatistics(requestId): Promise<UserInteractionStatistics>

Defined in: lib/client.ts:600

Parameters

requestId

string

Returns

Promise<UserInteractionStatistics>

---

getWebhookEndpointInfo()

getWebhookEndpointInfo(): Promise<WebhookEndpointInfoResponse>

Defined in: lib/client.ts:811

Returns

Promise<WebhookEndpointInfoResponse>

---

leaveGroup()

leaveGroup(groupId): Promise<any>

Defined in: lib/client.ts:350

Parameters

groupId

string

Returns

Promise<any>

---

leaveRoom()

leaveRoom(roomId): Promise<any>

Defined in: lib/client.ts:354

Parameters

roomId

string

Returns

Promise<any>

---

linkRichMenuToMultipleUsers()

linkRichMenuToMultipleUsers(richMenuId, userIds): Promise<any>

Defined in: lib/client.ts:449

Parameters

richMenuId

string

userIds

string[]

Returns

Promise<any>

---

linkRichMenuToUser()

linkRichMenuToUser(userId, richMenuId): Promise<any>

Defined in: lib/client.ts:436

Parameters

userId

string

richMenuId

string

Returns

Promise<any>

---

multicast()

multicast(to, messages, notificationDisabled, customAggregationUnits?): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:99

Parameters

to

string[]

messages

Message | Message[]

notificationDisabled

boolean = false

customAggregationUnits?

string[]

Returns

Promise<MessageAPIResponseBase>

---

narrowcast()

narrowcast(messages, recipient?, filter?, limit?, notificationDisabled?): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:117

Parameters

messages

Message | Message[]

recipient?

ReceieptObject

filter?

demographic

DemographicFilterObject

limit?

max?

number

upToRemainingQuota?

boolean

notificationDisabled?

boolean

Returns

Promise<MessageAPIResponseBase>

---

pushMessage()

pushMessage(to, messages, notificationDisabled, customAggregationUnits?): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:69

Parameters

to

string

messages

Message | Message[]

notificationDisabled

boolean = false

customAggregationUnits?

string[]

Returns

Promise<MessageAPIResponseBase>

---

replyMessage()

replyMessage(replyToken, messages, notificationDisabled): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:87

Parameters

replyToken

string

messages

Message | Message[]

notificationDisabled

boolean = false

Returns

Promise<MessageAPIResponseBase>

---

setDefaultRichMenu()

setDefaultRichMenu(richMenuId): Promise<{ }>

Defined in: lib/client.ts:492

Parameters

richMenuId

string

Returns

Promise<{ }>

---

setDescriptionAudienceGroup()

setDescriptionAudienceGroup(description, audienceGroupId): Promise<{ }>

Defined in: lib/client.ts:727

Parameters

description

string

audienceGroupId

string

Returns

Promise<{ }>

---

setRequestOptionOnce()

setRequestOptionOnce(option): void

Defined in: lib/client.ts:42

Parameters

option

Partial<RequestOption>

Returns

void

---

setRichMenuImage()

setRichMenuImage(richMenuId, data, contentType?): Promise<any>

Defined in: lib/client.ts:473

Parameters

richMenuId

string

data

Readable | Buffer<ArrayBufferLike>

contentType?

string

Returns

Promise<any>

---

setWebhookEndpointUrl()

setWebhookEndpointUrl(endpoint): Promise<{ }>

Defined in: lib/client.ts:804

Parameters

endpoint

string

Returns

Promise<{ }>

---

testWebhookEndpoint()

testWebhookEndpoint(endpoint?): Promise<TestWebhookEndpointResponse>

Defined in: lib/client.ts:818

Parameters

endpoint?

string

Returns

Promise<TestWebhookEndpointResponse>

---

unlinkRichMenuFromUser()

unlinkRichMenuFromUser(userId): Promise<any>

Defined in: lib/client.ts:445

Parameters

userId

string

Returns

Promise<any>

---

unlinkRichMenusFromMultipleUsers()

unlinkRichMenusFromMultipleUsers(userIds): Promise<any>

Defined in: lib/client.ts:459

Parameters

userIds

string[]

Returns

Promise<any>

---

updateRichMenuAlias()

updateRichMenuAlias(richMenuAliasId, richMenuId): Promise<{ }>

Defined in: lib/client.ts:416

Parameters

richMenuAliasId

string

richMenuId

string

Returns

Promise<{ }>

---

updateUploadAudienceGroup()

updateUploadAudienceGroup(uploadAudienceGroup, httpConfig?): Promise<{ }>

Defined in: lib/client.ts:654

Parameters

uploadAudienceGroup

audienceGroupId

number

audiences

object[]

description?

string

uploadDescription?

string

httpConfig?

Partial<AxiosRequestConfig>

Returns

Promise<{ }>

---

updateUploadAudienceGroupByFile()

updateUploadAudienceGroupByFile(uploadAudienceGroup, httpConfig?): Promise<{ }>

Defined in: lib/client.ts:674

Parameters

uploadAudienceGroup

audienceGroupId

number

file

Readable | Buffer<ArrayBufferLike>

uploadDescription?

string

httpConfig?

Partial<AxiosRequestConfig>

Returns

Promise<{ }>

---

validateBroadcastMessageObjects()

validateBroadcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:195

Parameters

messages

Message | Message[]

Returns

Promise<MessageAPIResponseBase>

---

validateCustomAggregationUnits()

validateCustomAggregationUnits(units): object

Defined in: lib/client.ts:207

Parameters

units

string[]

Returns

object

messages

messages: string[]

valid

valid: boolean

---

validateMulticastMessageObjects()

validateMulticastMessageObjects(messages): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:171

Parameters

messages

Message | Message[]

Returns

Promise<MessageAPIResponseBase>

---

validateNarrowcastMessageObjects()

validateNarrowcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:183

Parameters

messages

Message | Message[]

Returns

Promise<MessageAPIResponseBase>

---

validatePushMessageObjects()

validatePushMessageObjects(messages): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:151

Parameters

messages

Message | Message[]

Returns

Promise<MessageAPIResponseBase>

---

validateReplyMessageObjects()

validateReplyMessageObjects(messages): Promise<MessageAPIResponseBase>

Defined in: lib/client.ts:163

Parameters

messages

Message | Message[]

Returns

Promise<MessageAPIResponseBase>

---

validateRichMenu()

validateRichMenu(richMenu): Promise<{ }>

Defined in: lib/client.ts:826

Parameters

richMenu

RichMenu

Returns

Promise<{ }>