@line/bot-sdk / Exports / Client

Class: Client

Deprecated

Use clients generated by openapi spec instead.

Table of contents

Constructors

• constructor

Properties

• config

Methods

• broadcast
• changeAudienceGroupAuthorityLevel
• createClickAudienceGroup
• createImpAudienceGroup
• createRichMenu
• createRichMenuAlias
• createUploadAudienceGroup
• createUploadAudienceGroupByFile
• deleteAudienceGroup
• deleteDefaultRichMenu
• deleteRichMenu
• deleteRichMenuAlias
• getAudienceGroup
• getAudienceGroupAuthorityLevel
• getAudienceGroups
• getBotFollowersIds
• getBotInfo
• getDefaultRichMenuId
• getFriendDemographics
• getGroupMemberIds
• getGroupMemberProfile
• getGroupMembersCount
• getGroupSummary
• getLinkToken
• getMessageContent
• getNarrowcastProgress
• getNumberOfFollowers
• getNumberOfMessageDeliveries
• getNumberOfMessagesSentThisMonth
• getNumberOfSentBroadcastMessages
• getNumberOfSentMulticastMessages
• getNumberOfSentPushMessages
• getNumberOfSentReplyMessages
• getProfile
• getRichMenu
• getRichMenuAlias
• getRichMenuAliasList
• getRichMenuIdOfUser
• getRichMenuImage
• getRichMenuList
• getRoomMemberIds
• getRoomMemberProfile
• getRoomMembersCount
• getStatisticsPerUnit
• getTargetLimitForAdditionalMessages
• getUserInteractionStatistics
• getWebhookEndpointInfo
• leaveGroup
• leaveRoom
• linkRichMenuToMultipleUsers
• linkRichMenuToUser
• multicast
• narrowcast
• pushMessage
• replyMessage
• setDefaultRichMenu
• setDescriptionAudienceGroup
• setRequestOptionOnce
• setRichMenuImage
• setWebhookEndpointUrl
• testWebhookEndpoint
• unlinkRichMenuFromUser
• unlinkRichMenusFromMultipleUsers
• updateRichMenuAlias
• updateUploadAudienceGroup
• updateUploadAudienceGroupByFile
• validateBroadcastMessageObjects
• validateCustomAggregationUnits
• validateMulticastMessageObjects
• validateNarrowcastMessageObjects
• validatePushMessageObjects
• validateReplyMessageObjects
• validateRichMenu

Constructors

constructor

• new Client(config): Client

Parameters

Name	Type
config	ClientConfig

Returns

Client

Defined in

lib/client.ts:27

Properties

config

• config: ClientConfig

Defined in

lib/client.ts:22

Methods

broadcast

▸ broadcast(messages, notificationDisabled?): Promise<MessageAPIResponseBase>

Parameters

Name	Type	Default value
messages	Message | Message[]	undefined
notificationDisabled	boolean	false

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:137

---

changeAudienceGroupAuthorityLevel

▸ changeAudienceGroupAuthorityLevel(authorityLevel): Promise<{}>

Parameters

Name	Type
authorityLevel	AudienceGroupAuthorityLevel

Returns

Promise<{}>

Defined in

lib/client.ts:787

---

createClickAudienceGroup

▸ createClickAudienceGroup(clickAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Parameters

Name	Type
clickAudienceGroup	Object
clickAudienceGroup.clickUrl?	string
clickAudienceGroup.description	string
clickAudienceGroup.requestId	string

Returns

Promise<{ audienceGroupId: number ; created: number ; type: string } & { clickUrl?: string ; description: string ; requestId: string }>

Defined in

lib/client.ts:694

---

createImpAudienceGroup

▸ createImpAudienceGroup(impAudienceGroup): Promise<{ audienceGroupId: number ; created: number ; type: string } & { description: string ; requestId: string }>

Parameters

Name	Type
impAudienceGroup	Object
impAudienceGroup.description	string
impAudienceGroup.requestId	string

Returns

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

Defined in

lib/client.ts:711

---

createRichMenu

▸ createRichMenu(richMenu): Promise<string>

Parameters

Name	Type
richMenu	RichMenu

Returns

Promise<string>

Defined in

lib/client.ts:367

---

createRichMenuAlias

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

Parameters

Name	Type
richMenuId	string
richMenuAliasId	string

Returns

Promise<{}>

Defined in

lib/client.ts:395

---

createUploadAudienceGroup

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

Parameters

Name	Type
uploadAudienceGroup	Object
uploadAudienceGroup.audiences?	{ id: string }[]
uploadAudienceGroup.description	string
uploadAudienceGroup.isIfaAudience?	boolean
uploadAudienceGroup.uploadDescription?	string

Returns

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

Defined in

lib/client.ts:620

---

createUploadAudienceGroupByFile

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

Parameters

Name	Type
uploadAudienceGroup	Object
uploadAudienceGroup.description	string
uploadAudienceGroup.file	Readable | Buffer
uploadAudienceGroup.isIfaAudience?	boolean
uploadAudienceGroup.uploadDescription?	string

Returns

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

Defined in

lib/client.ts:637

---

deleteAudienceGroup

▸ deleteAudienceGroup(audienceGroupId): Promise<{}>

Parameters

Name	Type
audienceGroupId	string

Returns

Promise<{}>

Defined in

lib/client.ts:740

---

deleteDefaultRichMenu

▸ deleteDefaultRichMenu(): Promise<{}>

Returns

Promise<{}>

Defined in

lib/client.ts:505

---

deleteRichMenu

▸ deleteRichMenu(richMenuId): Promise<any>

Parameters

Name	Type
richMenuId	string

Returns

Promise<any>

Defined in

lib/client.ts:375

---

deleteRichMenuAlias

▸ deleteRichMenuAlias(richMenuAliasId): Promise<{}>

Parameters

Name	Type
richMenuAliasId	string

Returns

Promise<{}>

Defined in

lib/client.ts:409

---

getAudienceGroup

▸ getAudienceGroup(audienceGroupId): Promise<AudienceGroup>

Parameters

Name	Type
audienceGroupId	string

Returns

Promise<AudienceGroup>

Defined in

lib/client.ts:747

---

getAudienceGroupAuthorityLevel

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

Returns

Promise<{ authorityLevel: AudienceGroupAuthorityLevel }>

Defined in

lib/client.ts:780

---

getAudienceGroups

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

Parameters

Name	Type
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 }>

Defined in

lib/client.ts:754

---

getBotFollowersIds

▸ getBotFollowersIds(): Promise<string[]>

Returns

Promise<string[]>

Defined in

lib/client.ts:294

---

getBotInfo

▸ getBotInfo(): Promise<BotInfoResponse>

Returns

Promise<BotInfoResponse>

Defined in

lib/client.ts:797

---

getDefaultRichMenuId

▸ getDefaultRichMenuId(): Promise<string>

Returns

Promise<string>

Defined in

lib/client.ts:498

---

getFriendDemographics

▸ getFriendDemographics(): Promise<FriendDemographics>

Returns

Promise<FriendDemographics>

Defined in

lib/client.ts:593

---

getGroupMemberIds

▸ getGroupMemberIds(groupId): Promise<string[]>

Parameters

Name	Type
groupId	string

Returns

Promise<string[]>

Defined in

lib/client.ts:286

---

getGroupMemberProfile

▸ getGroupMemberProfile(groupId, userId): Promise<Profile>

Parameters

Name	Type
groupId	string
userId	string

Returns

Promise<Profile>

Defined in

lib/client.ts:252

---

getGroupMembersCount

▸ getGroupMembersCount(groupId): Promise<MembersCountResponse>

Parameters

Name	Type
groupId	string

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:311

---

getGroupSummary

▸ getGroupSummary(groupId): Promise<GroupSummaryResponse>

Parameters

Name	Type
groupId	string

Returns

Promise<GroupSummaryResponse>

Defined in

lib/client.ts:329

---

getLinkToken

▸ getLinkToken(userId): Promise<string>

Parameters

Name	Type
userId	string

Returns

Promise<string>

Defined in

lib/client.ts:509

---

getMessageContent

▸ getMessageContent(messageId): Promise<Readable>

Parameters

Name	Type
messageId	string

Returns

Promise<Readable>

Defined in

lib/client.ts:338

---

getNarrowcastProgress

▸ getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Parameters

Name	Type
requestId	string

Returns

Promise<NarrowcastProgressResponse>

Defined in

lib/client.ts:543

---

getNumberOfFollowers

▸ getNumberOfFollowers(date): Promise<NumberOfFollowersResponse>

Parameters

Name	Type
date	string

Returns

Promise<NumberOfFollowersResponse>

Defined in

lib/client.ts:584

---

getNumberOfMessageDeliveries

▸ getNumberOfMessageDeliveries(date): Promise<NumberOfMessageDeliveriesResponse>

Parameters

Name	Type
date	string

Returns

Promise<NumberOfMessageDeliveriesResponse>

Defined in

lib/client.ts:575

---

getNumberOfMessagesSentThisMonth

▸ getNumberOfMessagesSentThisMonth(): Promise<NumberOfMessagesSentThisMonth>

Returns

Promise<NumberOfMessagesSentThisMonth>

Defined in

lib/client.ts:559

---

getNumberOfSentBroadcastMessages

▸ getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

Name	Type
date	string

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:566

---

getNumberOfSentMulticastMessages

▸ getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

Name	Type
date	string

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:534

---

getNumberOfSentPushMessages

▸ getNumberOfSentPushMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

Name	Type
date	string

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:525

---

getNumberOfSentReplyMessages

▸ getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesSentResponse>

Parameters

Name	Type
date	string

Returns

Promise<NumberOfMessagesSentResponse>

Defined in

lib/client.ts:516

---

getProfile

▸ getProfile(userId): Promise<Profile>

Parameters

Name	Type
userId	string

Returns

Promise<Profile>

Defined in

lib/client.ts:234

---

getRichMenu

▸ getRichMenu(richMenuId): Promise<RichMenuResponse>

Parameters

Name	Type
richMenuId	string

Returns

Promise<RichMenuResponse>

Defined in

lib/client.ts:358

---

getRichMenuAlias

▸ getRichMenuAlias(richMenuAliasId): Promise<GetRichMenuAliasResponse>

Parameters

Name	Type
richMenuAliasId	string

Returns

Promise<GetRichMenuAliasResponse>

Defined in

lib/client.ts:386

---

getRichMenuAliasList

▸ getRichMenuAliasList(): Promise<GetRichMenuAliasListResponse>

Returns

Promise<GetRichMenuAliasListResponse>

Defined in

lib/client.ts:379

---

getRichMenuIdOfUser

▸ getRichMenuIdOfUser(userId): Promise<string>

Parameters

Name	Type
userId	string

Returns

Promise<string>

Defined in

lib/client.ts:429

---

getRichMenuImage

▸ getRichMenuImage(richMenuId): Promise<Readable>

Parameters

Name	Type
richMenuId	string

Returns

Promise<Readable>

Defined in

lib/client.ts:467

---

getRichMenuList

▸ getRichMenuList(): Promise<RichMenuResponse[]>

Returns

Promise<RichMenuResponse[]>

Defined in

lib/client.ts:485

---

getRoomMemberIds

▸ getRoomMemberIds(roomId): Promise<string[]>

Parameters

Name	Type
roomId	string

Returns

Promise<string[]>

Defined in

lib/client.ts:290

---

getRoomMemberProfile

▸ getRoomMemberProfile(roomId, userId): Promise<Profile>

Parameters

Name	Type
roomId	string
userId	string

Returns

Promise<Profile>

Defined in

lib/client.ts:259

---

getRoomMembersCount

▸ getRoomMembersCount(roomId): Promise<MembersCountResponse>

Parameters

Name	Type
roomId	string

Returns

Promise<MembersCountResponse>

Defined in

lib/client.ts:320

---

getStatisticsPerUnit

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

Parameters

Name	Type
customAggregationUnit	string
from	string
to	string

Returns

Promise<StatisticsPerUnit>

Defined in

lib/client.ts:609

---

getTargetLimitForAdditionalMessages

▸ getTargetLimitForAdditionalMessages(): Promise<TargetLimitForAdditionalMessages>

Returns

Promise<TargetLimitForAdditionalMessages>

Defined in

lib/client.ts:552

---

getUserInteractionStatistics

▸ getUserInteractionStatistics(requestId): Promise<UserInteractionStatistics>

Parameters

Name	Type
requestId	string

Returns

Promise<UserInteractionStatistics>

Defined in

lib/client.ts:600

---

getWebhookEndpointInfo

▸ getWebhookEndpointInfo(): Promise<WebhookEndpointInfoResponse>

Returns

Promise<WebhookEndpointInfoResponse>

Defined in

lib/client.ts:811

---

leaveGroup

▸ leaveGroup(groupId): Promise<any>

Parameters

Name	Type
groupId	string

Returns

Promise<any>

Defined in

lib/client.ts:350

---

leaveRoom

▸ leaveRoom(roomId): Promise<any>

Parameters

Name	Type
roomId	string

Returns

Promise<any>

Defined in

lib/client.ts:354

---

linkRichMenuToMultipleUsers

▸ linkRichMenuToMultipleUsers(richMenuId, userIds): Promise<any>

Parameters

Name	Type
richMenuId	string
userIds	string[]

Returns

Promise<any>

Defined in

lib/client.ts:449

---

linkRichMenuToUser

▸ linkRichMenuToUser(userId, richMenuId): Promise<any>

Parameters

Name	Type
userId	string
richMenuId	string

Returns

Promise<any>

Defined in

lib/client.ts:436

---

multicast

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

Parameters

Name	Type	Default value
to	string[]	undefined
messages	Message | Message[]	undefined
notificationDisabled	boolean	false
customAggregationUnits?	string[]	undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:99

---

narrowcast

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

Parameters

Name	Type
messages	Message | Message[]
recipient?	ReceieptObject
filter?	Object
filter.demographic	DemographicFilterObject
limit?	Object
limit.max?	number
limit.upToRemainingQuota?	boolean
notificationDisabled?	boolean

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:117

---

pushMessage

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

Parameters

Name	Type	Default value
to	string	undefined
messages	Message | Message[]	undefined
notificationDisabled	boolean	false
customAggregationUnits?	string[]	undefined

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:69

---

replyMessage

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

Parameters

Name	Type	Default value
replyToken	string	undefined
messages	Message | Message[]	undefined
notificationDisabled	boolean	false

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:87

---

setDefaultRichMenu

▸ setDefaultRichMenu(richMenuId): Promise<{}>

Parameters

Name	Type
richMenuId	string

Returns

Promise<{}>

Defined in

lib/client.ts:492

---

setDescriptionAudienceGroup

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

Parameters

Name	Type
description	string
audienceGroupId	string

Returns

Promise<{}>

Defined in

lib/client.ts:727

---

setRequestOptionOnce

▸ setRequestOptionOnce(option): void

Parameters

Name	Type
option	Partial<RequestOption>

Returns

void

Defined in

lib/client.ts:42

---

setRichMenuImage

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

Parameters

Name	Type
richMenuId	string
data	Readable | Buffer
contentType?	string

Returns

Promise<any>

Defined in

lib/client.ts:473

---

setWebhookEndpointUrl

▸ setWebhookEndpointUrl(endpoint): Promise<{}>

Parameters

Name	Type
endpoint	string

Returns

Promise<{}>

Defined in

lib/client.ts:804

---

testWebhookEndpoint

▸ testWebhookEndpoint(endpoint?): Promise<TestWebhookEndpointResponse>

Parameters

Name	Type
endpoint?	string

Returns

Promise<TestWebhookEndpointResponse>

Defined in

lib/client.ts:818

---

unlinkRichMenuFromUser

▸ unlinkRichMenuFromUser(userId): Promise<any>

Parameters

Name	Type
userId	string

Returns

Promise<any>

Defined in

lib/client.ts:445

---

unlinkRichMenusFromMultipleUsers

▸ unlinkRichMenusFromMultipleUsers(userIds): Promise<any>

Parameters

Name	Type
userIds	string[]

Returns

Promise<any>

Defined in

lib/client.ts:459

---

updateRichMenuAlias

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

Parameters

Name	Type
richMenuAliasId	string
richMenuId	string

Returns

Promise<{}>

Defined in

lib/client.ts:416

---

updateUploadAudienceGroup

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

Parameters

Name	Type
uploadAudienceGroup	Object
uploadAudienceGroup.audienceGroupId	number
uploadAudienceGroup.audiences	{ id: string }[]
uploadAudienceGroup.description?	string
uploadAudienceGroup.uploadDescription?	string
httpConfig?	Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:654

---

updateUploadAudienceGroupByFile

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

Parameters

Name	Type
uploadAudienceGroup	Object
uploadAudienceGroup.audienceGroupId	number
uploadAudienceGroup.file	Readable | Buffer
uploadAudienceGroup.uploadDescription?	string
httpConfig?	Partial<AxiosRequestConfig<any>>

Returns

Promise<{}>

Defined in

lib/client.ts:674

---

validateBroadcastMessageObjects

▸ validateBroadcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

Name	Type
messages	Message | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:195

---

validateCustomAggregationUnits

▸ validateCustomAggregationUnits(units): Object

Parameters

Name	Type
units	string[]

Returns

Object

Name	Type
messages	string[]
valid	boolean

Defined in

lib/client.ts:207

---

validateMulticastMessageObjects

▸ validateMulticastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

Name	Type
messages	Message | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:171

---

validateNarrowcastMessageObjects

▸ validateNarrowcastMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

Name	Type
messages	Message | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:183

---

validatePushMessageObjects

▸ validatePushMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

Name	Type
messages	Message | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:151

---

validateReplyMessageObjects

▸ validateReplyMessageObjects(messages): Promise<MessageAPIResponseBase>

Parameters

Name	Type
messages	Message | Message[]

Returns

Promise<MessageAPIResponseBase>

Defined in

lib/client.ts:163

---

validateRichMenu

▸ validateRichMenu(richMenu): Promise<{}>

Parameters

Name	Type
richMenu	RichMenu

Returns

Promise<{}>

Defined in

lib/client.ts:826