@line/bot-sdk

@line/bot-sdk

Version 11.2.0
Published 21 days ago
3.99 MB
1 dependency
Apache-2.0 license

Install

npm i @line/bot-sdk

yarn add @line/bot-sdk

pnpm add @line/bot-sdk

Overview

Node.js SDK for LINE Messaging API

Index

Variables

variable LINE_REQUEST_ID_HTTP_HEADER_NAME

const LINE_REQUEST_ID_HTTP_HEADER_NAME: string;

variable LINE_SIGNATURE_HTTP_HEADER_NAME

const LINE_SIGNATURE_HTTP_HEADER_NAME: string;

Functions

function middleware

middleware: (config: Types.MiddlewareConfig) => Middleware;

function validateSignature

validateSignature: (
    body: string | Buffer,
    channelSecret: string,
    signature: string
) => boolean;

Classes

class HTTPFetchError

class HTTPFetchError extends Error {}

constructor

constructor(
    message: string,
    { status, statusText, headers, body }: FetchErrorDetails
);

property body

body: string;

property headers

headers: Headers;

property status

status: number;

property statusText

statusText: string;

class JSONParseError

class JSONParseError extends Error {}

constructor

constructor(message: string, { raw }?: ErrorDetails);

property raw

raw: any;

class LineBotClient

class LineBotClient extends LineBotClientBase {}

A single client for all LINE Bot APIs, except channel access token management.
Wraps all individual API clients (Messaging API, LIFF, Insight, etc.) and exposes their methods directly, so you don't need to manage multiple client instances. For channel access token operations, use channelAccessToken.ChannelAccessTokenClient directly.
Example 1
const client = LineBotClient.fromChannelAccessToken({ channelAccessToken: "..." });
Example 2
Push a message to a user
await client.pushMessage({ to: userId, messages: [{ type: "text", text: "Hi there!" }], });
Example 3
Get a user's profile
const profile = await client.getProfile(userId); console.log(profile.displayName);

property clients

protected readonly clients: LineBotClientDelegates;

method fromChannelAccessToken

static fromChannelAccessToken: (
    config: LineBotClientChannelAccessTokenConfig
) => LineBotClient;

class SignatureValidationFailed

class SignatureValidationFailed extends Error {}

constructor

constructor(message: string, { signature }?: ErrorDetails);

property signature

signature?: string;

Interfaces

interface ApiResponseType

interface ApiResponseType<T> {}

property body

body: T;

property httpResponse

httpResponse: Response;

interface LineBotClientChannelAccessTokenConfig

interface LineBotClientChannelAccessTokenConfig extends LineBotClientCommonConfig {}

Configuration for LineBotClient using a channel access token.

Example 1

const client = LineBotClient.fromChannelAccessToken({
  channelAccessToken: "YOUR_CHANNEL_ACCESS_TOKEN",
});

property channelAccessToken

readonly channelAccessToken: string;

Channel access token issued for your LINE Official Account.

interface MiddlewareConfig

interface MiddlewareConfig {}

property channelSecret

channelSecret: string;

property skipSignatureVerification

skipSignatureVerification?: () => boolean;

Type Aliases

type MessageAPIResponseBase

type MessageAPIResponseBase = {
    [LINE_REQUEST_ID_HTTP_HEADER_NAME]?: string;
};

Namespaces

namespace channelAccessToken

module 'dist/channel-access-token/api.d.ts' {}

class ChannelAccessTokenClient

class ChannelAccessTokenClient {}

constructor

constructor(config: httpClientConfig);

Initializes a new ChannelAccessTokenClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://api.line.me.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new ChannelAccessTokenClient({ });

method getsAllValidChannelAccessTokenKeyIds

getsAllValidChannelAccessTokenKeyIds: (
    clientAssertionType: string,
    clientAssertion: string
) => Promise<ChannelAccessTokenKeyIdsResponse>;

Gets all valid channel access token key IDs. Calls GET https://api.line.me/oauth2/v2.1/tokens/kid. To inspect the HTTP status code or response headers, use getsAllValidChannelAccessTokenKeyIdsWithHttpInfo.
Parameter clientAssertionType
urn:ietf:params:oauth:client-assertion-type:jwt-bearer
Parameter clientAssertion
A JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getsAllValidChannelAccessTokenKeyIdsWithHttpInfo

getsAllValidChannelAccessTokenKeyIdsWithHttpInfo: (
    clientAssertionType: string,
    clientAssertion: string
) => Promise<Types.ApiResponseType<ChannelAccessTokenKeyIdsResponse>>;

Gets all valid channel access token key IDs. Calls GET https://api.line.me/oauth2/v2.1/tokens/kid. This method returns the response body together with the underlying httpResponse.
Parameter clientAssertionType
urn:ietf:params:oauth:client-assertion-type:jwt-bearer
Parameter clientAssertion
A JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method issueChannelToken

issueChannelToken: (
    grantType: string,
    clientId: string,
    clientSecret: string
) => Promise<IssueShortLivedChannelAccessTokenResponse>;

Issue short-lived channel access token Calls POST https://api.line.me/v2/oauth/accessToken. To inspect the HTTP status code or response headers, use issueChannelTokenWithHttpInfo.
Parameter grantType
client_credentials
Parameter clientId
Channel ID.
Parameter clientSecret
Channel secret.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method issueChannelTokenByJWT

issueChannelTokenByJWT: (
    grantType: string,
    clientAssertionType: string,
    clientAssertion: string
) => Promise<IssueChannelAccessTokenResponse>;

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication. Calls POST https://api.line.me/oauth2/v2.1/token. To inspect the HTTP status code or response headers, use issueChannelTokenByJWTWithHttpInfo.
Parameter grantType
client_credentials
Parameter clientAssertionType
urn:ietf:params:oauth:client-assertion-type:jwt-bearer
Parameter clientAssertion
A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method issueChannelTokenByJWTWithHttpInfo

issueChannelTokenByJWTWithHttpInfo: (
    grantType: string,
    clientAssertionType: string,
    clientAssertion: string
) => Promise<Types.ApiResponseType<IssueChannelAccessTokenResponse>>;

Issues a channel access token that allows you to specify a desired expiration date. This method lets you use JWT assertion for authentication. Calls POST https://api.line.me/oauth2/v2.1/token. This method returns the response body together with the underlying httpResponse.
Parameter grantType
client_credentials
Parameter clientAssertionType
urn:ietf:params:oauth:client-assertion-type:jwt-bearer
Parameter clientAssertion
A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method issueChannelTokenWithHttpInfo

issueChannelTokenWithHttpInfo: (
    grantType: string,
    clientId: string,
    clientSecret: string
) => Promise<Types.ApiResponseType<IssueShortLivedChannelAccessTokenResponse>>;

Issue short-lived channel access token Calls POST https://api.line.me/v2/oauth/accessToken. This method returns the response body together with the underlying httpResponse.
Parameter grantType
client_credentials
Parameter clientId
Channel ID.
Parameter clientSecret
Channel secret.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method issueStatelessChannelToken

issueStatelessChannelToken: (
    grantType?: string,
    clientAssertionType?: string,
    clientAssertion?: string,
    clientId?: string,
    clientSecret?: string
) => Promise<IssueStatelessChannelAccessTokenResponse>;

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. Calls POST https://api.line.me/oauth2/v3/token. To inspect the HTTP status code or response headers, use issueStatelessChannelTokenWithHttpInfo.
Parameter grantType
client_credentials
Parameter clientAssertionType
URL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
Parameter clientAssertion
A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
Parameter clientId
Channel ID.
Parameter clientSecret
Channel secret.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation
Deprecated
Use issueStatelessChannelTokenByJWTAssertion or issueStatelessChannelTokenByClientSecret instead.

method issueStatelessChannelTokenByClientSecret

issueStatelessChannelTokenByClientSecret: (
    clientId: string,
    clientSecret: string
) => Promise<IssueStatelessChannelAccessTokenResponse>;

Issues a new stateless channel access token by client secret. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. Calls POST https://api.line.me/oauth2/v3/token. To inspect the HTTP status code or response headers, use issueStatelessChannelTokenByClientSecretWithHttpInfo.
Parameter clientId
Channel ID.
Parameter clientSecret
Channel secret.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method issueStatelessChannelTokenByClientSecretWithHttpInfo

issueStatelessChannelTokenByClientSecretWithHttpInfo: (
    clientId: string,
    clientSecret: string
) => Promise<Types.ApiResponseType<IssueStatelessChannelAccessTokenResponse>>;

Issues a new stateless channel access token by client secret. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. Calls POST https://api.line.me/oauth2/v3/token. This method returns the response body together with the underlying httpResponse.
Parameter clientId
Channel ID.
Parameter clientSecret
Channel secret.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method issueStatelessChannelTokenByJWTAssertion

issueStatelessChannelTokenByJWTAssertion: (
    clientAssertion: string
) => Promise<IssueStatelessChannelAccessTokenResponse>;

Issues a new stateless channel access token by JWT assertion. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. Calls POST https://api.line.me/oauth2/v3/token. To inspect the HTTP status code or response headers, use issueStatelessChannelTokenByJWTAssertionWithHttpInfo.
Parameter clientAssertion
A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method issueStatelessChannelTokenByJWTAssertionWithHttpInfo

issueStatelessChannelTokenByJWTAssertionWithHttpInfo: (
    clientAssertion: string
) => Promise<Types.ApiResponseType<IssueStatelessChannelAccessTokenResponse>>;

Issues a new stateless channel access token by JWT assertion. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. Calls POST https://api.line.me/oauth2/v3/token. This method returns the response body together with the underlying httpResponse.
Parameter clientAssertion
A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method issueStatelessChannelTokenWithHttpInfo

issueStatelessChannelTokenWithHttpInfo: (
    grantType?: string,
    clientAssertionType?: string,
    clientAssertion?: string,
    clientId?: string,
    clientSecret?: string
) => Promise<Types.ApiResponseType<IssueStatelessChannelAccessTokenResponse>>;

Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires. Calls POST https://api.line.me/oauth2/v3/token. This method returns the response body together with the underlying httpResponse.
Parameter grantType
client_credentials
Parameter clientAssertionType
URL-encoded value of urn:ietf:params:oauth:client-assertion-type:jwt-bearer
Parameter clientAssertion
A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
Parameter clientId
Channel ID.
Parameter clientSecret
Channel secret.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation
Deprecated
Use issueStatelessChannelTokenByJWTAssertionWithHttpInfo or issueStatelessChannelTokenByClientSecretWithHttpInfo instead.

method revokeChannelToken

revokeChannelToken: (
    accessToken: string
) => Promise<Types.MessageAPIResponseBase>;

Revoke short-lived or long-lived channel access token Calls POST https://api.line.me/v2/oauth/revoke. To inspect the HTTP status code or response headers, use revokeChannelTokenWithHttpInfo.
Parameter accessToken
A short-lived or long-lived channel access token.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method revokeChannelTokenByJWT

revokeChannelTokenByJWT: (
    clientId: string,
    clientSecret: string,
    accessToken: string
) => Promise<Types.MessageAPIResponseBase>;

Revoke channel access token v2.1 Calls POST https://api.line.me/oauth2/v2.1/revoke. To inspect the HTTP status code or response headers, use revokeChannelTokenByJWTWithHttpInfo.
Parameter clientId
Channel ID
Parameter clientSecret
Channel Secret
Parameter accessToken
Channel access token
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method revokeChannelTokenByJWTWithHttpInfo

revokeChannelTokenByJWTWithHttpInfo: (
    clientId: string,
    clientSecret: string,
    accessToken: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Revoke channel access token v2.1 Calls POST https://api.line.me/oauth2/v2.1/revoke. This method returns the response body together with the underlying httpResponse.
Parameter clientId
Channel ID
Parameter clientSecret
Channel Secret
Parameter accessToken
Channel access token
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method revokeChannelTokenWithHttpInfo

revokeChannelTokenWithHttpInfo: (
    accessToken: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Revoke short-lived or long-lived channel access token Calls POST https://api.line.me/v2/oauth/revoke. This method returns the response body together with the underlying httpResponse.
Parameter accessToken
A short-lived or long-lived channel access token.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method verifyChannelToken

verifyChannelToken: (
    accessToken: string
) => Promise<VerifyChannelAccessTokenResponse>;

Verify the validity of short-lived and long-lived channel access tokens Calls POST https://api.line.me/v2/oauth/verify. To inspect the HTTP status code or response headers, use verifyChannelTokenWithHttpInfo.
Parameter accessToken
A short-lived or long-lived channel access token.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method verifyChannelTokenByJWT

verifyChannelTokenByJWT: (
    accessToken: string
) => Promise<VerifyChannelAccessTokenResponse>;

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid. Calls GET https://api.line.me/oauth2/v2.1/verify. To inspect the HTTP status code or response headers, use verifyChannelTokenByJWTWithHttpInfo.
Parameter accessToken
Channel access token with a user-specified expiration (Channel Access Token v2.1).
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method verifyChannelTokenByJWTWithHttpInfo

verifyChannelTokenByJWTWithHttpInfo: (
    accessToken: string
) => Promise<Types.ApiResponseType<VerifyChannelAccessTokenResponse>>;

You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid. Calls GET https://api.line.me/oauth2/v2.1/verify. This method returns the response body together with the underlying httpResponse.
Parameter accessToken
Channel access token with a user-specified expiration (Channel Access Token v2.1).
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method verifyChannelTokenWithHttpInfo

verifyChannelTokenWithHttpInfo: (
    accessToken: string
) => Promise<Types.ApiResponseType<VerifyChannelAccessTokenResponse>>;

Verify the validity of short-lived and long-lived channel access tokens Calls POST https://api.line.me/v2/oauth/verify. This method returns the response body together with the underlying httpResponse.
Parameter accessToken
A short-lived or long-lived channel access token.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

type ChannelAccessTokenKeyIdsResponse

type ChannelAccessTokenKeyIdsResponse = {
    /**
     * Array of channel access token key IDs.
     */
    kids: Array<string>;
};

Channel access token key IDs
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-all-valid-channel-access-token-key-ids-v2-1

type ErrorResponse

type ErrorResponse = {
    /**
     * Error summary
     */
    error?: string;
    /**
     * Details of the error. Not returned in certain situations.
     */
    error_description?: string;
};

Error response of the Channel access token
See Also
- https://developers.line.biz/en/reference/messaging-api/#error-responses

type IssueChannelAccessTokenResponse

type IssueChannelAccessTokenResponse = {
    /**
     * Channel access token.
     */
    access_token: string;
    /**
     * Amount of time in seconds from issue to expiration of the channel access token
     */
    expires_in: number;
    /**
     * A token type.
     * Default: 'Bearer'
     */
    token_type: string;
    /**
     * Unique key ID for identifying the channel access token.
     */
    key_id: string;
};

Issued channel access token
See Also
- https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token-v2-1

type IssueShortLivedChannelAccessTokenResponse

type IssueShortLivedChannelAccessTokenResponse = {
    /**
     * A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed.
     */
    access_token: string;
    /**
     * Time until channel access token expires in seconds from time the token is issued.
     */
    expires_in: number;
    /**
     * Token type. The value is always `Bearer`.
     * Default: 'Bearer'
     */
    token_type: string;
};

Issued short-lived channel access token
See Also
- https://developers.line.biz/en/reference/messaging-api/#issue-shortlived-channel-access-token

type IssueStatelessChannelAccessTokenResponse

type IssueStatelessChannelAccessTokenResponse = {
    /**
     * A stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token.
     */
    access_token: string;
    /**
     * Duration in seconds after which the issued access token expires
     */
    expires_in: number;
    /**
     * Token type. The value is always `Bearer`.
     * Default: 'Bearer'
     */
    token_type: string;
};

Issued stateless channel access token
See Also
- https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token

type VerifyChannelAccessTokenResponse

type VerifyChannelAccessTokenResponse = {
    /**
     * The channel ID for which the channel access token was issued.
     */
    client_id: string;
    /**
     * Number of seconds before the channel access token expires.
     */
    expires_in: number;
    /**
     * Permissions granted to the channel access token.
     */
    scope?: string;
};

Verification result
See Also
- https://developers.line.biz/en/reference/messaging-api/#verify-channel-access-token-v2-1

namespace insight

module 'dist/insight/api.d.ts' {}

class InsightClient

class InsightClient {}

See Also
- LineBotClient for a unified interface that wraps this client.

constructor

constructor(config: httpClientConfig);

Initializes a new InsightClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://api.line.me.
Parameter
config.channelAccessToken The channel access token used for authorization.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new InsightClient({ channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!, });

method getFriendsDemographics

getFriendsDemographics: () => Promise<GetFriendsDemographicsResponse>;

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID). Calls GET https://api.line.me/v2/bot/insight/demographic. To inspect the HTTP status code or response headers, use getFriendsDemographicsWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getFriendsDemographicsWithHttpInfo

getFriendsDemographicsWithHttpInfo: () => Promise<
    Types.ApiResponseType<GetFriendsDemographicsResponse>
>;

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID). Calls GET https://api.line.me/v2/bot/insight/demographic. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getMessageEvent

getMessageEvent: (requestId: string) => Promise<GetMessageEventResponse>;

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. Calls GET https://api.line.me/v2/bot/insight/message/event. To inspect the HTTP status code or response headers, use getMessageEventWithHttpInfo. Get user interaction statistics
Parameter requestId
Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getMessageEventWithHttpInfo

getMessageEventWithHttpInfo: (
    requestId: string
) => Promise<Types.ApiResponseType<GetMessageEventResponse>>;

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. Calls GET https://api.line.me/v2/bot/insight/message/event. This method returns the response body together with the underlying httpResponse. Get user interaction statistics
Parameter requestId
Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getNumberOfFollowers

getNumberOfFollowers: (date?: string) => Promise<GetNumberOfFollowersResponse>;

Returns the number of users who have added the LINE Official Account on or before a specified date. Calls GET https://api.line.me/v2/bot/insight/followers. To inspect the HTTP status code or response headers, use getNumberOfFollowersWithHttpInfo. Get number of followers
Parameter date
Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getNumberOfFollowersWithHttpInfo

getNumberOfFollowersWithHttpInfo: (
    date?: string
) => Promise<Types.ApiResponseType<GetNumberOfFollowersResponse>>;

Returns the number of users who have added the LINE Official Account on or before a specified date. Calls GET https://api.line.me/v2/bot/insight/followers. This method returns the response body together with the underlying httpResponse. Get number of followers
Parameter date
Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getNumberOfMessageDeliveries

getNumberOfMessageDeliveries: (
    date: string
) => Promise<GetNumberOfMessageDeliveriesResponse>;

Returns the number of messages sent from LINE Official Account on a specified day. Calls GET https://api.line.me/v2/bot/insight/message/delivery. To inspect the HTTP status code or response headers, use getNumberOfMessageDeliveriesWithHttpInfo. Get number of message deliveries
Parameter date
Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getNumberOfMessageDeliveriesWithHttpInfo

getNumberOfMessageDeliveriesWithHttpInfo: (
    date: string
) => Promise<Types.ApiResponseType<GetNumberOfMessageDeliveriesResponse>>;

Returns the number of messages sent from LINE Official Account on a specified day. Calls GET https://api.line.me/v2/bot/insight/message/delivery. This method returns the response body together with the underlying httpResponse. Get number of message deliveries
Parameter date
Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRichMenuInsightDaily

getRichMenuInsightDaily: (
    richMenuId: string,
    from: string,
    to: string
) => Promise<GetRichMenuInsightDailyResponse>;

Gets rich menu statistics broken down by day for the specified period, for a rich menu created via the Messaging API. Returns the daily impression count for the whole rich menu and the daily click count for each tappable area. When the total number of unique clicks during the period is below the privacy threshold, only richMenuId is returned and the other fields are omitted. Calls GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/daily. To inspect the HTTP status code or response headers, use getRichMenuInsightDailyWithHttpInfo. Get rich menu insight daily
Parameter richMenuId
ID of the rich menu created via the Messaging API.
Parameter from
Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9
Parameter to
End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRichMenuInsightDailyWithHttpInfo

getRichMenuInsightDailyWithHttpInfo: (
    richMenuId: string,
    from: string,
    to: string
) => Promise<Types.ApiResponseType<GetRichMenuInsightDailyResponse>>;

Gets rich menu statistics broken down by day for the specified period, for a rich menu created via the Messaging API. Returns the daily impression count for the whole rich menu and the daily click count for each tappable area. When the total number of unique clicks during the period is below the privacy threshold, only richMenuId is returned and the other fields are omitted. Calls GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/daily. This method returns the response body together with the underlying httpResponse. Get rich menu insight daily
Parameter richMenuId
ID of the rich menu created via the Messaging API.
Parameter from
Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9
Parameter to
End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRichMenuInsightSummary

getRichMenuInsightSummary: (
    richMenuId: string,
    from: string,
    to: string
) => Promise<GetRichMenuInsightSummaryResponse>;

Gets a summary of rich menu statistics for the specified period, for a rich menu created via the Messaging API. Returns the total impression count for the whole rich menu and the click count for each tappable area, aggregated over the entire period as a single result. When the total number of unique clicks during the period is below the privacy threshold, only richMenuId is returned and the other fields are omitted. Calls GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/summary. To inspect the HTTP status code or response headers, use getRichMenuInsightSummaryWithHttpInfo. Get rich menu insight summary
Parameter richMenuId
ID of the rich menu created via the Messaging API.
Parameter from
Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9
Parameter to
End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRichMenuInsightSummaryWithHttpInfo

getRichMenuInsightSummaryWithHttpInfo: (
    richMenuId: string,
    from: string,
    to: string
) => Promise<Types.ApiResponseType<GetRichMenuInsightSummaryResponse>>;

Gets a summary of rich menu statistics for the specified period, for a rich menu created via the Messaging API. Returns the total impression count for the whole rich menu and the click count for each tappable area, aggregated over the entire period as a single result. When the total number of unique clicks during the period is below the privacy threshold, only richMenuId is returned and the other fields are omitted. Calls GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/summary. This method returns the response body together with the underlying httpResponse. Get rich menu insight summary
Parameter richMenuId
ID of the rich menu created via the Messaging API.
Parameter from
Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9
Parameter to
End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getStatisticsPerUnit

getStatisticsPerUnit: (
    customAggregationUnit: string,
    from: string,
    to: string
) => Promise<GetStatisticsPerUnitResponse>;

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. Calls GET https://api.line.me/v2/bot/insight/message/event/aggregation. To inspect the HTTP status code or response headers, use getStatisticsPerUnitWithHttpInfo.
Parameter customAggregationUnit
Name of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
Parameter from
Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
Parameter to
End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getStatisticsPerUnitWithHttpInfo

getStatisticsPerUnitWithHttpInfo: (
    customAggregationUnit: string,
    from: string,
    to: string
) => Promise<Types.ApiResponseType<GetStatisticsPerUnitResponse>>;

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. Calls GET https://api.line.me/v2/bot/insight/message/event/aggregation. This method returns the response body together with the underlying httpResponse.
Parameter customAggregationUnit
Name of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.
Parameter from
Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
Parameter to
End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

type AgeTile

type AgeTile = {
    /**
     * users' age
     */
    age?: AgeTile.AgeEnum;
    /**
     * Percentage
     */
    percentage?: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-demographic

type AppTypeTile

type AppTypeTile = {
    /**
     * users' OS
     */
    appType?: AppTypeTile.AppTypeEnum;
    /**
     * Percentage
     */
    percentage?: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-demographic

type AreaTile

type AreaTile = {
    /**
     * users' country and region
     */
    area?: string;
    /**
     * Percentage
     */
    percentage?: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-demographic

type ErrorDetail

type ErrorDetail = {
    /**
     * Details of the error. Not included in the response under certain situations.
     */
    message?: string;
    /**
     * Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.
     */
    property?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#error-responses

type ErrorResponse

type ErrorResponse = {
    /**
     * Message containing information about the error.
     */
    message: string;
    /**
     * An array of error details. If the array is empty, this property will not be included in the response.
     */
    details?: Array<ErrorDetail>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#error-responses

type GenderTile

type GenderTile = {
    /**
     * users' gender
     */
    gender?: GenderTile.GenderEnum;
    /**
     * Percentage
     */
    percentage?: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-demographic

type GetFriendsDemographicsResponse

type GetFriendsDemographicsResponse = {
    /**
     * true if friend demographic information is available.
     */
    available?: boolean;
    /**
     * Percentage per gender.
     */
    genders?: Array<GenderTile>;
    /**
     * Percentage per age group.
     */
    ages?: Array<AgeTile>;
    /**
     * Percentage per area.
     */
    areas?: Array<AreaTile>;
    /**
     * Percentage by OS.
     */
    appTypes?: Array<AppTypeTile>;
    /**
     * Percentage per friendship duration.
     */
    subscriptionPeriods?: Array<SubscriptionPeriodTile>;
};

Get friend demographics
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-demographic

type GetMessageEventResponse

type GetMessageEventResponse = {
    overview?: GetMessageEventResponseOverview;
    /**
     * Array of information about individual message bubbles.
     */
    messages?: Array<GetMessageEventResponseMessage>;
    /**
     * Array of information about opened URLs in the message.
     */
    clicks?: Array<GetMessageEventResponseClick>;
};

Statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response

type GetMessageEventResponseClick

type GetMessageEventResponseClick = {
    /**
     * The URL's serial number.
     */
    seq?: number;
    /**
     * URL.
     */
    url?: string;
    /**
     * Number of times the URL was opened.
     */
    click?: number | null;
    /**
     * Number of users that opened the URL.
     */
    uniqueClick?: number | null;
    /**
     * Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
     */
    uniqueClickOfRequest?: number | null;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response

type GetMessageEventResponseMessage

type GetMessageEventResponseMessage = {
    /**
     * Bubble's serial number.
     */
    seq?: number;
    /**
     * Number of times the bubble was displayed.
     */
    impression?: number | null;
    /**
     * Number of times audio or video in the bubble started playing.
     */
    mediaPlayed?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 25% of the total time.
     */
    mediaPlayed25Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 50% of the total time.
     */
    mediaPlayed50Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 75% of the total time.
     */
    mediaPlayed75Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 100% of the total time.
     */
    mediaPlayed100Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble.
     */
    uniqueMediaPlayed?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 25% of the total time.
     */
    uniqueMediaPlayed25Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 50% of the total time.
     */
    uniqueMediaPlayed50Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 75% of the total time.
     */
    uniqueMediaPlayed75Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 100% of the total time.
     */
    uniqueMediaPlayed100Percent?: number | null;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response

type GetMessageEventResponseOverview

type GetMessageEventResponseOverview = {
    /**
     * Request ID.
     */
    requestId?: string;
    /**
     * UNIX timestamp for message delivery time in seconds.
     */
    timestamp?: number;
    /**
     * Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null.
     */
    delivered?: number;
    /**
     * Number of users who opened the message, meaning they displayed at least 1 bubble.
     */
    uniqueImpression?: number | null;
    /**
     * Number of users who opened any URL in the message.
     */
    uniqueClick?: number | null;
    /**
     * Number of users who started playing any video or audio in the message.
     */
    uniqueMediaPlayed?: number | null;
    /**
     * Number of users who played the entirety of any video or audio in the message.
     */
    uniqueMediaPlayed100Percent?: number | null;
};

Summary of message statistics.
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-insight-message-event-response

type GetNumberOfFollowersResponse

type GetNumberOfFollowersResponse = {
    /**
     * Calculation status.
     */
    status?: GetNumberOfFollowersResponse.StatusEnum;
    /**
     * The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account.
     */
    followers?: number;
    /**
     * The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty.
     */
    targetedReaches?: number;
    /**
     * The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account.
     */
    blocks?: number;
};

Get number of followers
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers

type GetNumberOfMessageDeliveriesResponse

type GetNumberOfMessageDeliveriesResponse = {
    /**
     * Status of the counting process.
     */
    status?: GetNumberOfMessageDeliveriesResponse.StatusEnum;
    /**
     * Number of messages sent to all of this LINE Official Account's friends (broadcast messages).
     */
    broadcast?: number;
    /**
     * Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages).
     */
    targeting?: number;
    /**
     * Number of auto-response messages sent.
     */
    autoResponse?: number;
    /**
     * Number of greeting messages sent.
     */
    welcomeResponse?: number;
    /**
     * Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese).
     */
    chat?: number;
    /**
     * Number of broadcast messages sent with the `Send broadcast message` Messaging API operation.
     */
    apiBroadcast?: number;
    /**
     * Number of push messages sent with the `Send push message` Messaging API operation.
     */
    apiPush?: number;
    /**
     * Number of multicast messages sent with the `Send multicast message` Messaging API operation.
     */
    apiMulticast?: number;
    /**
     * Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation.
     */
    apiNarrowcast?: number;
    /**
     * Number of replies sent with the `Send reply message` Messaging API operation.
     */
    apiReply?: number;
};

Get number of message deliveries
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages

type GetRichMenuInsightDailyResponse

type GetRichMenuInsightDailyResponse = {
    /**
     * Rich menu ID.
     */
    richMenuId: string;
    /**
     * Start date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260213).
     * Pattern: /^[0-9]{8}$/
     */
    metricsFrom?: string | null;
    /**
     * End date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260215).
     * Pattern: /^[0-9]{8}$/
     */
    metricsTo?: string | null;
    impression?: GetRichMenuInsightDailyResponseImpression;
    /**
     * Daily click metrics for each tappable area of the rich menu.
     */
    clicks?: Array<GetRichMenuInsightDailyResponseClick>;
};

Daily impression and click statistics for a rich menu created via the Messaging API.

type GetRichMenuInsightDailyResponseBounds

type GetRichMenuInsightDailyResponseBounds = {
    /**
     * The x coordinate of the top-left corner of the target area.
     */
    x: number;
    /**
     * The y coordinate of the top-left corner of the target area.
     */
    y: number;
    /**
     * The width of the target area.
     */
    width: number;
    /**
     * The height of the target area.
     */
    height: number;
};

Target area of the metrics, represented by the top-left coordinate, width, and height.

type GetRichMenuInsightDailyResponseClick

type GetRichMenuInsightDailyResponseClick = {
    bounds: GetRichMenuInsightDailyResponseBounds;
    /**
     * Per-day click metrics for the target area.
     */
    metrics: Array<GetRichMenuInsightDailyResponseDailyMetrics>;
};

Daily click metrics for a single tappable area of the rich menu.

type GetRichMenuInsightDailyResponseDailyMetrics

type GetRichMenuInsightDailyResponseDailyMetrics = {
    /**
     * The date (JST) of these metrics. Format: yyyyMMdd (e.g. 20260213).
     * Pattern: /^[0-9]{8}$/
     */
    date: string;
    /**
     * Number of impressions or clicks on this day.
     */
    count: number;
    /**
     * Approximate number of unique users who triggered an impression or click on this day.
     */
    uniqueUsers: number;
};

Aggregated number of events and unique users for a single day.

type GetRichMenuInsightDailyResponseImpression

type GetRichMenuInsightDailyResponseImpression = {
    /**
     * Per-day impression metrics.
     */
    metrics: Array<GetRichMenuInsightDailyResponseDailyMetrics>;
};

Daily impression metrics for the whole rich menu.

type GetRichMenuInsightSummaryResponse

type GetRichMenuInsightSummaryResponse = {
    /**
     * Rich menu ID.
     */
    richMenuId: string;
    /**
     * Start date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260213).
     * Pattern: /^[0-9]{8}$/
     */
    metricsFrom?: string | null;
    /**
     * End date (JST) of the period actually covered by the returned metrics. Format: yyyyMMdd (e.g. 20260215).
     * Pattern: /^[0-9]{8}$/
     */
    metricsTo?: string | null;
    impression?: GetRichMenuInsightSummaryResponseImpression;
    /**
     * Click metrics for each tappable area of the rich menu.
     */
    clicks?: Array<GetRichMenuInsightSummaryResponseClick>;
};

Summary of impression and click statistics for a rich menu created via the Messaging API.

type GetRichMenuInsightSummaryResponseBounds

type GetRichMenuInsightSummaryResponseBounds = {
    /**
     * The x coordinate of the top-left corner of the target area.
     */
    x: number;
    /**
     * The y coordinate of the top-left corner of the target area.
     */
    y: number;
    /**
     * The width of the target area.
     */
    width: number;
    /**
     * The height of the target area.
     */
    height: number;
};

Target area of the metrics, represented by the top-left coordinate, width, and height.

type GetRichMenuInsightSummaryResponseClick

type GetRichMenuInsightSummaryResponseClick = {
    bounds: GetRichMenuInsightSummaryResponseBounds;
    metrics: GetRichMenuInsightSummaryResponseMetrics;
};

Click metrics for a single tappable area of the rich menu.

type GetRichMenuInsightSummaryResponseImpression

type GetRichMenuInsightSummaryResponseImpression = {
    metrics: GetRichMenuInsightSummaryResponseMetrics;
};

Impression metrics for the whole rich menu.

type GetRichMenuInsightSummaryResponseMetrics

type GetRichMenuInsightSummaryResponseMetrics = {
    /**
     * Number of impressions or clicks.
     */
    count: number;
    /**
     * Approximate number of unique users who triggered an impression or click.
     */
    uniqueUsers: number;
};

Aggregated number of events and unique users over the whole period.

type GetStatisticsPerUnitResponse

type GetStatisticsPerUnitResponse = {
    overview: GetStatisticsPerUnitResponseOverview;
    /**
     * Array of information about individual message bubbles.
     */
    messages: Array<GetStatisticsPerUnitResponseMessage>;
    /**
     * Array of information about opened URLs in the message.
     */
    clicks: Array<GetStatisticsPerUnitResponseClick>;
};

Response object for get statistics per unit
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit-response

type GetStatisticsPerUnitResponseClick

type GetStatisticsPerUnitResponseClick = {
    /**
     * The URL's serial number.
     */
    seq: number;
    /**
     * URL.
     */
    url: string;
    /**
     * Number of times the URL in the bubble was opened.
     */
    click?: number | null;
    /**
     * Number of users that opened the URL in the bubble.
     */
    uniqueClick?: number | null;
    /**
     * Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once.
     */
    uniqueClickOfRequest?: number | null;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit-response

type GetStatisticsPerUnitResponseMessage

type GetStatisticsPerUnitResponseMessage = {
    /**
     * Bubble's serial number.
     */
    seq: number;
    /**
     * Number of times the bubble was displayed.
     */
    impression?: number | null;
    /**
     * Number of times audio or video in the bubble started playing.
     */
    mediaPlayed?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 25% of the total time.
     */
    mediaPlayed25Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 50% of the total time.
     */
    mediaPlayed50Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 75% of the total time.
     */
    mediaPlayed75Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 100% of the total time.
     */
    mediaPlayed100Percent?: number | null;
    /**
     * Number of users the bubble was displayed.
     */
    uniqueImpression?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble.
     */
    uniqueMediaPlayed?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 25% of the total time.
     */
    uniqueMediaPlayed25Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 50% of the total time.
     */
    uniqueMediaPlayed50Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 75% of the total time.
     */
    uniqueMediaPlayed75Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 100% of the total time.
     */
    uniqueMediaPlayed100Percent?: number | null;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit-response

type GetStatisticsPerUnitResponseOverview

type GetStatisticsPerUnitResponseOverview = {
    /**
     * Number of users who opened the message, meaning they displayed at least 1 bubble.
     */
    uniqueImpression?: number | null;
    /**
     * Number of users who opened any URL in the message.
     */
    uniqueClick?: number | null;
    /**
     * Number of users who started playing any video or audio in the message.
     */
    uniqueMediaPlayed?: number | null;
    /**
     * Number of users who played the entirety of any video or audio in the message.
     */
    uniqueMediaPlayed100Percent?: number | null;
};

Statistics related to messages.
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit-response

type SubscriptionPeriodTile

type SubscriptionPeriodTile = {
    /**
     * Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc.
     */
    subscriptionPeriod?: SubscriptionPeriodTile.SubscriptionPeriodEnum;
    /**
     * Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6.
     */
    percentage?: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-demographic

namespace insight.AgeTile

namespace insight.AgeTile {}

type AgeEnum

type AgeEnum =
    | 'from0to14'
    | 'from15to19'
    | 'from20to24'
    | 'from25to29'
    | 'from30to34'
    | 'from35to39'
    | 'from40to44'
    | 'from45to49'
    | 'from50'
    | 'from50to54'
    | 'from55to59'
    | 'from60to64'
    | 'from65to69'
    | 'from70'
    | 'unknown';

namespace insight.AppTypeTile

namespace insight.AppTypeTile {}

type AppTypeEnum

type AppTypeEnum = 'ios' | 'android' | 'others';

namespace insight.GenderTile

namespace insight.GenderTile {}

type GenderEnum

type GenderEnum = 'male' | 'female' | 'unknown';

namespace insight.GetNumberOfFollowersResponse

namespace insight.GetNumberOfFollowersResponse {}

type StatusEnum

type StatusEnum = 'ready' | 'unready' | 'out_of_service';

namespace insight.GetNumberOfMessageDeliveriesResponse

namespace insight.GetNumberOfMessageDeliveriesResponse {}

type StatusEnum

type StatusEnum = 'ready' | 'unready' | 'out_of_service';

namespace insight.SubscriptionPeriodTile

namespace insight.SubscriptionPeriodTile {}

type SubscriptionPeriodEnum

type SubscriptionPeriodEnum =
    | 'within7days'
    | 'within30days'
    | 'within90days'
    | 'within180days'
    | 'within365days'
    | 'over365days'
    | 'unknown';

namespace liff

module 'dist/liff/api.d.ts' {}

class LiffClient

class LiffClient {}

See Also
- LineBotClient for a unified interface that wraps this client.

constructor

constructor(config: httpClientConfig);

Initializes a new LiffClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://api.line.me.
Parameter
config.channelAccessToken The channel access token used for authorization.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new LiffClient({ channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!, });

method addLIFFApp

addLIFFApp: (
    addLiffAppRequest: AddLiffAppRequest
) => Promise<AddLiffAppResponse>;

Adding the LIFF app to a channel Calls POST https://api.line.me/liff/v1/apps. To inspect the HTTP status code or response headers, use addLIFFAppWithHttpInfo. Create LIFF app
Parameter addLiffAppRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method addLIFFAppWithHttpInfo

addLIFFAppWithHttpInfo: (
    addLiffAppRequest: AddLiffAppRequest
) => Promise<Types.ApiResponseType<AddLiffAppResponse>>;

Adding the LIFF app to a channel Calls POST https://api.line.me/liff/v1/apps. This method returns the response body together with the underlying httpResponse. Create LIFF app
Parameter addLiffAppRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method deleteLIFFApp

deleteLIFFApp: (liffId: string) => Promise<Types.MessageAPIResponseBase>;

Deletes a LIFF app from a channel. Calls DELETE https://api.line.me/liff/v1/apps/{liffId}. To inspect the HTTP status code or response headers, use deleteLIFFAppWithHttpInfo. Delete LIFF app from a channel
Parameter liffId
ID of the LIFF app to be updated
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method deleteLIFFAppWithHttpInfo

deleteLIFFAppWithHttpInfo: (
    liffId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Deletes a LIFF app from a channel. Calls DELETE https://api.line.me/liff/v1/apps/{liffId}. This method returns the response body together with the underlying httpResponse. Delete LIFF app from a channel
Parameter liffId
ID of the LIFF app to be updated
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getAllLIFFApps

getAllLIFFApps: () => Promise<GetAllLiffAppsResponse>;

Gets information on all the LIFF apps added to the channel. Calls GET https://api.line.me/liff/v1/apps. To inspect the HTTP status code or response headers, use getAllLIFFAppsWithHttpInfo. Get all LIFF apps
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getAllLIFFAppsWithHttpInfo

getAllLIFFAppsWithHttpInfo: () => Promise<
    Types.ApiResponseType<GetAllLiffAppsResponse>
>;

Gets information on all the LIFF apps added to the channel. Calls GET https://api.line.me/liff/v1/apps. This method returns the response body together with the underlying httpResponse. Get all LIFF apps
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method updateLIFFApp

updateLIFFApp: (
    liffId: string,
    updateLiffAppRequest: UpdateLiffAppRequest
) => Promise<Types.MessageAPIResponseBase>;

Update LIFF app settings Calls PUT https://api.line.me/liff/v1/apps/{liffId}. To inspect the HTTP status code or response headers, use updateLIFFAppWithHttpInfo. Update LIFF app from a channel
Parameter liffId
ID of the LIFF app to be updated
Parameter updateLiffAppRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method updateLIFFAppWithHttpInfo

updateLIFFAppWithHttpInfo: (
    liffId: string,
    updateLiffAppRequest: UpdateLiffAppRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Update LIFF app settings Calls PUT https://api.line.me/liff/v1/apps/{liffId}. This method returns the response body together with the underlying httpResponse. Update LIFF app from a channel
Parameter liffId
ID of the LIFF app to be updated
Parameter updateLiffAppRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

type AddLiffAppRequest

type AddLiffAppRequest = {
    view: LiffView;
    /**
     * Name of the LIFF app.  The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings.
     */
    description?: string;
    features?: LiffFeatures;
    /**
     * How additional information in LIFF URLs is handled. Specify `concat`.
     */
    permanentLinkPattern?: string;
    scope?: Array<LiffScope>;
    botPrompt?: LiffBotPrompt;
};

See Also
- https://developers.line.biz/en/reference/liff-server/#add-liff-app

type AddLiffAppResponse

type AddLiffAppResponse = {
    liffId: string;
};

See Also
- https://developers.line.biz/en/reference/liff-server/#add-liff-app

type GetAllLiffAppsResponse

type GetAllLiffAppsResponse = {
    apps?: Array<LiffApp>;
};

See Also
- https://developers.line.biz/en/reference/liff-server/#get-all-liff-apps

type LiffApp

type LiffApp = {
    /**
     * LIFF app ID
     */
    liffId?: string;
    view?: LiffView;
    /**
     * Name of the LIFF app
     */
    description?: string;
    features?: LiffFeatures;
    /**
     * How additional information in LIFF URLs is handled. concat is returned.
     */
    permanentLinkPattern?: string;
    scope?: Array<LiffScope>;
    botPrompt?: LiffBotPrompt;
};

See Also
- https://developers.line.biz/en/reference/liff-server/#get-all-liff-apps

type LiffBotPrompt

type LiffBotPrompt = 'normal' | 'aggressive' | 'none';

Specify the setting for bot link feature with one of the following values: normal: Display the option to add the LINE Official Account as a friend in the channel consent screen. aggressive: Display a screen with the option to add the LINE Official Account as a friend after the channel consent screen. none: Don't display the option to add the LINE Official Account as a friend. The default value is none.

type LiffFeatures

type LiffFeatures = {
    /**
     * `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise.
     */
    ble?: boolean;
    /**
     * `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`.
     * Default: false
     */
    qrCode?: boolean;
};

See Also
- https://developers.line.biz/en/reference/liff-server/#get-all-liff-apps

type LiffScope

type LiffScope = 'openid' | 'email' | 'profile' | 'chat_message.write';

Array of scopes required for some LIFF SDK methods to function. The default value is [\"profile\", \"chat_message.write\"].

type LiffView

type LiffView = {
    /**
     * Size of the LIFF app view. Specify one of these values: - compact - tall - full
     */
    type: LiffView.TypeEnum;
    /**
     * Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified.
     */
    url: string;
    /**
     * `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed.
     */
    moduleMode?: boolean;
};

See Also
- https://developers.line.biz/en/reference/liff-server/#add-liff-app

type UpdateLiffAppRequest

type UpdateLiffAppRequest = {
    view?: UpdateLiffView;
    /**
     * Name of the LIFF app.  The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings.
     */
    description?: string;
    features?: LiffFeatures;
    /**
     * How additional information in LIFF URLs is handled. Specify `concat`.
     */
    permanentLinkPattern?: string;
    scope?: Array<LiffScope>;
    botPrompt?: LiffBotPrompt;
};

See Also
- https://developers.line.biz/en/reference/liff-server/#add-liff-app

type UpdateLiffView

type UpdateLiffView = {
    /**
     * Size of the LIFF app view. Specify one of these values: - compact - tall - full
     */
    type?: UpdateLiffView.TypeEnum;
    /**
     * Endpoint URL. This is the URL of the web app that implements the LIFF app (e.g. https://example.com). Used when the LIFF app is launched using the LIFF URL. The URL scheme must be https. URL fragments (#URL-fragment) can't be specified.
     */
    url?: string;
    /**
     * `true` to use the LIFF app in modular mode. When in modular mode, the action button in the header is not displayed.
     */
    moduleMode?: boolean;
};

See Also
- https://developers.line.biz/en/reference/liff-server/#update-liff-app

namespace liff.AddLiffAppRequest

namespace liff.AddLiffAppRequest {}

namespace liff.LiffApp

namespace liff.LiffApp {}

namespace liff.LiffView

namespace liff.LiffView {}

type TypeEnum

type TypeEnum = 'compact' | 'tall' | 'full';

namespace liff.UpdateLiffAppRequest

namespace liff.UpdateLiffAppRequest {}

namespace liff.UpdateLiffView

namespace liff.UpdateLiffView {}

type TypeEnum

type TypeEnum = 'compact' | 'tall' | 'full';

namespace manageAudience

module 'dist/manage-audience/api.d.ts' {}

class ManageAudienceBlobClient

class ManageAudienceBlobClient {}

See Also
- LineBotClient for a unified interface that wraps this client.

constructor

constructor(config: httpClientConfig);

Initializes a new ManageAudienceBlobClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://api-data.line.me.
Parameter
config.channelAccessToken The channel access token used for authorization.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new ManageAudienceBlobClient({ channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!, });

method addUserIdsToAudience

addUserIdsToAudience: (
    file: Blob,
    audienceGroupId?: number,
    uploadDescription?: string
) => Promise<Types.MessageAPIResponseBase>;

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file). Calls PUT https://api-data.line.me/v2/bot/audienceGroup/upload/byFile. To inspect the HTTP status code or response headers, use addUserIdsToAudienceWithHttpInfo.
Parameter file
A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
Parameter audienceGroupId
The audience ID.
Parameter uploadDescription
The description to register with the job
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method addUserIdsToAudienceWithHttpInfo

addUserIdsToAudienceWithHttpInfo: (
    file: Blob,
    audienceGroupId?: number,
    uploadDescription?: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file). Calls PUT https://api-data.line.me/v2/bot/audienceGroup/upload/byFile. This method returns the response body together with the underlying httpResponse.
Parameter file
A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
Parameter audienceGroupId
The audience ID.
Parameter uploadDescription
The description to register with the job
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method createAudienceForUploadingUserIds

createAudienceForUploadingUserIds: (
    file: Blob,
    description?: string,
    isIfaAudience?: boolean,
    uploadDescription?: string
) => Promise<CreateAudienceGroupResponse>;

Create audience for uploading user IDs (by file). Calls POST https://api-data.line.me/v2/bot/audienceGroup/upload/byFile. To inspect the HTTP status code or response headers, use createAudienceForUploadingUserIdsWithHttpInfo.
Parameter file
A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
Parameter description
The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
Parameter isIfaAudience
To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
Parameter uploadDescription
The description to register for the job (in jobs[].description).
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method createAudienceForUploadingUserIdsWithHttpInfo

createAudienceForUploadingUserIdsWithHttpInfo: (
    file: Blob,
    description?: string,
    isIfaAudience?: boolean,
    uploadDescription?: string
) => Promise<Types.ApiResponseType<CreateAudienceGroupResponse>>;

Create audience for uploading user IDs (by file). Calls POST https://api-data.line.me/v2/bot/audienceGroup/upload/byFile. This method returns the response body together with the underlying httpResponse.
Parameter file
A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
Parameter description
The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
Parameter isIfaAudience
To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
Parameter uploadDescription
The description to register for the job (in jobs[].description).
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

class ManageAudienceClient

class ManageAudienceClient {}

See Also
- LineBotClient for a unified interface that wraps this client.

constructor

constructor(config: httpClientConfig);

Initializes a new ManageAudienceClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://api.line.me.
Parameter
config.channelAccessToken The channel access token used for authorization.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new ManageAudienceClient({ channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!, });

method addAudienceToAudienceGroup

addAudienceToAudienceGroup: (
    addAudienceToAudienceGroupRequest: AddAudienceToAudienceGroupRequest
) => Promise<Types.MessageAPIResponseBase>;

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON) Calls PUT https://api.line.me/v2/bot/audienceGroup/upload. To inspect the HTTP status code or response headers, use addAudienceToAudienceGroupWithHttpInfo.
Parameter addAudienceToAudienceGroupRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method addAudienceToAudienceGroupWithHttpInfo

addAudienceToAudienceGroupWithHttpInfo: (
    addAudienceToAudienceGroupRequest: AddAudienceToAudienceGroupRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON) Calls PUT https://api.line.me/v2/bot/audienceGroup/upload. This method returns the response body together with the underlying httpResponse.
Parameter addAudienceToAudienceGroupRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method createAudienceGroup

createAudienceGroup: (
    createAudienceGroupRequest: CreateAudienceGroupRequest
) => Promise<CreateAudienceGroupResponse>;

Create audience for uploading user IDs (by JSON) Calls POST https://api.line.me/v2/bot/audienceGroup/upload. To inspect the HTTP status code or response headers, use createAudienceGroupWithHttpInfo.
Parameter createAudienceGroupRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method createAudienceGroupWithHttpInfo

createAudienceGroupWithHttpInfo: (
    createAudienceGroupRequest: CreateAudienceGroupRequest
) => Promise<Types.ApiResponseType<CreateAudienceGroupResponse>>;

Create audience for uploading user IDs (by JSON) Calls POST https://api.line.me/v2/bot/audienceGroup/upload. This method returns the response body together with the underlying httpResponse.
Parameter createAudienceGroupRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method createClickBasedAudienceGroup

createClickBasedAudienceGroup: (
    createClickBasedAudienceGroupRequest: CreateClickBasedAudienceGroupRequest
) => Promise<CreateClickBasedAudienceGroupResponse>;

Create audience for click-based retargeting Calls POST https://api.line.me/v2/bot/audienceGroup/click. To inspect the HTTP status code or response headers, use createClickBasedAudienceGroupWithHttpInfo.
Parameter createClickBasedAudienceGroupRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method createClickBasedAudienceGroupWithHttpInfo

createClickBasedAudienceGroupWithHttpInfo: (
    createClickBasedAudienceGroupRequest: CreateClickBasedAudienceGroupRequest
) => Promise<Types.ApiResponseType<CreateClickBasedAudienceGroupResponse>>;

Create audience for click-based retargeting Calls POST https://api.line.me/v2/bot/audienceGroup/click. This method returns the response body together with the underlying httpResponse.
Parameter createClickBasedAudienceGroupRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method createImpBasedAudienceGroup

createImpBasedAudienceGroup: (
    createImpBasedAudienceGroupRequest: CreateImpBasedAudienceGroupRequest
) => Promise<CreateImpBasedAudienceGroupResponse>;

Create audience for impression-based retargeting Calls POST https://api.line.me/v2/bot/audienceGroup/imp. To inspect the HTTP status code or response headers, use createImpBasedAudienceGroupWithHttpInfo.
Parameter createImpBasedAudienceGroupRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method createImpBasedAudienceGroupWithHttpInfo

createImpBasedAudienceGroupWithHttpInfo: (
    createImpBasedAudienceGroupRequest: CreateImpBasedAudienceGroupRequest
) => Promise<Types.ApiResponseType<CreateImpBasedAudienceGroupResponse>>;

Create audience for impression-based retargeting Calls POST https://api.line.me/v2/bot/audienceGroup/imp. This method returns the response body together with the underlying httpResponse.
Parameter createImpBasedAudienceGroupRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method deleteAudienceGroup

deleteAudienceGroup: (
    audienceGroupId: number
) => Promise<Types.MessageAPIResponseBase>;

Delete audience Calls DELETE https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}. To inspect the HTTP status code or response headers, use deleteAudienceGroupWithHttpInfo.
Parameter audienceGroupId
The audience ID.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method deleteAudienceGroupWithHttpInfo

deleteAudienceGroupWithHttpInfo: (
    audienceGroupId: number
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Delete audience Calls DELETE https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}. This method returns the response body together with the underlying httpResponse.
Parameter audienceGroupId
The audience ID.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getAudienceData

getAudienceData: (audienceGroupId: number) => Promise<GetAudienceDataResponse>;

Gets audience data. Calls GET https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}. To inspect the HTTP status code or response headers, use getAudienceDataWithHttpInfo.
Parameter audienceGroupId
The audience ID.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getAudienceDataWithHttpInfo

getAudienceDataWithHttpInfo: (
    audienceGroupId: number
) => Promise<Types.ApiResponseType<GetAudienceDataResponse>>;

Gets audience data. Calls GET https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}. This method returns the response body together with the underlying httpResponse.
Parameter audienceGroupId
The audience ID.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getAudienceGroups

getAudienceGroups: (
    page: number,
    description?: string,
    status?: AudienceGroupStatus,
    size?: number,
    includesExternalPublicGroups?: boolean,
    createRoute?: AudienceGroupCreateRoute
) => Promise<GetAudienceGroupsResponse>;

Gets data for more than one audience. Calls GET https://api.line.me/v2/bot/audienceGroup/list. To inspect the HTTP status code or response headers, use getAudienceGroupsWithHttpInfo.
Parameter page
The page to return when getting (paginated) results. Must be 1 or higher.
Parameter description
The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
Parameter status
The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
Parameter size
The number of audiences per page. Default: 20 Max: 40
Parameter includesExternalPublicGroups
true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
Parameter createRoute
How the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getAudienceGroupsWithHttpInfo

getAudienceGroupsWithHttpInfo: (
    page: number,
    description?: string,
    status?: AudienceGroupStatus,
    size?: number,
    includesExternalPublicGroups?: boolean,
    createRoute?: AudienceGroupCreateRoute
) => Promise<Types.ApiResponseType<GetAudienceGroupsResponse>>;

Gets data for more than one audience. Calls GET https://api.line.me/v2/bot/audienceGroup/list. This method returns the response body together with the underlying httpResponse.
Parameter page
The page to return when getting (paginated) results. Must be 1 or higher.
Parameter description
The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
Parameter status
The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
Parameter size
The number of audiences per page. Default: 20 Max: 40
Parameter includesExternalPublicGroups
true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
Parameter createRoute
How the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getSharedAudienceData

getSharedAudienceData: (
    audienceGroupId: number
) => Promise<GetSharedAudienceDataResponse>;

Gets audience data. Calls GET https://api.line.me/v2/bot/audienceGroup/shared/{audienceGroupId}. To inspect the HTTP status code or response headers, use getSharedAudienceDataWithHttpInfo.
Parameter audienceGroupId
The audience ID.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getSharedAudienceDataWithHttpInfo

getSharedAudienceDataWithHttpInfo: (
    audienceGroupId: number
) => Promise<Types.ApiResponseType<GetSharedAudienceDataResponse>>;

Gets audience data. Calls GET https://api.line.me/v2/bot/audienceGroup/shared/{audienceGroupId}. This method returns the response body together with the underlying httpResponse.
Parameter audienceGroupId
The audience ID.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getSharedAudienceGroups

getSharedAudienceGroups: (
    page: number,
    description?: string,
    status?: AudienceGroupStatus,
    size?: number,
    createRoute?: AudienceGroupCreateRoute,
    includesOwnedAudienceGroups?: boolean
) => Promise<GetSharedAudienceGroupsResponse>;

Gets data for more than one audience, including those shared by the Business Manager. Calls GET https://api.line.me/v2/bot/audienceGroup/shared/list. To inspect the HTTP status code or response headers, use getSharedAudienceGroupsWithHttpInfo.
Parameter page
The page to return when getting (paginated) results. Must be 1 or higher.
Parameter description
The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
Parameter status
The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
Parameter size
The number of audiences per page. Default: 20 Max: 40
Parameter createRoute
How the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.
Parameter includesOwnedAudienceGroups
true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getSharedAudienceGroupsWithHttpInfo

getSharedAudienceGroupsWithHttpInfo: (
    page: number,
    description?: string,
    status?: AudienceGroupStatus,
    size?: number,
    createRoute?: AudienceGroupCreateRoute,
    includesOwnedAudienceGroups?: boolean
) => Promise<Types.ApiResponseType<GetSharedAudienceGroupsResponse>>;

Gets data for more than one audience, including those shared by the Business Manager. Calls GET https://api.line.me/v2/bot/audienceGroup/shared/list. This method returns the response body together with the underlying httpResponse.
Parameter page
The page to return when getting (paginated) results. Must be 1 or higher.
Parameter description
The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
Parameter status
The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
Parameter size
The number of audiences per page. Default: 20 Max: 40
Parameter createRoute
How the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.
Parameter includesOwnedAudienceGroups
true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method updateAudienceGroupDescription

updateAudienceGroupDescription: (
    audienceGroupId: number,
    updateAudienceGroupDescriptionRequest: UpdateAudienceGroupDescriptionRequest
) => Promise<Types.MessageAPIResponseBase>;

Renames an existing audience. Calls PUT https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}/updateDescription. To inspect the HTTP status code or response headers, use updateAudienceGroupDescriptionWithHttpInfo.
Parameter audienceGroupId
The audience ID.
Parameter updateAudienceGroupDescriptionRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method updateAudienceGroupDescriptionWithHttpInfo

updateAudienceGroupDescriptionWithHttpInfo: (
    audienceGroupId: number,
    updateAudienceGroupDescriptionRequest: UpdateAudienceGroupDescriptionRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Renames an existing audience. Calls PUT https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}/updateDescription. This method returns the response body together with the underlying httpResponse.
Parameter audienceGroupId
The audience ID.
Parameter updateAudienceGroupDescriptionRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

type Adaccount

type Adaccount = {
    /**
     * Ad account name.
     */
    name?: string;
};

Adaccount

type AddAudienceToAudienceGroupRequest

type AddAudienceToAudienceGroupRequest = {
    /**
     * The audience ID.
     */
    audienceGroupId?: number;
    /**
     * The audience's name.
     */
    uploadDescription?: string;
    /**
     * An array of up to 10,000 user IDs or IFAs.
     * Maximum items: 10000
     */
    audiences?: Array<Audience>;
};

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
See Also
- https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group

type Audience

type Audience = {
    /**
     * A user ID or IFA. You can specify an empty array.
     */
    id?: string;
};

Audience

type AudienceGroup

type AudienceGroup = {
    /**
     * The audience ID.
     */
    audienceGroupId?: number;
    type?: AudienceGroupType;
    /**
     * The audience's name.
     */
    description?: string;
    status?: AudienceGroupStatus;
    failedType?: AudienceGroupFailedType | null;
    /**
     * The number of users included in the audience.
     */
    audienceCount?: number;
    /**
     * When the audience was created (in UNIX time).
     */
    created?: number;
    /**
     * The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP.
     */
    requestId?: string;
    /**
     * The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified.
     */
    clickUrl?: string;
    /**
     * The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs.
     */
    isIfaAudience?: boolean;
    permission?: AudienceGroupPermission;
    createRoute?: AudienceGroupCreateRoute;
};

Audience group

type AudienceGroupCreateRoute

type AudienceGroupCreateRoute =
    | 'OA_MANAGER'
    | 'MESSAGING_API'
    | 'POINT_AD'
    | 'AD_MANAGER';

How the audience was created. One of: - OA_MANAGER: Audience created with [LINE Official Account Manager](https://manager.line.biz/). - MESSAGING_API: Audience created with Messaging API. - POINT_AD: Audience created with [LINE Points Ads](https://www.linebiz.com/jp/service/line-point-ad/) (Japanese only). - AD_MANAGER: Audience created with [LINE Ads](https://admanager.line.biz/).

type AudienceGroupFailedType

type AudienceGroupFailedType =
    | 'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'
    | 'INTERNAL_ERROR';

Failed type

type AudienceGroupJob

type AudienceGroupJob = {
    /**
     * A job ID.
     */
    audienceGroupJobId?: number;
    /**
     * An audience ID.
     */
    audienceGroupId?: number;
    /**
     * The job's description.
     */
    description?: string;
    type?: AudienceGroupJobType;
    jobStatus?: AudienceGroupJobStatus;
    failedType?: AudienceGroupJobFailedType;
    /**
     * The number of accounts (recipients) that were added or removed.
     */
    audienceCount?: number;
    /**
     * When the job was created (in UNIX time).
     */
    created?: number;
};

Audience group job
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-audience-group

type AudienceGroupJobFailedType

type AudienceGroupJobFailedType =
    | 'INTERNAL_ERROR'
    | 'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT';

Failed type

type AudienceGroupJobStatus

type AudienceGroupJobStatus = 'QUEUED' | 'WORKING' | 'FINISHED' | 'FAILED';

Job status

type AudienceGroupJobType

type AudienceGroupJobType = 'DIFF_ADD';

Job Type

type AudienceGroupPermission

type AudienceGroupPermission = 'READ' | 'READ_WRITE';

Permission

type AudienceGroupStatus

type AudienceGroupStatus =
    | 'IN_PROGRESS'
    | 'READY'
    | 'FAILED'
    | 'EXPIRED'
    | 'INACTIVE'
    | 'ACTIVATING';

Status

type AudienceGroupType

type AudienceGroupType =
    | 'UPLOAD'
    | 'CLICK'
    | 'IMP'
    | 'CHAT_TAG'
    | 'FRIEND_PATH'
    | 'RESERVATION'
    | 'APP_EVENT'
    | 'VIDEO_VIEW'
    | 'WEBTRAFFIC'
    | 'IMAGE_CLICK'
    | 'RICHMENU_IMP'
    | 'RICHMENU_CLICK'
    | 'POP_AD_IMP'
    | 'TRACKINGTAG_WEBTRAFFIC';

Audience group type

type CreateAudienceGroupRequest

type CreateAudienceGroupRequest = {
    /**
     * The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
     * Maximum length: 120
     */
    description?: string;
    /**
     * To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
     */
    isIfaAudience?: boolean;
    /**
     * The description to register for the job (in jobs[].description).
     */
    uploadDescription?: string;
    /**
     * An array of user IDs or IFAs. Max number: 10,000
     * Maximum items: 10000
     */
    audiences?: Array<Audience>;
};

Create audience for uploading user IDs (by JSON)
See Also
- https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group

type CreateAudienceGroupResponse

type CreateAudienceGroupResponse = {
    /**
     * The audience ID.
     */
    audienceGroupId?: number;
    /**
     * How the audience was created.  `MESSAGING_API`: An audience created with Messaging API.
     */
    createRoute?: CreateAudienceGroupResponse.CreateRouteEnum;
    type?: AudienceGroupType;
    /**
     * The audience's name.
     */
    description?: string;
    /**
     * When the audience was created (in UNIX time).
     */
    created?: number;
    /**
     * Audience's update permission. Audiences linked to the same channel will be READ_WRITE.  `READ`: Can use only. `READ_WRITE`: Can use and update.
     */
    permission?: CreateAudienceGroupResponse.PermissionEnum;
    /**
     * Time of audience expiration. Only returned for specific audiences.
     */
    expireTimestamp?: number;
    /**
     * The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of:  `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs.
     */
    isIfaAudience?: boolean;
};

Create audience for uploading user IDs (by JSON)
See Also
- https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group

type CreateClickBasedAudienceGroupRequest

type CreateClickBasedAudienceGroupRequest = {
    /**
     * The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
     * Maximum length: 120
     */
    description?: string;
    /**
     * The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID.
     */
    requestId?: string;
    /**
     * The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000
     * Maximum length: 2000
     */
    clickUrl?: string;
};

Create audience for click-based retargeting
See Also
- https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group

type CreateClickBasedAudienceGroupResponse

type CreateClickBasedAudienceGroupResponse = {
    /**
     * The audience ID.
     */
    audienceGroupId?: number;
    type?: AudienceGroupType;
    /**
     * The audience's name.
     */
    description?: string;
    /**
     * When the audience was created (in UNIX time).
     */
    created?: number;
    /**
     * The request ID that was specified when the audience was created.
     */
    requestId?: string;
    /**
     * The URL that was specified when the audience was created.
     */
    clickUrl?: string;
    /**
     * How the audience was created. `MESSAGING_API`: An audience created with Messaging API.
     */
    createRoute?: CreateClickBasedAudienceGroupResponse.CreateRouteEnum;
    /**
     * Audience's update permission. Audiences linked to the same channel will be READ_WRITE.  - `READ`: Can use only. - `READ_WRITE`: Can use and update.
     */
    permission?: CreateClickBasedAudienceGroupResponse.PermissionEnum;
    /**
     * Time of audience expiration. Only returned for specific audiences.
     */
    expireTimestamp?: number;
    /**
     * The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of:  true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs.
     * Default: false
     */
    isIfaAudience?: boolean;
};

Create audience for click-based retargeting
See Also
- https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group

type CreateImpBasedAudienceGroupRequest

type CreateImpBasedAudienceGroupRequest = {
    /**
     * The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120
     * Minimum length: 1
     * Maximum length: 120
     */
    description?: string;
    /**
     * The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID.
     */
    requestId?: string;
};

Create audience for impression-based retargeting
See Also
- https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group

type CreateImpBasedAudienceGroupResponse

type CreateImpBasedAudienceGroupResponse = {
    /**
     * The audience ID.
     */
    audienceGroupId?: number;
    type?: AudienceGroupType;
    /**
     * The audience's name.
     */
    description?: string;
    /**
     * When the audience was created (in UNIX time).
     */
    created?: number;
    /**
     * The request ID that was specified when the audience was created.
     */
    requestId?: string;
};

Create audience for impression-based retargeting
See Also
- https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group

type DetailedOwner

type DetailedOwner = {
    /**
     * Service name where the audience group has been created.
     */
    serviceType?: string;
    /**
     * Owner ID in the service.
     */
    id?: string;
    /**
     * Owner account name.
     */
    name?: string;
};

Owner of this audience group.

type ErrorDetail

type ErrorDetail = {
    /**
     * Details of the error. Not included in the response under certain situations.
     */
    message?: string;
    /**
     * Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.
     */
    property?: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type ErrorResponse

type ErrorResponse = {
    /**
     * Message containing information about the error.
     */
    message: string;
    /**
     * An array of error details. If the array is empty, this property will not be included in the response.
     */
    details?: Array<ErrorDetail>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#error-responses

type GetAudienceDataResponse

type GetAudienceDataResponse = {
    audienceGroup?: AudienceGroup;
    /**
     * An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50
     * Maximum items: 50
     */
    jobs?: Array<AudienceGroupJob>;
    adaccount?: Adaccount;
};

Get audience data
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-audience-group

type GetAudienceGroupsResponse

type GetAudienceGroupsResponse = {
    /**
     * An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned.
     */
    audienceGroups?: Array<AudienceGroup>;
    /**
     * true when this is not the last page.
     */
    hasNextPage?: boolean;
    /**
     * The total number of audiences that can be returned with the specified filter.
     */
    totalCount?: number;
    /**
     * Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE.
     */
    readWriteAudienceGroupTotalCount?: number;
    /**
     * The current page number.
     */
    page?: number;
    /**
     * The maximum number of audiences on the current page.
     */
    size?: number;
};

Gets data for more than one audience.
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-audience-groups

type GetSharedAudienceDataResponse

type GetSharedAudienceDataResponse = {
    audienceGroup?: AudienceGroup;
    /**
     * An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50
     * Maximum items: 50
     */
    jobs?: Array<AudienceGroupJob>;
    owner?: DetailedOwner;
};

Get audience data
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-audience-group

type GetSharedAudienceGroupsResponse

type GetSharedAudienceGroupsResponse = {
    /**
     * An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned.
     */
    audienceGroups?: Array<AudienceGroup>;
    /**
     * true when this is not the last page.
     */
    hasNextPage?: boolean;
    /**
     * The total number of audiences that can be returned with the specified filter.
     */
    totalCount?: number;
    /**
     * Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE.
     */
    readWriteAudienceGroupTotalCount?: number;
    /**
     * The current page number.
     */
    page?: number;
    /**
     * The maximum number of audiences on the current page.
     */
    size?: number;
};

Gets data for more than one audience.
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-audience-groups

type UpdateAudienceGroupDescriptionRequest

type UpdateAudienceGroupDescriptionRequest = {
    /**
     * The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
     * Minimum length: 1
     * Maximum length: 120
     */
    description?: string;
};

Rename an audience
See Also
- https://developers.line.biz/en/reference/messaging-api/#set-description-audience-group

namespace manageAudience.AudienceGroup

namespace manageAudience.AudienceGroup {}

namespace manageAudience.AudienceGroupJob

namespace manageAudience.AudienceGroupJob {}

namespace manageAudience.CreateAudienceGroupResponse

namespace manageAudience.CreateAudienceGroupResponse {}

type CreateRouteEnum

type CreateRouteEnum = 'MESSAGING_API';

type PermissionEnum

type PermissionEnum = 'READ' | 'READ_WRITE';

namespace manageAudience.CreateClickBasedAudienceGroupResponse

namespace manageAudience.CreateClickBasedAudienceGroupResponse {}

type CreateRouteEnum

type CreateRouteEnum = 'MESSAGING_API';

type PermissionEnum

type PermissionEnum = 'READ' | 'READ_WRITE';

namespace manageAudience.CreateImpBasedAudienceGroupResponse

namespace manageAudience.CreateImpBasedAudienceGroupResponse {}

namespace messagingApi

module 'dist/messaging-api/api.d.ts' {}

class MessagingApiBlobClient

class MessagingApiBlobClient {}

See Also
- LineBotClient for a unified interface that wraps this client.

constructor

constructor(config: httpClientConfig);

Initializes a new MessagingApiBlobClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://api-data.line.me.
Parameter
config.channelAccessToken The channel access token used for authorization.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new MessagingApiBlobClient({ channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!, });

method getMessageContent

getMessageContent: (messageId: string) => Promise<Readable>;

Download image, video, and audio data sent from users. Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content. To inspect the HTTP status code or response headers, use getMessageContentWithHttpInfo.
Parameter messageId
Message ID of video or audio
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getMessageContentPreview

getMessageContentPreview: (messageId: string) => Promise<Readable>;

Get a preview image of the image or video Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content/preview. To inspect the HTTP status code or response headers, use getMessageContentPreviewWithHttpInfo.
Parameter messageId
Message ID of image or video
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getMessageContentPreviewWithHttpInfo

getMessageContentPreviewWithHttpInfo: (
    messageId: string
) => Promise<Types.ApiResponseType<Readable>>;

Get a preview image of the image or video Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content/preview. This method returns the response body together with the underlying httpResponse.
Parameter messageId
Message ID of image or video
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getMessageContentTranscodingByMessageId

getMessageContentTranscodingByMessageId: (
    messageId: string
) => Promise<GetMessageContentTranscodingResponse>;

Verify the preparation status of a video or audio for getting Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content/transcoding. To inspect the HTTP status code or response headers, use getMessageContentTranscodingByMessageIdWithHttpInfo.
Parameter messageId
Message ID of video or audio
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getMessageContentTranscodingByMessageIdWithHttpInfo

getMessageContentTranscodingByMessageIdWithHttpInfo: (
    messageId: string
) => Promise<Types.ApiResponseType<GetMessageContentTranscodingResponse>>;

Verify the preparation status of a video or audio for getting Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content/transcoding. This method returns the response body together with the underlying httpResponse.
Parameter messageId
Message ID of video or audio
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getMessageContentWithHttpInfo

getMessageContentWithHttpInfo: (
    messageId: string
) => Promise<Types.ApiResponseType<Readable>>;

Download image, video, and audio data sent from users. Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content. This method returns the response body together with the underlying httpResponse.
Parameter messageId
Message ID of video or audio
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRichMenuImage

getRichMenuImage: (richMenuId: string) => Promise<Readable>;

Download rich menu image. Calls GET https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content. To inspect the HTTP status code or response headers, use getRichMenuImageWithHttpInfo.
Parameter richMenuId
ID of the rich menu with the image to be downloaded
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRichMenuImageWithHttpInfo

getRichMenuImageWithHttpInfo: (
    richMenuId: string
) => Promise<Types.ApiResponseType<Readable>>;

Download rich menu image. Calls GET https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content. This method returns the response body together with the underlying httpResponse.
Parameter richMenuId
ID of the rich menu with the image to be downloaded
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method setRichMenuImage

setRichMenuImage: (
    richMenuId: string,
    body: Blob
) => Promise<Types.MessageAPIResponseBase>;

Upload rich menu image Calls POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content. To inspect the HTTP status code or response headers, use setRichMenuImageWithHttpInfo.
Parameter richMenuId
The ID of the rich menu to attach the image to
Parameter body
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method setRichMenuImageWithHttpInfo

setRichMenuImageWithHttpInfo: (
    richMenuId: string,
    body: Blob
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Upload rich menu image Calls POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content. This method returns the response body together with the underlying httpResponse.
Parameter richMenuId
The ID of the rich menu to attach the image to
Parameter body
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

class MessagingApiClient

class MessagingApiClient {}

See Also
- LineBotClient for a unified interface that wraps this client.

constructor

constructor(config: httpClientConfig);

Initializes a new MessagingApiClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://api.line.me.
Parameter
config.channelAccessToken The channel access token used for authorization.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new MessagingApiClient({ channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!, });

method broadcast

broadcast: (
    broadcastRequest: BroadcastRequest,
    xLineRetryKey?: string
) => Promise<object>;

Sends a message to multiple users at any time. Calls POST https://api.line.me/v2/bot/message/broadcast. To inspect the HTTP status code or response headers, use broadcastWithHttpInfo.
Parameter broadcastRequest
Parameter xLineRetryKey
Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method broadcastWithHttpInfo

broadcastWithHttpInfo: (
    broadcastRequest: BroadcastRequest,
    xLineRetryKey?: string
) => Promise<Types.ApiResponseType<object>>;

Sends a message to multiple users at any time. Calls POST https://api.line.me/v2/bot/message/broadcast. This method returns the response body together with the underlying httpResponse.
Parameter broadcastRequest
Parameter xLineRetryKey
Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method cancelDefaultRichMenu

cancelDefaultRichMenu: () => Promise<Types.MessageAPIResponseBase>;

Cancel default rich menu Calls DELETE https://api.line.me/v2/bot/user/all/richmenu. To inspect the HTTP status code or response headers, use cancelDefaultRichMenuWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method cancelDefaultRichMenuWithHttpInfo

cancelDefaultRichMenuWithHttpInfo: () => Promise<
    Types.ApiResponseType<Types.MessageAPIResponseBase>
>;

Cancel default rich menu Calls DELETE https://api.line.me/v2/bot/user/all/richmenu. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method closeCoupon

closeCoupon: (couponId: string) => Promise<Types.MessageAPIResponseBase>;

Close coupon Calls PUT https://api.line.me/v2/bot/coupon/{couponId}/close. To inspect the HTTP status code or response headers, use closeCouponWithHttpInfo.
Parameter couponId
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method closeCouponWithHttpInfo

closeCouponWithHttpInfo: (
    couponId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Close coupon Calls PUT https://api.line.me/v2/bot/coupon/{couponId}/close. This method returns the response body together with the underlying httpResponse.
Parameter couponId
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method createCoupon

createCoupon: (
    couponCreateRequest?: CouponCreateRequest
) => Promise<CouponCreateResponse>;

Create a new coupon. Define coupon details such as type, title, and validity period. Calls POST https://api.line.me/v2/bot/coupon. To inspect the HTTP status code or response headers, use createCouponWithHttpInfo.
Parameter couponCreateRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method createCouponWithHttpInfo

createCouponWithHttpInfo: (
    couponCreateRequest?: CouponCreateRequest
) => Promise<Types.ApiResponseType<CouponCreateResponse>>;

Create a new coupon. Define coupon details such as type, title, and validity period. Calls POST https://api.line.me/v2/bot/coupon. This method returns the response body together with the underlying httpResponse.
Parameter couponCreateRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method createRichMenu

createRichMenu: (
    richMenuRequest: RichMenuRequest
) => Promise<RichMenuIdResponse>;

Create rich menu Calls POST https://api.line.me/v2/bot/richmenu. To inspect the HTTP status code or response headers, use createRichMenuWithHttpInfo.
Parameter richMenuRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method createRichMenuAlias

createRichMenuAlias: (
    createRichMenuAliasRequest: CreateRichMenuAliasRequest
) => Promise<Types.MessageAPIResponseBase>;

Create rich menu alias Calls POST https://api.line.me/v2/bot/richmenu/alias. To inspect the HTTP status code or response headers, use createRichMenuAliasWithHttpInfo.
Parameter createRichMenuAliasRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method createRichMenuAliasWithHttpInfo

createRichMenuAliasWithHttpInfo: (
    createRichMenuAliasRequest: CreateRichMenuAliasRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Create rich menu alias Calls POST https://api.line.me/v2/bot/richmenu/alias. This method returns the response body together with the underlying httpResponse.
Parameter createRichMenuAliasRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method createRichMenuWithHttpInfo

createRichMenuWithHttpInfo: (
    richMenuRequest: RichMenuRequest
) => Promise<Types.ApiResponseType<RichMenuIdResponse>>;

Create rich menu Calls POST https://api.line.me/v2/bot/richmenu. This method returns the response body together with the underlying httpResponse.
Parameter richMenuRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method deleteRichMenu

deleteRichMenu: (richMenuId: string) => Promise<Types.MessageAPIResponseBase>;

Deletes a rich menu. Calls DELETE https://api.line.me/v2/bot/richmenu/{richMenuId}. To inspect the HTTP status code or response headers, use deleteRichMenuWithHttpInfo.
Parameter richMenuId
ID of a rich menu
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method deleteRichMenuAlias

deleteRichMenuAlias: (
    richMenuAliasId: string
) => Promise<Types.MessageAPIResponseBase>;

Delete rich menu alias Calls DELETE https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. To inspect the HTTP status code or response headers, use deleteRichMenuAliasWithHttpInfo.
Parameter richMenuAliasId
Rich menu alias ID that you want to delete.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method deleteRichMenuAliasWithHttpInfo

deleteRichMenuAliasWithHttpInfo: (
    richMenuAliasId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Delete rich menu alias Calls DELETE https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. This method returns the response body together with the underlying httpResponse.
Parameter richMenuAliasId
Rich menu alias ID that you want to delete.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method deleteRichMenuWithHttpInfo

deleteRichMenuWithHttpInfo: (
    richMenuId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Deletes a rich menu. Calls DELETE https://api.line.me/v2/bot/richmenu/{richMenuId}. This method returns the response body together with the underlying httpResponse.
Parameter richMenuId
ID of a rich menu
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getAggregationUnitNameList

getAggregationUnitNameList: (
    limit?: string,
    start?: string
) => Promise<GetAggregationUnitNameListResponse>;

Get name list of units used this month Calls GET https://api.line.me/v2/bot/message/aggregation/list. To inspect the HTTP status code or response headers, use getAggregationUnitNameListWithHttpInfo.
Parameter limit
The maximum number of aggregation units you can get per request.
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getAggregationUnitNameListWithHttpInfo

getAggregationUnitNameListWithHttpInfo: (
    limit?: string,
    start?: string
) => Promise<Types.ApiResponseType<GetAggregationUnitNameListResponse>>;

Get name list of units used this month Calls GET https://api.line.me/v2/bot/message/aggregation/list. This method returns the response body together with the underlying httpResponse.
Parameter limit
The maximum number of aggregation units you can get per request.
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getAggregationUnitUsage

getAggregationUnitUsage: () => Promise<GetAggregationUnitUsageResponse>;

Get number of units used this month Calls GET https://api.line.me/v2/bot/message/aggregation/info. To inspect the HTTP status code or response headers, use getAggregationUnitUsageWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getAggregationUnitUsageWithHttpInfo

getAggregationUnitUsageWithHttpInfo: () => Promise<
    Types.ApiResponseType<GetAggregationUnitUsageResponse>
>;

Get number of units used this month Calls GET https://api.line.me/v2/bot/message/aggregation/info. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getBotInfo

getBotInfo: () => Promise<BotInfoResponse>;

Get bot info Calls GET https://api.line.me/v2/bot/info. To inspect the HTTP status code or response headers, use getBotInfoWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getBotInfoWithHttpInfo

getBotInfoWithHttpInfo: () => Promise<Types.ApiResponseType<BotInfoResponse>>;

Get bot info Calls GET https://api.line.me/v2/bot/info. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getCouponDetail

getCouponDetail: (couponId: string) => Promise<CouponResponse>;

Get coupon detail Calls GET https://api.line.me/v2/bot/coupon/{couponId}. To inspect the HTTP status code or response headers, use getCouponDetailWithHttpInfo.
Parameter couponId
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getCouponDetailWithHttpInfo

getCouponDetailWithHttpInfo: (
    couponId: string
) => Promise<Types.ApiResponseType<CouponResponse>>;

Get coupon detail Calls GET https://api.line.me/v2/bot/coupon/{couponId}. This method returns the response body together with the underlying httpResponse.
Parameter couponId
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getDefaultRichMenuId

getDefaultRichMenuId: () => Promise<RichMenuIdResponse>;

Gets the ID of the default rich menu set with the Messaging API. Calls GET https://api.line.me/v2/bot/user/all/richmenu. To inspect the HTTP status code or response headers, use getDefaultRichMenuIdWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getDefaultRichMenuIdWithHttpInfo

getDefaultRichMenuIdWithHttpInfo: () => Promise<
    Types.ApiResponseType<RichMenuIdResponse>
>;

Gets the ID of the default rich menu set with the Messaging API. Calls GET https://api.line.me/v2/bot/user/all/richmenu. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getFollowers

getFollowers: (start?: string, limit?: number) => Promise<GetFollowersResponse>;

Get a list of users who added your LINE Official Account as a friend Calls GET https://api.line.me/v2/bot/followers/ids. To inspect the HTTP status code or response headers, use getFollowersWithHttpInfo.
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
Parameter limit
The maximum number of user IDs to retrieve in a single request.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getFollowersWithHttpInfo

getFollowersWithHttpInfo: (
    start?: string,
    limit?: number
) => Promise<Types.ApiResponseType<GetFollowersResponse>>;

Get a list of users who added your LINE Official Account as a friend Calls GET https://api.line.me/v2/bot/followers/ids. This method returns the response body together with the underlying httpResponse.
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
Parameter limit
The maximum number of user IDs to retrieve in a single request.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getGroupMemberCount

getGroupMemberCount: (groupId: string) => Promise<GroupMemberCountResponse>;

Get number of users in a group chat Calls GET https://api.line.me/v2/bot/group/{groupId}/members/count. To inspect the HTTP status code or response headers, use getGroupMemberCountWithHttpInfo.
Parameter groupId
Group ID
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getGroupMemberCountWithHttpInfo

getGroupMemberCountWithHttpInfo: (
    groupId: string
) => Promise<Types.ApiResponseType<GroupMemberCountResponse>>;

Get number of users in a group chat Calls GET https://api.line.me/v2/bot/group/{groupId}/members/count. This method returns the response body together with the underlying httpResponse.
Parameter groupId
Group ID
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getGroupMemberProfile

getGroupMemberProfile: (
    groupId: string,
    userId: string
) => Promise<GroupUserProfileResponse>;

Get group chat member profile Calls GET https://api.line.me/v2/bot/group/{groupId}/member/{userId}. To inspect the HTTP status code or response headers, use getGroupMemberProfileWithHttpInfo.
Parameter groupId
Group ID
Parameter userId
User ID
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getGroupMemberProfileWithHttpInfo

getGroupMemberProfileWithHttpInfo: (
    groupId: string,
    userId: string
) => Promise<Types.ApiResponseType<GroupUserProfileResponse>>;

Get group chat member profile Calls GET https://api.line.me/v2/bot/group/{groupId}/member/{userId}. This method returns the response body together with the underlying httpResponse.
Parameter groupId
Group ID
Parameter userId
User ID
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getGroupMembersIds

getGroupMembersIds: (
    groupId: string,
    start?: string
) => Promise<MembersIdsResponse>;

Get group chat member user IDs Calls GET https://api.line.me/v2/bot/group/{groupId}/members/ids. To inspect the HTTP status code or response headers, use getGroupMembersIdsWithHttpInfo.
Parameter groupId
Group ID
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getGroupMembersIdsWithHttpInfo

getGroupMembersIdsWithHttpInfo: (
    groupId: string,
    start?: string
) => Promise<Types.ApiResponseType<MembersIdsResponse>>;

Get group chat member user IDs Calls GET https://api.line.me/v2/bot/group/{groupId}/members/ids. This method returns the response body together with the underlying httpResponse.
Parameter groupId
Group ID
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getGroupSummary

getGroupSummary: (groupId: string) => Promise<GroupSummaryResponse>;

Get group chat summary Calls GET https://api.line.me/v2/bot/group/{groupId}/summary. To inspect the HTTP status code or response headers, use getGroupSummaryWithHttpInfo.
Parameter groupId
Group ID
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getGroupSummaryWithHttpInfo

getGroupSummaryWithHttpInfo: (
    groupId: string
) => Promise<Types.ApiResponseType<GroupSummaryResponse>>;

Get group chat summary Calls GET https://api.line.me/v2/bot/group/{groupId}/summary. This method returns the response body together with the underlying httpResponse.
Parameter groupId
Group ID
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getJoinedMembershipUsers

getJoinedMembershipUsers: (
    membershipId: number,
    start?: string,
    limit?: number
) => Promise<GetJoinedMembershipUsersResponse>;

Get a list of user IDs who joined the membership. Calls GET https://api.line.me/v2/bot/membership/{membershipId}/users/ids. To inspect the HTTP status code or response headers, use getJoinedMembershipUsersWithHttpInfo.
Parameter membershipId
Membership plan ID.
Parameter start
A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).
Parameter limit
The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getJoinedMembershipUsersWithHttpInfo

getJoinedMembershipUsersWithHttpInfo: (
    membershipId: number,
    start?: string,
    limit?: number
) => Promise<Types.ApiResponseType<GetJoinedMembershipUsersResponse>>;

Get a list of user IDs who joined the membership. Calls GET https://api.line.me/v2/bot/membership/{membershipId}/users/ids. This method returns the response body together with the underlying httpResponse.
Parameter membershipId
Membership plan ID.
Parameter start
A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).
Parameter limit
The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getMembershipList

getMembershipList: () => Promise<MembershipListResponse>;

Get a list of memberships. Calls GET https://api.line.me/v2/bot/membership/list. To inspect the HTTP status code or response headers, use getMembershipListWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getMembershipListWithHttpInfo

getMembershipListWithHttpInfo: () => Promise<
    Types.ApiResponseType<MembershipListResponse>
>;

Get a list of memberships. Calls GET https://api.line.me/v2/bot/membership/list. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getMembershipSubscription

getMembershipSubscription: (
    userId: string
) => Promise<GetMembershipSubscriptionResponse>;

Get a user's membership subscription. Calls GET https://api.line.me/v2/bot/membership/subscription/{userId}. To inspect the HTTP status code or response headers, use getMembershipSubscriptionWithHttpInfo.
Parameter userId
User ID
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getMembershipSubscriptionWithHttpInfo

getMembershipSubscriptionWithHttpInfo: (
    userId: string
) => Promise<Types.ApiResponseType<GetMembershipSubscriptionResponse>>;

Get a user's membership subscription. Calls GET https://api.line.me/v2/bot/membership/subscription/{userId}. This method returns the response body together with the underlying httpResponse.
Parameter userId
User ID
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getMessageQuota

getMessageQuota: () => Promise<MessageQuotaResponse>;

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned. Calls GET https://api.line.me/v2/bot/message/quota. To inspect the HTTP status code or response headers, use getMessageQuotaWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getMessageQuotaConsumption

getMessageQuotaConsumption: () => Promise<QuotaConsumptionResponse>;

Gets the number of messages sent in the current month. Calls GET https://api.line.me/v2/bot/message/quota/consumption. To inspect the HTTP status code or response headers, use getMessageQuotaConsumptionWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getMessageQuotaConsumptionWithHttpInfo

getMessageQuotaConsumptionWithHttpInfo: () => Promise<
    Types.ApiResponseType<QuotaConsumptionResponse>
>;

Gets the number of messages sent in the current month. Calls GET https://api.line.me/v2/bot/message/quota/consumption. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getMessageQuotaWithHttpInfo

getMessageQuotaWithHttpInfo: () => Promise<
    Types.ApiResponseType<MessageQuotaResponse>
>;

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned. Calls GET https://api.line.me/v2/bot/message/quota. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getNarrowcastProgress

getNarrowcastProgress: (
    requestId: string
) => Promise<NarrowcastProgressResponse>;

Gets the status of a narrowcast message. Calls GET https://api.line.me/v2/bot/message/progress/narrowcast. To inspect the HTTP status code or response headers, use getNarrowcastProgressWithHttpInfo.
Parameter requestId
The narrowcast message's request ID. Each Messaging API request has a request ID.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getNarrowcastProgressWithHttpInfo

getNarrowcastProgressWithHttpInfo: (
    requestId: string
) => Promise<Types.ApiResponseType<NarrowcastProgressResponse>>;

Gets the status of a narrowcast message. Calls GET https://api.line.me/v2/bot/message/progress/narrowcast. This method returns the response body together with the underlying httpResponse.
Parameter requestId
The narrowcast message's request ID. Each Messaging API request has a request ID.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessages: (
    date: string
) => Promise<NumberOfMessagesResponse>;

Get number of sent broadcast messages Calls GET https://api.line.me/v2/bot/message/delivery/broadcast. To inspect the HTTP status code or response headers, use getNumberOfSentBroadcastMessagesWithHttpInfo.
Parameter date
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getNumberOfSentBroadcastMessagesWithHttpInfo

getNumberOfSentBroadcastMessagesWithHttpInfo: (
    date: string
) => Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;

Get number of sent broadcast messages Calls GET https://api.line.me/v2/bot/message/delivery/broadcast. This method returns the response body together with the underlying httpResponse.
Parameter date
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessages: (
    date: string
) => Promise<NumberOfMessagesResponse>;

Get number of sent multicast messages Calls GET https://api.line.me/v2/bot/message/delivery/multicast. To inspect the HTTP status code or response headers, use getNumberOfSentMulticastMessagesWithHttpInfo.
Parameter date
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getNumberOfSentMulticastMessagesWithHttpInfo

getNumberOfSentMulticastMessagesWithHttpInfo: (
    date: string
) => Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;

Get number of sent multicast messages Calls GET https://api.line.me/v2/bot/message/delivery/multicast. This method returns the response body together with the underlying httpResponse.
Parameter date
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getNumberOfSentPushMessages

getNumberOfSentPushMessages: (date: string) => Promise<NumberOfMessagesResponse>;

Get number of sent push messages Calls GET https://api.line.me/v2/bot/message/delivery/push. To inspect the HTTP status code or response headers, use getNumberOfSentPushMessagesWithHttpInfo.
Parameter date
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getNumberOfSentPushMessagesWithHttpInfo

getNumberOfSentPushMessagesWithHttpInfo: (
    date: string
) => Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;

Get number of sent push messages Calls GET https://api.line.me/v2/bot/message/delivery/push. This method returns the response body together with the underlying httpResponse.
Parameter date
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getNumberOfSentReplyMessages

getNumberOfSentReplyMessages: (
    date: string
) => Promise<NumberOfMessagesResponse>;

Get number of sent reply messages Calls GET https://api.line.me/v2/bot/message/delivery/reply. To inspect the HTTP status code or response headers, use getNumberOfSentReplyMessagesWithHttpInfo.
Parameter date
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getNumberOfSentReplyMessagesWithHttpInfo

getNumberOfSentReplyMessagesWithHttpInfo: (
    date: string
) => Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;

Get number of sent reply messages Calls GET https://api.line.me/v2/bot/message/delivery/reply. This method returns the response body together with the underlying httpResponse.
Parameter date
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getPNPMessageStatistics

getPNPMessageStatistics: (date: string) => Promise<NumberOfMessagesResponse>;

Get number of sent LINE notification messages Calls GET https://api.line.me/v2/bot/message/delivery/pnp. To inspect the HTTP status code or response headers, use getPNPMessageStatisticsWithHttpInfo.
Parameter date
Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getPNPMessageStatisticsWithHttpInfo

getPNPMessageStatisticsWithHttpInfo: (
    date: string
) => Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;

Get number of sent LINE notification messages Calls GET https://api.line.me/v2/bot/message/delivery/pnp. This method returns the response body together with the underlying httpResponse.
Parameter date
Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getProfile

getProfile: (userId: string) => Promise<UserProfileResponse>;

Get profile Calls GET https://api.line.me/v2/bot/profile/{userId}. To inspect the HTTP status code or response headers, use getProfileWithHttpInfo.
Parameter userId
User ID
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getProfileWithHttpInfo

getProfileWithHttpInfo: (
    userId: string
) => Promise<Types.ApiResponseType<UserProfileResponse>>;

Get profile Calls GET https://api.line.me/v2/bot/profile/{userId}. This method returns the response body together with the underlying httpResponse.
Parameter userId
User ID
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRichMenu

getRichMenu: (richMenuId: string) => Promise<RichMenuResponse>;

Gets a rich menu via a rich menu ID. Calls GET https://api.line.me/v2/bot/richmenu/{richMenuId}. To inspect the HTTP status code or response headers, use getRichMenuWithHttpInfo.
Parameter richMenuId
ID of a rich menu
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRichMenuAlias

getRichMenuAlias: (richMenuAliasId: string) => Promise<RichMenuAliasResponse>;

Get rich menu alias information Calls GET https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. To inspect the HTTP status code or response headers, use getRichMenuAliasWithHttpInfo.
Parameter richMenuAliasId
The rich menu alias ID whose information you want to obtain.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRichMenuAliasList

getRichMenuAliasList: () => Promise<RichMenuAliasListResponse>;

Get list of rich menu alias Calls GET https://api.line.me/v2/bot/richmenu/alias/list. To inspect the HTTP status code or response headers, use getRichMenuAliasListWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRichMenuAliasListWithHttpInfo

getRichMenuAliasListWithHttpInfo: () => Promise<
    Types.ApiResponseType<RichMenuAliasListResponse>
>;

Get list of rich menu alias Calls GET https://api.line.me/v2/bot/richmenu/alias/list. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRichMenuAliasWithHttpInfo

getRichMenuAliasWithHttpInfo: (
    richMenuAliasId: string
) => Promise<Types.ApiResponseType<RichMenuAliasResponse>>;

Get rich menu alias information Calls GET https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. This method returns the response body together with the underlying httpResponse.
Parameter richMenuAliasId
The rich menu alias ID whose information you want to obtain.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRichMenuBatchProgress

getRichMenuBatchProgress: (
    requestId: string
) => Promise<RichMenuBatchProgressResponse>;

Get the status of Replace or unlink a linked rich menus in batches. Calls GET https://api.line.me/v2/bot/richmenu/progress/batch. To inspect the HTTP status code or response headers, use getRichMenuBatchProgressWithHttpInfo.
Parameter requestId
A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRichMenuBatchProgressWithHttpInfo

getRichMenuBatchProgressWithHttpInfo: (
    requestId: string
) => Promise<Types.ApiResponseType<RichMenuBatchProgressResponse>>;

Get the status of Replace or unlink a linked rich menus in batches. Calls GET https://api.line.me/v2/bot/richmenu/progress/batch. This method returns the response body together with the underlying httpResponse.
Parameter requestId
A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRichMenuIdOfUser

getRichMenuIdOfUser: (userId: string) => Promise<RichMenuIdResponse>;

Get rich menu ID of user Calls GET https://api.line.me/v2/bot/user/{userId}/richmenu. To inspect the HTTP status code or response headers, use getRichMenuIdOfUserWithHttpInfo.
Parameter userId
User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRichMenuIdOfUserWithHttpInfo

getRichMenuIdOfUserWithHttpInfo: (
    userId: string
) => Promise<Types.ApiResponseType<RichMenuIdResponse>>;

Get rich menu ID of user Calls GET https://api.line.me/v2/bot/user/{userId}/richmenu. This method returns the response body together with the underlying httpResponse.
Parameter userId
User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRichMenuList

getRichMenuList: () => Promise<RichMenuListResponse>;

Get rich menu list Calls GET https://api.line.me/v2/bot/richmenu/list. To inspect the HTTP status code or response headers, use getRichMenuListWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRichMenuListWithHttpInfo

getRichMenuListWithHttpInfo: () => Promise<
    Types.ApiResponseType<RichMenuListResponse>
>;

Get rich menu list Calls GET https://api.line.me/v2/bot/richmenu/list. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRichMenuWithHttpInfo

getRichMenuWithHttpInfo: (
    richMenuId: string
) => Promise<Types.ApiResponseType<RichMenuResponse>>;

Gets a rich menu via a rich menu ID. Calls GET https://api.line.me/v2/bot/richmenu/{richMenuId}. This method returns the response body together with the underlying httpResponse.
Parameter richMenuId
ID of a rich menu
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRoomMemberCount

getRoomMemberCount: (roomId: string) => Promise<RoomMemberCountResponse>;

Get number of users in a multi-person chat Calls GET https://api.line.me/v2/bot/room/{roomId}/members/count. To inspect the HTTP status code or response headers, use getRoomMemberCountWithHttpInfo.
Parameter roomId
Room ID
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRoomMemberCountWithHttpInfo

getRoomMemberCountWithHttpInfo: (
    roomId: string
) => Promise<Types.ApiResponseType<RoomMemberCountResponse>>;

Get number of users in a multi-person chat Calls GET https://api.line.me/v2/bot/room/{roomId}/members/count. This method returns the response body together with the underlying httpResponse.
Parameter roomId
Room ID
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRoomMemberProfile

getRoomMemberProfile: (
    roomId: string,
    userId: string
) => Promise<RoomUserProfileResponse>;

Get multi-person chat member profile Calls GET https://api.line.me/v2/bot/room/{roomId}/member/{userId}. To inspect the HTTP status code or response headers, use getRoomMemberProfileWithHttpInfo.
Parameter roomId
Room ID
Parameter userId
User ID
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRoomMemberProfileWithHttpInfo

getRoomMemberProfileWithHttpInfo: (
    roomId: string,
    userId: string
) => Promise<Types.ApiResponseType<RoomUserProfileResponse>>;

Get multi-person chat member profile Calls GET https://api.line.me/v2/bot/room/{roomId}/member/{userId}. This method returns the response body together with the underlying httpResponse.
Parameter roomId
Room ID
Parameter userId
User ID
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getRoomMembersIds

getRoomMembersIds: (
    roomId: string,
    start?: string
) => Promise<MembersIdsResponse>;

Get multi-person chat member user IDs Calls GET https://api.line.me/v2/bot/room/{roomId}/members/ids. To inspect the HTTP status code or response headers, use getRoomMembersIdsWithHttpInfo.
Parameter roomId
Room ID
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getRoomMembersIdsWithHttpInfo

getRoomMembersIdsWithHttpInfo: (
    roomId: string,
    start?: string
) => Promise<Types.ApiResponseType<MembersIdsResponse>>;

Get multi-person chat member user IDs Calls GET https://api.line.me/v2/bot/room/{roomId}/members/ids. This method returns the response body together with the underlying httpResponse.
Parameter roomId
Room ID
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getWebhookEndpoint

getWebhookEndpoint: () => Promise<GetWebhookEndpointResponse>;

Get webhook endpoint information Calls GET https://api.line.me/v2/bot/channel/webhook/endpoint. To inspect the HTTP status code or response headers, use getWebhookEndpointWithHttpInfo.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getWebhookEndpointWithHttpInfo

getWebhookEndpointWithHttpInfo: () => Promise<
    Types.ApiResponseType<GetWebhookEndpointResponse>
>;

Get webhook endpoint information Calls GET https://api.line.me/v2/bot/channel/webhook/endpoint. This method returns the response body together with the underlying httpResponse.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method issueLinkToken

issueLinkToken: (userId: string) => Promise<IssueLinkTokenResponse>;

Issue link token Calls POST https://api.line.me/v2/bot/user/{userId}/linkToken. To inspect the HTTP status code or response headers, use issueLinkTokenWithHttpInfo.
Parameter userId
User ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method issueLinkTokenWithHttpInfo

issueLinkTokenWithHttpInfo: (
    userId: string
) => Promise<Types.ApiResponseType<IssueLinkTokenResponse>>;

Issue link token Calls POST https://api.line.me/v2/bot/user/{userId}/linkToken. This method returns the response body together with the underlying httpResponse.
Parameter userId
User ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method leaveGroup

leaveGroup: (groupId: string) => Promise<Types.MessageAPIResponseBase>;

Leave group chat Calls POST https://api.line.me/v2/bot/group/{groupId}/leave. To inspect the HTTP status code or response headers, use leaveGroupWithHttpInfo.
Parameter groupId
Group ID
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method leaveGroupWithHttpInfo

leaveGroupWithHttpInfo: (
    groupId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Leave group chat Calls POST https://api.line.me/v2/bot/group/{groupId}/leave. This method returns the response body together with the underlying httpResponse.
Parameter groupId
Group ID
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method leaveRoom

leaveRoom: (roomId: string) => Promise<Types.MessageAPIResponseBase>;

Leave multi-person chat Calls POST https://api.line.me/v2/bot/room/{roomId}/leave. To inspect the HTTP status code or response headers, use leaveRoomWithHttpInfo.
Parameter roomId
Room ID
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method leaveRoomWithHttpInfo

leaveRoomWithHttpInfo: (
    roomId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Leave multi-person chat Calls POST https://api.line.me/v2/bot/room/{roomId}/leave. This method returns the response body together with the underlying httpResponse.
Parameter roomId
Room ID
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method linkRichMenuIdToUser

linkRichMenuIdToUser: (
    userId: string,
    richMenuId: string
) => Promise<Types.MessageAPIResponseBase>;

Link rich menu to user. Calls POST https://api.line.me/v2/bot/user/{userId}/richmenu/{richMenuId}. To inspect the HTTP status code or response headers, use linkRichMenuIdToUserWithHttpInfo.
Parameter userId
User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
Parameter richMenuId
ID of a rich menu
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method linkRichMenuIdToUsers

linkRichMenuIdToUsers: (
    richMenuBulkLinkRequest: RichMenuBulkLinkRequest
) => Promise<Types.MessageAPIResponseBase>;

Link rich menu to multiple users Calls POST https://api.line.me/v2/bot/richmenu/bulk/link. To inspect the HTTP status code or response headers, use linkRichMenuIdToUsersWithHttpInfo.
Parameter richMenuBulkLinkRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method linkRichMenuIdToUsersWithHttpInfo

linkRichMenuIdToUsersWithHttpInfo: (
    richMenuBulkLinkRequest: RichMenuBulkLinkRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Link rich menu to multiple users Calls POST https://api.line.me/v2/bot/richmenu/bulk/link. This method returns the response body together with the underlying httpResponse.
Parameter richMenuBulkLinkRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method linkRichMenuIdToUserWithHttpInfo

linkRichMenuIdToUserWithHttpInfo: (
    userId: string,
    richMenuId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Link rich menu to user. Calls POST https://api.line.me/v2/bot/user/{userId}/richmenu/{richMenuId}. This method returns the response body together with the underlying httpResponse.
Parameter userId
User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
Parameter richMenuId
ID of a rich menu
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method listCoupon

listCoupon: (
    status?: Set<'DRAFT' | 'RUNNING' | 'CLOSED'>,
    start?: string,
    limit?: number
) => Promise<MessagingApiPagerCouponListResponse>;

Get a paginated list of coupons. Calls GET https://api.line.me/v2/bot/coupon. To inspect the HTTP status code or response headers, use listCouponWithHttpInfo.
Parameter status
Filter coupons by their status.
Parameter start
Pagination token to retrieve the next page of results.
Parameter limit
Maximum number of coupons to return per request.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method listCouponWithHttpInfo

listCouponWithHttpInfo: (
    status?: Set<'DRAFT' | 'RUNNING' | 'CLOSED'>,
    start?: string,
    limit?: number
) => Promise<Types.ApiResponseType<MessagingApiPagerCouponListResponse>>;

Get a paginated list of coupons. Calls GET https://api.line.me/v2/bot/coupon. This method returns the response body together with the underlying httpResponse.
Parameter status
Filter coupons by their status.
Parameter start
Pagination token to retrieve the next page of results.
Parameter limit
Maximum number of coupons to return per request.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method markMessagesAsRead

markMessagesAsRead: (
    markMessagesAsReadRequest: MarkMessagesAsReadRequest
) => Promise<Types.MessageAPIResponseBase>;

Mark messages from users as read Calls POST https://api.line.me/v2/bot/message/markAsRead. To inspect the HTTP status code or response headers, use markMessagesAsReadWithHttpInfo.
Parameter markMessagesAsReadRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method markMessagesAsReadByToken

markMessagesAsReadByToken: (
    markMessagesAsReadByTokenRequest: MarkMessagesAsReadByTokenRequest
) => Promise<Types.MessageAPIResponseBase>;

Mark messages from users as read by token Calls POST https://api.line.me/v2/bot/chat/markAsRead. To inspect the HTTP status code or response headers, use markMessagesAsReadByTokenWithHttpInfo.
Parameter markMessagesAsReadByTokenRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method markMessagesAsReadByTokenWithHttpInfo

markMessagesAsReadByTokenWithHttpInfo: (
    markMessagesAsReadByTokenRequest: MarkMessagesAsReadByTokenRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Mark messages from users as read by token Calls POST https://api.line.me/v2/bot/chat/markAsRead. This method returns the response body together with the underlying httpResponse.
Parameter markMessagesAsReadByTokenRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method markMessagesAsReadWithHttpInfo

markMessagesAsReadWithHttpInfo: (
    markMessagesAsReadRequest: MarkMessagesAsReadRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Mark messages from users as read Calls POST https://api.line.me/v2/bot/message/markAsRead. This method returns the response body together with the underlying httpResponse.
Parameter markMessagesAsReadRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method multicast

multicast: (
    multicastRequest: MulticastRequest,
    xLineRetryKey?: string
) => Promise<object>;

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats. Calls POST https://api.line.me/v2/bot/message/multicast. To inspect the HTTP status code or response headers, use multicastWithHttpInfo.
Parameter multicastRequest
Parameter xLineRetryKey
Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method multicastWithHttpInfo

multicastWithHttpInfo: (
    multicastRequest: MulticastRequest,
    xLineRetryKey?: string
) => Promise<Types.ApiResponseType<object>>;

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats. Calls POST https://api.line.me/v2/bot/message/multicast. This method returns the response body together with the underlying httpResponse.
Parameter multicastRequest
Parameter xLineRetryKey
Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method narrowcast

narrowcast: (
    narrowcastRequest: NarrowcastRequest,
    xLineRetryKey?: string
) => Promise<object>;

Send narrowcast message Calls POST https://api.line.me/v2/bot/message/narrowcast. To inspect the HTTP status code or response headers, use narrowcastWithHttpInfo.
Parameter narrowcastRequest
Parameter xLineRetryKey
Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method narrowcastWithHttpInfo

narrowcastWithHttpInfo: (
    narrowcastRequest: NarrowcastRequest,
    xLineRetryKey?: string
) => Promise<Types.ApiResponseType<object>>;

Send narrowcast message Calls POST https://api.line.me/v2/bot/message/narrowcast. This method returns the response body together with the underlying httpResponse.
Parameter narrowcastRequest
Parameter xLineRetryKey
Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method pushMessage

pushMessage: (
    pushMessageRequest: PushMessageRequest,
    xLineRetryKey?: string
) => Promise<PushMessageResponse>;

Sends a message to a user, group chat, or multi-person chat at any time. Calls POST https://api.line.me/v2/bot/message/push. To inspect the HTTP status code or response headers, use pushMessageWithHttpInfo.
Parameter pushMessageRequest
Parameter xLineRetryKey
Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method pushMessagesByPhone

pushMessagesByPhone: (
    pnpMessagesRequest: PnpMessagesRequest,
    xLineDeliveryTag?: string
) => Promise<Types.MessageAPIResponseBase>;

Send LINE notification message Calls POST https://api.line.me/bot/pnp/push. To inspect the HTTP status code or response headers, use pushMessagesByPhoneWithHttpInfo.
Parameter pnpMessagesRequest
Parameter xLineDeliveryTag
String returned in the delivery.data property of the delivery completion event via Webhook.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method pushMessagesByPhoneWithHttpInfo

pushMessagesByPhoneWithHttpInfo: (
    pnpMessagesRequest: PnpMessagesRequest,
    xLineDeliveryTag?: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Send LINE notification message Calls POST https://api.line.me/bot/pnp/push. This method returns the response body together with the underlying httpResponse.
Parameter pnpMessagesRequest
Parameter xLineDeliveryTag
String returned in the delivery.data property of the delivery completion event via Webhook.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method pushMessageWithHttpInfo

pushMessageWithHttpInfo: (
    pushMessageRequest: PushMessageRequest,
    xLineRetryKey?: string
) => Promise<Types.ApiResponseType<PushMessageResponse>>;

Sends a message to a user, group chat, or multi-person chat at any time. Calls POST https://api.line.me/v2/bot/message/push. This method returns the response body together with the underlying httpResponse.
Parameter pushMessageRequest
Parameter xLineRetryKey
Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method replyMessage

replyMessage: (
    replyMessageRequest: ReplyMessageRequest
) => Promise<ReplyMessageResponse>;

Send reply message Calls POST https://api.line.me/v2/bot/message/reply. To inspect the HTTP status code or response headers, use replyMessageWithHttpInfo.
Parameter replyMessageRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method replyMessageWithHttpInfo

replyMessageWithHttpInfo: (
    replyMessageRequest: ReplyMessageRequest
) => Promise<Types.ApiResponseType<ReplyMessageResponse>>;

Send reply message Calls POST https://api.line.me/v2/bot/message/reply. This method returns the response body together with the underlying httpResponse.
Parameter replyMessageRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method richMenuBatch

richMenuBatch: (
    richMenuBatchRequest: RichMenuBatchRequest
) => Promise<Types.MessageAPIResponseBase>;

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu Calls POST https://api.line.me/v2/bot/richmenu/batch. To inspect the HTTP status code or response headers, use richMenuBatchWithHttpInfo.
Parameter richMenuBatchRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method richMenuBatchWithHttpInfo

richMenuBatchWithHttpInfo: (
    richMenuBatchRequest: RichMenuBatchRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu Calls POST https://api.line.me/v2/bot/richmenu/batch. This method returns the response body together with the underlying httpResponse.
Parameter richMenuBatchRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method setDefaultRichMenu

setDefaultRichMenu: (
    richMenuId: string
) => Promise<Types.MessageAPIResponseBase>;

Set default rich menu Calls POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId}. To inspect the HTTP status code or response headers, use setDefaultRichMenuWithHttpInfo.
Parameter richMenuId
ID of a rich menu
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method setDefaultRichMenuWithHttpInfo

setDefaultRichMenuWithHttpInfo: (
    richMenuId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Set default rich menu Calls POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId}. This method returns the response body together with the underlying httpResponse.
Parameter richMenuId
ID of a rich menu
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method setWebhookEndpoint

setWebhookEndpoint: (
    setWebhookEndpointRequest: SetWebhookEndpointRequest
) => Promise<Types.MessageAPIResponseBase>;

Set webhook endpoint URL Calls PUT https://api.line.me/v2/bot/channel/webhook/endpoint. To inspect the HTTP status code or response headers, use setWebhookEndpointWithHttpInfo.
Parameter setWebhookEndpointRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method setWebhookEndpointWithHttpInfo

setWebhookEndpointWithHttpInfo: (
    setWebhookEndpointRequest: SetWebhookEndpointRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Set webhook endpoint URL Calls PUT https://api.line.me/v2/bot/channel/webhook/endpoint. This method returns the response body together with the underlying httpResponse.
Parameter setWebhookEndpointRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method showLoadingAnimation

showLoadingAnimation: (
    showLoadingAnimationRequest: ShowLoadingAnimationRequest
) => Promise<object>;

Display a loading animation in one-on-one chats between users and LINE Official Accounts. Calls POST https://api.line.me/v2/bot/chat/loading/start. To inspect the HTTP status code or response headers, use showLoadingAnimationWithHttpInfo.
Parameter showLoadingAnimationRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method showLoadingAnimationWithHttpInfo

showLoadingAnimationWithHttpInfo: (
    showLoadingAnimationRequest: ShowLoadingAnimationRequest
) => Promise<Types.ApiResponseType<object>>;

Display a loading animation in one-on-one chats between users and LINE Official Accounts. Calls POST https://api.line.me/v2/bot/chat/loading/start. This method returns the response body together with the underlying httpResponse.
Parameter showLoadingAnimationRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method testWebhookEndpoint

testWebhookEndpoint: (
    testWebhookEndpointRequest?: TestWebhookEndpointRequest
) => Promise<TestWebhookEndpointResponse>;

Test webhook endpoint Calls POST https://api.line.me/v2/bot/channel/webhook/test. To inspect the HTTP status code or response headers, use testWebhookEndpointWithHttpInfo.
Parameter testWebhookEndpointRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method testWebhookEndpointWithHttpInfo

testWebhookEndpointWithHttpInfo: (
    testWebhookEndpointRequest?: TestWebhookEndpointRequest
) => Promise<Types.ApiResponseType<TestWebhookEndpointResponse>>;

Test webhook endpoint Calls POST https://api.line.me/v2/bot/channel/webhook/test. This method returns the response body together with the underlying httpResponse.
Parameter testWebhookEndpointRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method unlinkRichMenuIdFromUser

unlinkRichMenuIdFromUser: (
    userId: string
) => Promise<Types.MessageAPIResponseBase>;

Unlink rich menu from user Calls DELETE https://api.line.me/v2/bot/user/{userId}/richmenu. To inspect the HTTP status code or response headers, use unlinkRichMenuIdFromUserWithHttpInfo.
Parameter userId
User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method unlinkRichMenuIdFromUsers

unlinkRichMenuIdFromUsers: (
    richMenuBulkUnlinkRequest: RichMenuBulkUnlinkRequest
) => Promise<Types.MessageAPIResponseBase>;

Unlink rich menus from multiple users Calls POST https://api.line.me/v2/bot/richmenu/bulk/unlink. To inspect the HTTP status code or response headers, use unlinkRichMenuIdFromUsersWithHttpInfo.
Parameter richMenuBulkUnlinkRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method unlinkRichMenuIdFromUsersWithHttpInfo

unlinkRichMenuIdFromUsersWithHttpInfo: (
    richMenuBulkUnlinkRequest: RichMenuBulkUnlinkRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Unlink rich menus from multiple users Calls POST https://api.line.me/v2/bot/richmenu/bulk/unlink. This method returns the response body together with the underlying httpResponse.
Parameter richMenuBulkUnlinkRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method unlinkRichMenuIdFromUserWithHttpInfo

unlinkRichMenuIdFromUserWithHttpInfo: (
    userId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Unlink rich menu from user Calls DELETE https://api.line.me/v2/bot/user/{userId}/richmenu. This method returns the response body together with the underlying httpResponse.
Parameter userId
User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method updateRichMenuAlias

updateRichMenuAlias: (
    richMenuAliasId: string,
    updateRichMenuAliasRequest: UpdateRichMenuAliasRequest
) => Promise<Types.MessageAPIResponseBase>;

Update rich menu alias Calls POST https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. To inspect the HTTP status code or response headers, use updateRichMenuAliasWithHttpInfo.
Parameter richMenuAliasId
The rich menu alias ID you want to update.
Parameter updateRichMenuAliasRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method updateRichMenuAliasWithHttpInfo

updateRichMenuAliasWithHttpInfo: (
    richMenuAliasId: string,
    updateRichMenuAliasRequest: UpdateRichMenuAliasRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Update rich menu alias Calls POST https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. This method returns the response body together with the underlying httpResponse.
Parameter richMenuAliasId
The rich menu alias ID you want to update.
Parameter updateRichMenuAliasRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method validateBroadcast

validateBroadcast: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.MessageAPIResponseBase>;

Validate message objects of a broadcast message Calls POST https://api.line.me/v2/bot/message/validate/broadcast. To inspect the HTTP status code or response headers, use validateBroadcastWithHttpInfo.
Parameter validateMessageRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method validateBroadcastWithHttpInfo

validateBroadcastWithHttpInfo: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Validate message objects of a broadcast message Calls POST https://api.line.me/v2/bot/message/validate/broadcast. This method returns the response body together with the underlying httpResponse.
Parameter validateMessageRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method validateMulticast

validateMulticast: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.MessageAPIResponseBase>;

Validate message objects of a multicast message Calls POST https://api.line.me/v2/bot/message/validate/multicast. To inspect the HTTP status code or response headers, use validateMulticastWithHttpInfo.
Parameter validateMessageRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method validateMulticastWithHttpInfo

validateMulticastWithHttpInfo: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Validate message objects of a multicast message Calls POST https://api.line.me/v2/bot/message/validate/multicast. This method returns the response body together with the underlying httpResponse.
Parameter validateMessageRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method validateNarrowcast

validateNarrowcast: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.MessageAPIResponseBase>;

Validate message objects of a narrowcast message Calls POST https://api.line.me/v2/bot/message/validate/narrowcast. To inspect the HTTP status code or response headers, use validateNarrowcastWithHttpInfo.
Parameter validateMessageRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method validateNarrowcastWithHttpInfo

validateNarrowcastWithHttpInfo: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Validate message objects of a narrowcast message Calls POST https://api.line.me/v2/bot/message/validate/narrowcast. This method returns the response body together with the underlying httpResponse.
Parameter validateMessageRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method validatePush

validatePush: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.MessageAPIResponseBase>;

Validate message objects of a push message Calls POST https://api.line.me/v2/bot/message/validate/push. To inspect the HTTP status code or response headers, use validatePushWithHttpInfo.
Parameter validateMessageRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method validatePushWithHttpInfo

validatePushWithHttpInfo: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Validate message objects of a push message Calls POST https://api.line.me/v2/bot/message/validate/push. This method returns the response body together with the underlying httpResponse.
Parameter validateMessageRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method validateReply

validateReply: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.MessageAPIResponseBase>;

Validate message objects of a reply message Calls POST https://api.line.me/v2/bot/message/validate/reply. To inspect the HTTP status code or response headers, use validateReplyWithHttpInfo.
Parameter validateMessageRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method validateReplyWithHttpInfo

validateReplyWithHttpInfo: (
    validateMessageRequest: ValidateMessageRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Validate message objects of a reply message Calls POST https://api.line.me/v2/bot/message/validate/reply. This method returns the response body together with the underlying httpResponse.
Parameter validateMessageRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method validateRichMenuBatchRequest

validateRichMenuBatchRequest: (
    richMenuBatchRequest: RichMenuBatchRequest
) => Promise<Types.MessageAPIResponseBase>;

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint. Calls POST https://api.line.me/v2/bot/richmenu/validate/batch. To inspect the HTTP status code or response headers, use validateRichMenuBatchRequestWithHttpInfo.
Parameter richMenuBatchRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method validateRichMenuBatchRequestWithHttpInfo

validateRichMenuBatchRequestWithHttpInfo: (
    richMenuBatchRequest: RichMenuBatchRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint. Calls POST https://api.line.me/v2/bot/richmenu/validate/batch. This method returns the response body together with the underlying httpResponse.
Parameter richMenuBatchRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method validateRichMenuObject

validateRichMenuObject: (
    richMenuRequest: RichMenuRequest
) => Promise<Types.MessageAPIResponseBase>;

Validate rich menu object Calls POST https://api.line.me/v2/bot/richmenu/validate. To inspect the HTTP status code or response headers, use validateRichMenuObjectWithHttpInfo.
Parameter richMenuRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method validateRichMenuObjectWithHttpInfo

validateRichMenuObjectWithHttpInfo: (
    richMenuRequest: RichMenuRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Validate rich menu object Calls POST https://api.line.me/v2/bot/richmenu/validate. This method returns the response body together with the underlying httpResponse.
Parameter richMenuRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

type AcquisitionConditionRequest

type AcquisitionConditionRequest =
    | LotteryAcquisitionConditionRequest
    | NormalAcquisitionConditionRequest;

type AcquisitionConditionRequestBase

type AcquisitionConditionRequestBase = {
    /**
     * Determines how the coupon is distributed or used.
     */
    type: string;
};

type AcquisitionConditionResponse

type AcquisitionConditionResponse =
    | LotteryAcquisitionConditionResponse
    | NormalAcquisitionConditionResponse
    | ReferralAcquisitionConditionResponse;

type AcquisitionConditionResponseBase

type AcquisitionConditionResponseBase = {
    /**
     * Determines how the coupon is distributed or used.
     */
    type: string;
};

type Action

type Action =
    | CameraAction
    | CameraRollAction
    | ClipboardAction
    | DatetimePickerAction
    | LocationAction
    | MessageAction
    | PostbackAction
    | RichMenuSwitchAction
    | URIAction;

Action
See Also
- https://developers.line.biz/en/reference/messaging-api/#action-objects

type ActionBase

type ActionBase = {
    /**
     * Type of action
     */
    type?: string;
    /**
     * Label for the action.
     */
    label?: string;
};

type AgeDemographic

type AgeDemographic =
    | 'age_15'
    | 'age_20'
    | 'age_25'
    | 'age_30'
    | 'age_35'
    | 'age_40'
    | 'age_45'
    | 'age_50'
    | 'age_55'
    | 'age_60'
    | 'age_65'
    | 'age_70';

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type AgeDemographicFilter

type AgeDemographicFilter = DemographicFilterBase & {
    type: 'age';
    gte?: AgeDemographic;
    lt?: AgeDemographic;
};

type AllMentionTarget

type AllMentionTarget = MentionTargetBase & {
    type: 'all';
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#text-message-v2-mentionee-all

type AltUri

type AltUri = {
    /**
     * Minimum length: 0
     * Maximum length: 1000
     */
    desktop?: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type AppTypeDemographic

type AppTypeDemographic = 'ios' | 'android';

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type AppTypeDemographicFilter

type AppTypeDemographicFilter = DemographicFilterBase & {
    type: 'appType';
    oneOf?: Array<AppTypeDemographic>;
};

type AreaDemographic

type AreaDemographic =
    | 'jp_01'
    | 'jp_02'
    | 'jp_03'
    | 'jp_04'
    | 'jp_05'
    | 'jp_06'
    | 'jp_07'
    | 'jp_08'
    | 'jp_09'
    | 'jp_10'
    | 'jp_11'
    | 'jp_12'
    | 'jp_13'
    | 'jp_14'
    | 'jp_15'
    | 'jp_16'
    | 'jp_17'
    | 'jp_18'
    | 'jp_19'
    | 'jp_20'
    | 'jp_21'
    | 'jp_22'
    | 'jp_23'
    | 'jp_24'
    | 'jp_25'
    | 'jp_26'
    | 'jp_27'
    | 'jp_28'
    | 'jp_29'
    | 'jp_30'
    | 'jp_31'
    | 'jp_32'
    | 'jp_33'
    | 'jp_34'
    | 'jp_35'
    | 'jp_36'
    | 'jp_37'
    | 'jp_38'
    | 'jp_39'
    | 'jp_40'
    | 'jp_41'
    | 'jp_42'
    | 'jp_43'
    | 'jp_44'
    | 'jp_45'
    | 'jp_46'
    | 'jp_47'
    | 'tw_01'
    | 'tw_02'
    | 'tw_03'
    | 'tw_04'
    | 'tw_05'
    | 'tw_06'
    | 'tw_07'
    | 'tw_08'
    | 'tw_09'
    | 'tw_10'
    | 'tw_11'
    | 'tw_12'
    | 'tw_13'
    | 'tw_14'
    | 'tw_15'
    | 'tw_16'
    | 'tw_17'
    | 'tw_18'
    | 'tw_19'
    | 'tw_20'
    | 'tw_21'
    | 'tw_22'
    | 'th_01'
    | 'th_02'
    | 'th_03'
    | 'th_04'
    | 'th_05'
    | 'th_06'
    | 'th_07'
    | 'th_08'
    | 'id_01'
    | 'id_02'
    | 'id_03'
    | 'id_04'
    | 'id_05'
    | 'id_06'
    | 'id_07'
    | 'id_08'
    | 'id_09'
    | 'id_10'
    | 'id_11'
    | 'id_12';

See Also
- https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message

type AreaDemographicFilter

type AreaDemographicFilter = DemographicFilterBase & {
    type: 'area';
    oneOf?: Array<AreaDemographic>;
};

type AudienceRecipient

type AudienceRecipient = RecipientBase & {
    type: 'audience';
    audienceGroupId?: number;
};

type AudioMessage

type AudioMessage = MessageBase & {
    type: 'audio';
    originalContentUrl: string;
    duration: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#audio-message

type BotInfoResponse

type BotInfoResponse = {
    /**
     * Bot's user ID
     */
    userId: string;
    /**
     * Bot's basic ID
     */
    basicId: string;
    /**
     * Bot's premium ID. Not included in the response if the premium ID isn't set.
     */
    premiumId?: string;
    /**
     * Bot's display name
     */
    displayName: string;
    /**
     * Profile image URL. `https` image URL. Not included in the response if the bot doesn't have a profile image.
     */
    pictureUrl?: string;
    /**
     * Chat settings set in the LINE Official Account Manager. One of:  `chat`: Chat is set to \"On\". `bot`: Chat is set to \"Off\".
     */
    chatMode: BotInfoResponse.ChatModeEnum;
    /**
     * Automatic read setting for messages. If the chat is set to \"Off\", auto is returned. If the chat is set to \"On\", manual is returned.  `auto`: Auto read setting is enabled. `manual`: Auto read setting is disabled.
     */
    markAsReadMode: BotInfoResponse.MarkAsReadModeEnum;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-bot-info

type BroadcastRequest

type BroadcastRequest = {
    /**
     * List of Message objects.
     * Minimum items: 1
     * Maximum items: 5
     */
    messages: Array<Message>;
    /**
     * `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.
     * Default: false
     */
    notificationDisabled?: boolean;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message

type ButtonsTemplate

type ButtonsTemplate = TemplateBase & {
    type: 'buttons';
    thumbnailImageUrl?: string;
    imageAspectRatio?: string;
    imageSize?: string;
    imageBackgroundColor?: string;
    title?: string;
    text: string;
    defaultAction?: Action;
    actions: Array<Action>;
};

type CameraAction

type CameraAction = ActionBase & {
    type: 'camera';
};

type CameraRollAction

type CameraRollAction = ActionBase & {
    type: 'cameraRoll';
};

type CarouselColumn

type CarouselColumn = {
    thumbnailImageUrl?: string;
    imageBackgroundColor?: string;
    title?: string;
    text: string;
    defaultAction?: Action;
    actions: Array<Action>;
};

Column object for carousel template.

type CarouselTemplate

type CarouselTemplate = TemplateBase & {
    type: 'carousel';
    columns: Array<CarouselColumn>;
    imageAspectRatio?: string;
    imageSize?: string;
};

type CashBackFixedPriceInfoRequest

type CashBackFixedPriceInfoRequest = CashBackPriceInfoRequestBase & {
    type: 'fixed';
    fixedAmount?: number;
};

type CashBackFixedPriceInfoResponse

type CashBackFixedPriceInfoResponse = CashBackPriceInfoResponseBase & {
    type: 'fixed';
    /**
     * Currency code (e.g., JPY, THB, TWD).
     */
    currency?: CashBackFixedPriceInfoResponse.CurrencyEnum;
    fixedAmount?: number;
};

type CashBackPercentagePriceInfoRequest

type CashBackPercentagePriceInfoRequest = CashBackPriceInfoRequestBase & {
    type: 'percentage';
    /**
     * Specifies the cashback rate as a percentage. Must be an integer between 1 and 99.
     * Minimum: 1
     * Maximum: 99
     */
    percentage?: number;
};

type CashBackPercentagePriceInfoResponse

type CashBackPercentagePriceInfoResponse = CashBackPriceInfoResponseBase & {
    type: 'percentage';
    percentage?: number;
};

type CashBackPriceInfoRequest

type CashBackPriceInfoRequest =
    | CashBackFixedPriceInfoRequest
    | CashBackPercentagePriceInfoRequest;

type CashBackPriceInfoRequestBase

type CashBackPriceInfoRequestBase = {
    type: string;
};

type CashBackPriceInfoResponse

type CashBackPriceInfoResponse =
    | CashBackFixedPriceInfoResponse
    | CashBackPercentagePriceInfoResponse;

type CashBackPriceInfoResponseBase

type CashBackPriceInfoResponseBase = {
    type: string;
};

type ChatReference

type ChatReference = {
    /**
     * The target user ID
     */
    userId: string;
};

Chat reference
See Also
- https://developers.line.biz/en/reference/partner-docs/#mark-messages-from-users-as-read

type ClipboardAction

type ClipboardAction = ActionBase & {
    type: 'clipboard';
    /**
     * Text that is copied to the clipboard. Max character limit: 1000
     * Minimum length: 1
     * Maximum length: 1000
     */
    clipboardText: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#clipboard-action

type ClipboardImagemapAction

type ClipboardImagemapAction = ImagemapActionBase & {
    type: 'clipboard';
    /**
     * Text that is copied to the clipboard. Max character limit: 1000
     * Minimum length: 1
     * Maximum length: 1000
     */
    clipboardText: string;
    label?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#imagemap-clipboard-action-object

type ConfirmTemplate

type ConfirmTemplate = TemplateBase & {
    type: 'confirm';
    text: string;
    actions: Array<Action>;
};

type CouponCashBackRewardRequest

type CouponCashBackRewardRequest = CouponRewardRequestBase & {
    type: 'cashBack';
    priceInfo?: CashBackPriceInfoRequest;
};

type CouponCashBackRewardResponse

type CouponCashBackRewardResponse = CouponRewardResponseBase & {
    type: 'cashBack';
    priceInfo?: CashBackPriceInfoResponse;
};

type CouponCreateRequest

type CouponCreateRequest = {
    acquisitionCondition: AcquisitionConditionRequest;
    /**
     * URL of the barcode image associated with the coupon. Used for in-store redemption.
     */
    barcodeImageUrl?: string;
    /**
     * Unique code to be presented by the user to redeem the coupon. Optional.
     */
    couponCode?: string;
    /**
     * Detailed description of the coupon. Displayed to users.
     * Minimum length: 0
     * Maximum length: 1000
     */
    description?: string;
    /**
     * Coupon expiration time (epoch seconds). Coupon cannot be used after this time.
     */
    endTimestamp: number;
    /**
     * URL of the main image representing the coupon. Displayed in the coupon list.
     */
    imageUrl?: string;
    /**
     * Maximum number of times a single coupon ticket can be used. Use -1 to indicate no limit.
     * Maximum: 1
     */
    maxUseCountPerTicket: number;
    /**
     * Coupon start time (epoch seconds). Coupon can be used from this time.
     */
    startTimestamp: number;
    /**
     * Title of the coupon. Displayed in the coupon list.
     * Minimum length: 1
     * Maximum length: 60
     */
    title: string;
    /**
     * Conditions for using the coupon. Shown to users.
     * Minimum length: 0
     * Maximum length: 100
     */
    usageCondition?: string;
    reward?: CouponRewardRequest;
    /**
     * Visibility of the coupon. Determines who can see or acquire the coupon.
     */
    visibility: CouponCreateRequest.VisibilityEnum;
    /**
     * Timezone for interpreting start and end timestamps.
     */
    timezone: CouponCreateRequest.TimezoneEnum;
};

Request object for creating a coupon. Contains all configurable coupon properties.

type CouponCreateResponse

type CouponCreateResponse = {
    /**
     * Unique identifier of the coupon.
     */
    couponId: string;
};

Response object returned after creating a coupon. Contains the coupon ID.

type CouponDiscountRewardRequest

type CouponDiscountRewardRequest = CouponRewardRequestBase & {
    type: 'discount';
    priceInfo?: DiscountPriceInfoRequest;
};

type CouponDiscountRewardResponse

type CouponDiscountRewardResponse = CouponRewardResponseBase & {
    type: 'discount';
    priceInfo?: DiscountPriceInfoResponse;
};

type CouponFreeRewardRequest

type CouponFreeRewardRequest = CouponRewardRequestBase & {
    type: 'free';
};

type CouponFreeRewardResponse

type CouponFreeRewardResponse = CouponRewardResponseBase & {
    type: 'free';
};

type CouponGiftRewardRequest

type CouponGiftRewardRequest = CouponRewardRequestBase & {
    type: 'gift';
};

type CouponGiftRewardResponse

type CouponGiftRewardResponse = CouponRewardResponseBase & {
    type: 'gift';
};

type CouponListResponse

type CouponListResponse = {
    /**
     * Unique identifier of the coupon.
     */
    couponId: string;
    /**
     * Title of the coupon. Displayed in the coupon list.
     */
    title: string;
};

Summary information about a coupon, used in coupon lists.

type CouponMessage

type CouponMessage = MessageBase & {
    type: 'coupon';
    /**
     * Unique identifier of the coupon.
     */
    couponId: string;
    /**
     * Delivery route tag information. It can be used for analysis in LINE OA Manager.
     * Maximum length: 30
     */
    deliveryTag?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#coupon-message

type CouponOthersRewardRequest

type CouponOthersRewardRequest = CouponRewardRequestBase & {
    type: 'others';
};

type CouponOthersRewardResponse

type CouponOthersRewardResponse = CouponRewardResponseBase & {
    type: 'others';
};

type CouponResponse

type CouponResponse = {
    acquisitionCondition?: AcquisitionConditionResponse;
    /**
     * URL of the barcode image associated with the coupon. Used for in-store redemption.
     */
    barcodeImageUrl?: string;
    /**
     * Unique code to be presented by the user to redeem the coupon.
     */
    couponCode?: string;
    /**
     * Detailed description of the coupon. Displayed to users.
     */
    description?: string;
    /**
     * Coupon expiration time (epoch seconds). Coupon cannot be used after this time.
     */
    endTimestamp?: number;
    /**
     * URL of the main image representing the coupon. Displayed in the coupon list.
     */
    imageUrl?: string;
    /**
     * Maximum number of coupons that can be issued in total.
     */
    maxAcquireCount?: number;
    /**
     * Maximum number of times a single coupon ticket can be used.
     */
    maxUseCountPerTicket?: number;
    /**
     * Maximum number of coupon tickets a single user can acquire.
     */
    maxTicketPerUser?: number;
    /**
     * Coupon start time (epoch seconds). Coupon can be used from this time.
     */
    startTimestamp?: number;
    /**
     * Title of the coupon. Displayed in the coupon list.
     */
    title?: string;
    /**
     * Conditions for using the coupon. Shown to users.
     */
    usageCondition?: string;
    reward?: CouponRewardResponse;
    /**
     * Visibility of the coupon. Determines who can see or acquire the coupon.
     */
    visibility?: CouponResponse.VisibilityEnum;
    /**
     * Timezone for interpreting start and end timestamps.
     */
    timezone?: CouponResponse.TimezoneEnum;
    /**
     * Unique identifier of the coupon.
     */
    couponId?: string;
    /**
     * Created timestamp (seconds) of the coupon.
     */
    createdTimestamp?: number;
    /**
     * Current status of the coupon.
     */
    status?: CouponResponse.StatusEnum;
};

Detailed information about a coupon, including all properties and current status.

type CouponRewardRequest

type CouponRewardRequest =
    | CouponCashBackRewardRequest
    | CouponDiscountRewardRequest
    | CouponFreeRewardRequest
    | CouponGiftRewardRequest
    | CouponOthersRewardRequest;

type CouponRewardRequestBase

type CouponRewardRequestBase = {
    /**
     * Type of coupon. Determines the benefit provided.
     */
    type: string;
};

type CouponRewardResponse

type CouponRewardResponse =
    | CouponCashBackRewardResponse
    | CouponDiscountRewardResponse
    | CouponFreeRewardResponse
    | CouponGiftRewardResponse
    | CouponOthersRewardResponse;

type CouponRewardResponseBase

type CouponRewardResponseBase = {
    /**
     * Type of coupon. Determines the benefit provided.
     */
    type: string;
};

type CreateRichMenuAliasRequest

type CreateRichMenuAliasRequest = {
    /**
     * Rich menu alias ID, which can be any ID, unique for each channel.
     * Minimum length: 1
     * Maximum length: 32
     * Pattern: /^[a-z0-9_-]{1,32}$/
     */
    richMenuAliasId: string;
    /**
     * The rich menu ID to be associated with the rich menu alias.
     */
    richMenuId: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#create-rich-menu-alias

type DatetimePickerAction

type DatetimePickerAction = ActionBase & {
    type: 'datetimepicker';
    /**
     * Minimum length: 0
     * Maximum length: 300
     */
    data?: string;
    mode?: DatetimePickerAction.ModeEnum;
    initial?: string;
    max?: string;
    min?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#datetime-picker-action

type DemographicFilter

type DemographicFilter =
    | AgeDemographicFilter
    | AppTypeDemographicFilter
    | AreaDemographicFilter
    | GenderDemographicFilter
    | OperatorDemographicFilter
    | SubscriptionPeriodDemographicFilter;

Demographic filter

type DemographicFilterBase

type DemographicFilterBase = {
    /**
     * Type of demographic filter
     */
    type?: string;
};

type DiscountExplicitPriceInfoRequest

type DiscountExplicitPriceInfoRequest = DiscountPriceInfoRequestBase & {
    type: 'explicit';
    priceAfterDiscount?: number;
    originalPrice?: number;
};

type DiscountExplicitPriceInfoResponse

type DiscountExplicitPriceInfoResponse = DiscountPriceInfoResponseBase & {
    type: 'explicit';
    /**
     * Currency code (e.g., JPY, THB, TWD).
     */
    currency?: DiscountExplicitPriceInfoResponse.CurrencyEnum;
    priceAfterDiscount?: number;
    originalPrice?: number;
};

type DiscountFixedPriceInfoRequest

type DiscountFixedPriceInfoRequest = DiscountPriceInfoRequestBase & {
    type: 'fixed';
    fixedAmount?: number;
};

type DiscountFixedPriceInfoResponse

type DiscountFixedPriceInfoResponse = DiscountPriceInfoResponseBase & {
    type: 'fixed';
    /**
     * Currency code (e.g., JPY, THB, TWD).
     */
    currency?: DiscountFixedPriceInfoResponse.CurrencyEnum;
    fixedAmount?: number;
};

type DiscountPercentagePriceInfoRequest

type DiscountPercentagePriceInfoRequest = DiscountPriceInfoRequestBase & {
    type: 'percentage';
    /**
     * Specifies the discount rate as a percentage. Must be an integer between 1 and 99.
     * Minimum: 1
     * Maximum: 99
     */
    percentage?: number;
};

type DiscountPercentagePriceInfoResponse

type DiscountPercentagePriceInfoResponse = DiscountPriceInfoResponseBase & {
    type: 'percentage';
    percentage?: number;
};

type DiscountPriceInfoRequest

type DiscountPriceInfoRequest =
    | DiscountExplicitPriceInfoRequest
    | DiscountFixedPriceInfoRequest
    | DiscountPercentagePriceInfoRequest;

type DiscountPriceInfoRequestBase

type DiscountPriceInfoRequestBase = {
    type: string;
};

type DiscountPriceInfoResponse

type DiscountPriceInfoResponse =
    | DiscountExplicitPriceInfoResponse
    | DiscountFixedPriceInfoResponse
    | DiscountPercentagePriceInfoResponse;

type DiscountPriceInfoResponseBase

type DiscountPriceInfoResponseBase = {
    type: string;
};

type Emoji

type Emoji = {
    index?: number;
    productId?: string;
    emojiId?: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type EmojiSubstitutionObject

type EmojiSubstitutionObject = SubstitutionObjectBase & {
    type: 'emoji';
    productId: string;
    emojiId: string;
};

An object representing a emoji substitution.
See Also
- https://developers.line.biz/en/reference/messaging-api/#text-message-v2-emoji-object

type ErrorDetail

type ErrorDetail = {
    /**
     * Details of the error. Not included in the response under certain situations.
     */
    message?: string;
    /**
     * Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.
     */
    property?: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type ErrorResponse

type ErrorResponse = {
    /**
     * Message containing information about the error.
     */
    message: string;
    /**
     * An array of error details. If the array is empty, this property will not be included in the response.
     */
    details?: Array<ErrorDetail>;
    /**
     * Array of sent messages.
     * Minimum items: 1
     * Maximum items: 5
     */
    sentMessages?: Array<SentMessage>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#error-responses

type Filter

type Filter = {
    demographic?: DemographicFilter;
};

Filter for narrowcast

type FlexBlockStyle

type FlexBlockStyle = {
    backgroundColor?: string;
    separator?: boolean;
    separatorColor?: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type FlexBox

type FlexBox = FlexComponentBase & {
    type: 'box';
    layout: FlexBox.LayoutEnum;
    flex?: number;
    contents: Array<FlexComponent>;
    spacing?: string;
    margin?: string;
    position?: FlexBox.PositionEnum;
    offsetTop?: string;
    offsetBottom?: string;
    offsetStart?: string;
    offsetEnd?: string;
    backgroundColor?: string;
    borderColor?: string;
    borderWidth?: string;
    cornerRadius?: string;
    width?: string;
    maxWidth?: string;
    height?: string;
    maxHeight?: string;
    paddingAll?: string;
    paddingTop?: string;
    paddingBottom?: string;
    paddingStart?: string;
    paddingEnd?: string;
    action?: Action;
    justifyContent?: FlexBox.JustifyContentEnum;
    alignItems?: FlexBox.AlignItemsEnum;
    background?: FlexBoxBackground;
};

type FlexBoxBackground

type FlexBoxBackground = FlexBoxLinearGradient;

type FlexBoxBackgroundBase

type FlexBoxBackgroundBase = {
    type: string;
};

type FlexBoxBorderWidth

type FlexBoxBorderWidth =
    | 'none'
    | 'light'
    | 'normal'
    | 'medium'
    | 'semi-bold'
    | 'bold';

Width of box border. This is only for borderWidth in FlexBox. A value of none means that borders are not rendered; the other values are listed in order of increasing width.

type FlexBoxCornerRadius

type FlexBoxCornerRadius = 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';

Radius at the time of rounding the corners of the box. This is only for cornerRadius in FlexBox. A value of none means that corners are not rounded; the other values are listed in order of increasing radius.

type FlexBoxLinearGradient

type FlexBoxLinearGradient = FlexBoxBackgroundBase & {
    type: 'linearGradient';
    angle?: string;
    startColor?: string;
    endColor?: string;
    centerColor?: string;
    centerPosition?: string;
};

type FlexBoxPadding

type FlexBoxPadding = 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';

Padding can be specified in pixels, percentage (to the parent box width) or with a keyword. FlexBoxPadding just provides only keywords.

type FlexBoxSpacing

type FlexBoxSpacing = 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';

You can specify the minimum space between two components with the spacing property of the parent box component, in pixels or with a keyword. FlexBoxSpacing just provides only keywords.

type FlexBubble

type FlexBubble = FlexContainerBase & {
    type: 'bubble';
    direction?: FlexBubble.DirectionEnum;
    styles?: FlexBubbleStyles;
    header?: FlexBox;
    hero?: FlexComponent;
    body?: FlexBox;
    footer?: FlexBox;
    size?: FlexBubble.SizeEnum;
    action?: Action;
};

type FlexBubbleStyles

type FlexBubbleStyles = {
    header?: FlexBlockStyle;
    hero?: FlexBlockStyle;
    body?: FlexBlockStyle;
    footer?: FlexBlockStyle;
};

type FlexButton

type FlexButton = FlexComponentBase & {
    type: 'button';
    flex?: number;
    color?: string;
    style?: FlexButton.StyleEnum;
    action: Action;
    gravity?: FlexButton.GravityEnum;
    margin?: string;
    position?: FlexButton.PositionEnum;
    offsetTop?: string;
    offsetBottom?: string;
    offsetStart?: string;
    offsetEnd?: string;
    height?: FlexButton.HeightEnum;
    adjustMode?: FlexButton.AdjustModeEnum;
    scaling?: boolean;
};

type FlexCarousel

type FlexCarousel = FlexContainerBase & {
    type: 'carousel';
    contents: Array<FlexBubble>;
};

type FlexComponent

type FlexComponent =
    | FlexBox
    | FlexButton
    | FlexFiller
    | FlexIcon
    | FlexImage
    | FlexSeparator
    | FlexSpan
    | FlexText
    | FlexVideo;

type FlexComponentBase

type FlexComponentBase = {
    type: string;
};

type FlexContainer

type FlexContainer = FlexBubble | FlexCarousel;

type FlexContainerBase

type FlexContainerBase = {
    type: string;
};

type FlexFiller

type FlexFiller = FlexComponentBase & {
    type: 'filler';
    flex?: number;
};

type FlexIcon

type FlexIcon = FlexComponentBase & {
    type: 'icon';
    url: string;
    size?: string;
    aspectRatio?: string;
    margin?: string;
    position?: FlexIcon.PositionEnum;
    offsetTop?: string;
    offsetBottom?: string;
    offsetStart?: string;
    offsetEnd?: string;
    scaling?: boolean;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#icon

type FlexIconSize

type FlexIconSize =
    | 'xxs'
    | 'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'
    | 'xxl'
    | '3xl'
    | '4xl'
    | '5xl';

You can set the width of an Flex icon component with the size property, in pixels, as a percentage, or with a keyword. FlexIconSize just provides only keywords.

type FlexImage

type FlexImage = FlexComponentBase & {
    type: 'image';
    /**
     * Image URL (Max character limit: 2000) Protocol: HTTPS (TLS 1.2 or later) Image format: JPEG or PNG Maximum image size: 1024×1024 pixels Maximum file size: 10 MB (300 KB when the animated property is true)
     */
    url: string;
    /**
     * The ratio of the width or height of this component within the parent box.
     */
    flex?: number;
    /**
     * The minimum amount of space to include before this component in its parent container.
     */
    margin?: string;
    /**
     * Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values:  `relative`: Use the previous box as reference. `absolute`: Use the top left of parent element as reference. The default value is relative.
     */
    position?: FlexImage.PositionEnum;
    /**
     * Offset.
     */
    offsetTop?: string;
    /**
     * Offset.
     */
    offsetBottom?: string;
    /**
     * Offset.
     */
    offsetStart?: string;
    /**
     * Offset.
     */
    offsetEnd?: string;
    /**
     * Alignment style in horizontal direction.
     */
    align?: FlexImage.AlignEnum;
    /**
     * Alignment style in vertical direction.
     */
    gravity?: FlexImage.GravityEnum;
    /**
     * The maximum image width. This is md by default.
     * Default: 'md'
     */
    size?: string;
    /**
     * Aspect ratio of the image. `{width}:{height}` format. Specify the value of `{width}` and `{height}` in the range from `1` to `100000`. However, you cannot set `{height}` to a value that is more than three times the value of `{width}`. The default value is `1:1`.
     */
    aspectRatio?: string;
    /**
     * The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match.
     */
    aspectMode?: FlexImage.AspectModeEnum;
    /**
     * Background color of the image. Use a hexadecimal color code.
     */
    backgroundColor?: string;
    action?: Action;
    /**
     * When this is `true`, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This is `false` by default. Animated images larger than 300 KB aren't played back.
     * Default: false
     */
    animated?: boolean;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#f-image

type FlexImageSize

type FlexImageSize =
    | 'xxs'
    | 'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'
    | 'xxl'
    | '3xl'
    | '4xl'
    | '5xl'
    | 'full';

You can set the width of an Flex image component with the size property, in pixels, as a percentage, or with a keyword. FlexImageSize just provides only keywords.

type FlexMargin

type FlexMargin = 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';

You can specify the minimum space before a child component with the margin property of the child component, in pixels or with a keyword. FlexMargin just provides only keywords.

type FlexMessage

type FlexMessage = MessageBase & {
    type: 'flex';
    altText: string;
    contents: FlexContainer;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#flex-message

type FlexOffset

type FlexOffset = 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';

You can specify the offset of a component with the offset* property, in pixels or with a keyword. You can also specify the percentage to the box width for offsetStart and offsetEnd and to the box height for offsetTop and offsetBottom. FlexOffset just provides only keywords.

type FlexSeparator

type FlexSeparator = FlexComponentBase & {
    type: 'separator';
    margin?: string;
    color?: string;
};

type FlexSpan

type FlexSpan = FlexComponentBase & {
    type: 'span';
    text?: string;
    size?: string;
    color?: string;
    weight?: FlexSpan.WeightEnum;
    style?: FlexSpan.StyleEnum;
    decoration?: FlexSpan.DecorationEnum;
};

type FlexSpanSize

type FlexSpanSize =
    | 'xxs'
    | 'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'
    | 'xxl'
    | '3xl'
    | '4xl'
    | '5xl';

Font size in the size property of the Flex span component. You can specify the size in pixels or with a keyword. FlexSpanSize just provides only keywords.

type FlexText

type FlexText = FlexComponentBase & {
    type: 'text';
    flex?: number;
    text?: string;
    size?: string;
    align?: FlexText.AlignEnum;
    gravity?: FlexText.GravityEnum;
    color?: string;
    weight?: FlexText.WeightEnum;
    style?: FlexText.StyleEnum;
    decoration?: FlexText.DecorationEnum;
    wrap?: boolean;
    lineSpacing?: string;
    margin?: string;
    position?: FlexText.PositionEnum;
    offsetTop?: string;
    offsetBottom?: string;
    offsetStart?: string;
    offsetEnd?: string;
    action?: Action;
    maxLines?: number;
    contents?: Array<FlexSpan>;
    adjustMode?: FlexText.AdjustModeEnum;
    scaling?: boolean;
};

type FlexTextFontSize

type FlexTextFontSize =
    | 'xxs'
    | 'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'
    | 'xxl'
    | '3xl'
    | '4xl'
    | '5xl';

Font size in the size property of the Flex text component. You can specify the size in pixels or with a keyword. FlexTextFontSize just provides only keywords.

type FlexVideo

type FlexVideo = FlexComponentBase & {
    type: 'video';
    url: string;
    previewUrl: string;
    altContent: FlexComponent;
    aspectRatio?: string;
    action?: Action;
};

type GenderDemographic

type GenderDemographic = 'male' | 'female';

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type GenderDemographicFilter

type GenderDemographicFilter = DemographicFilterBase & {
    type: 'gender';
    oneOf?: Array<GenderDemographic>;
};

type GetAggregationUnitNameListResponse

type GetAggregationUnitNameListResponse = {
    /**
     * An array of strings indicating the names of aggregation units used this month.
     */
    customAggregationUnits: Array<string>;
    /**
     * A continuation token to get the next array of unit names. Returned only when there are remaining aggregation units that weren't returned in customAggregationUnits in the original request.
     */
    next?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-name-list-of-units-used-this-month

type GetAggregationUnitUsageResponse

type GetAggregationUnitUsageResponse = {
    /**
     * Number of aggregation units used this month.
     */
    numOfCustomAggregationUnits: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-number-of-units-used-this-month

type GetFollowersResponse

type GetFollowersResponse = {
    /**
     * An array of strings indicating user IDs of users that have added the LINE Official Account as a friend. Only users of LINE for iOS and LINE for Android are included in `userIds`.
     * Maximum items: 1000
     */
    userIds: Array<string>;
    /**
     * A continuation token to get the next array of user IDs. Returned only when there are remaining user IDs that weren't returned in `userIds` in the original request. The number of user IDs in the `userIds` element doesn't have to reach the maximum number specified by `limit` for the `next` property to be included in the response.
     */
    next?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-follower-ids

type GetJoinedMembershipUsersResponse

type GetJoinedMembershipUsersResponse = {
    /**
     * A list of user IDs who joined the membership. Users who have not agreed to the bot user agreement, are not following the bot, or are not active will be excluded. If there are no users in the membership, an empty list will be returned.
     * Maximum items: 1000
     */
    userIds: Array<string>;
    /**
     * A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).
     */
    next?: string;
};

List of users who have joined the membership
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-membership-user-ids

type GetMembershipSubscriptionResponse

type GetMembershipSubscriptionResponse = {
    /**
     * List of subscription information
     * Minimum items: 0
     */
    subscriptions: Array<Subscription>;
};

A user's membership subscription status
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status

type GetMessageContentTranscodingResponse

type GetMessageContentTranscodingResponse = {
    /**
     * The preparation status. One of:  `processing`: Preparing to get content. `succeeded`: Ready to get the content. You can get the content sent by users. `failed`: Failed to prepare to get the content.
     */
    status: GetMessageContentTranscodingResponse.StatusEnum;
};

Transcoding response
See Also
- https://developers.line.biz/en/reference/messaging-api/#verify-video-or-audio-preparation-status

type GetWebhookEndpointResponse

type GetWebhookEndpointResponse = {
    /**
     * Webhook URL
     */
    endpoint: string;
    /**
     * Webhook usage status. Send a webhook event from the LINE Platform to the webhook URL only if enabled.  `true`: Webhook usage is enabled. `false`: Webhook usage is disabled.
     */
    active: boolean;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-webhook-endpoint-information

type GroupMemberCountResponse

type GroupMemberCountResponse = {
    /**
     * The count of members in the group chat. The number returned excludes the LINE Official Account.
     */
    count: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-members-group-count

type GroupSummaryResponse

type GroupSummaryResponse = {
    /**
     * Group ID
     */
    groupId: string;
    /**
     * Group name
     */
    groupName: string;
    /**
     * Group icon URL. Not included in the response if the user doesn't set a group profile icon.
     */
    pictureUrl?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-group-summary

type GroupUserProfileResponse

type GroupUserProfileResponse = {
    /**
     * User's display name
     */
    displayName: string;
    /**
     * User ID
     */
    userId: string;
    /**
     * Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image.
     */
    pictureUrl?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-group-member-profile

type ImageCarouselColumn

type ImageCarouselColumn = {
    imageUrl: string;
    action: Action;
};

type ImageCarouselTemplate

type ImageCarouselTemplate = TemplateBase & {
    type: 'image_carousel';
    columns: Array<ImageCarouselColumn>;
};

type ImagemapAction

type ImagemapAction =
    | ClipboardImagemapAction
    | MessageImagemapAction
    | URIImagemapAction;

See Also
- https://developers.line.biz/en/reference/messaging-api/#imagemap-action-objects

type ImagemapActionBase

type ImagemapActionBase = {
    type: string;
    area: ImagemapArea;
};

type ImagemapArea

type ImagemapArea = {
    x: number;
    y: number;
    width: number;
    height: number;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type ImagemapBaseSize

type ImagemapBaseSize = {
    height: number;
    width: number;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type ImagemapExternalLink

type ImagemapExternalLink = {
    linkUri?: string;
    label?: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type ImagemapMessage

type ImagemapMessage = MessageBase & {
    type: 'imagemap';
    baseUrl: string;
    altText: string;
    baseSize: ImagemapBaseSize;
    actions: Array<ImagemapAction>;
    video?: ImagemapVideo;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#imagemap-message

type ImagemapVideo

type ImagemapVideo = {
    originalContentUrl?: string;
    previewImageUrl?: string;
    area?: ImagemapArea;
    externalLink?: ImagemapExternalLink;
};

type ImageMessage

type ImageMessage = MessageBase & {
    type: 'image';
    originalContentUrl: string;
    previewImageUrl: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#image-message

type IssueLinkTokenResponse

type IssueLinkTokenResponse = {
    /**
     * Link token. Link tokens are valid for 10 minutes and can only be used once.
     */
    linkToken: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#issue-link-token

type Limit

type Limit = {
    /**
     * The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random.
     * Minimum: 1
     */
    max?: number;
    /**
     * If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`.  Targets will be selected at random.
     * Default: false
     */
    upToRemainingQuota?: boolean;
    /**
     * This option prevents messages from being delivered to only a subset of the target audience. If true, the narrowcast request success but fails asynchronously. You can check whether message delivery was canceled by retrieving the narrowcast message progress.  This property can be set to true only if upToRemainingQuota is set to true.
     * Default: false
     */
    forbidPartialDelivery?: boolean;
};

Limit of the Narrowcast
See Also
- https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message

type LocationAction

type LocationAction = ActionBase & {
    type: 'location';
};

type LocationMessage

type LocationMessage = MessageBase & {
    type: 'location';
    title: string;
    address: string;
    latitude: number;
    longitude: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#location-message

type LotteryAcquisitionConditionRequest

type LotteryAcquisitionConditionRequest = AcquisitionConditionRequestBase & {
    type: 'lottery';
    /**
     * Probability (1-99) of winning the coupon in lottery-type campaigns.
     * Minimum: 1
     * Maximum: 99
     */
    lotteryProbability: number;
    /**
     * Maximum number of coupons that can be issued in total. Use -1 to indicate no limit
     * Maximum: 999999
     */
    maxAcquireCount: number;
};

type LotteryAcquisitionConditionResponse

type LotteryAcquisitionConditionResponse = AcquisitionConditionResponseBase & {
    type: 'lottery';
    lotteryProbability?: number;
    maxAcquireCount?: number;
};

type MarkMessagesAsReadByTokenRequest

type MarkMessagesAsReadByTokenRequest = {
    /**
     * Token used to mark messages as read.
     */
    markAsReadToken: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#mark-as-read-request-body

type MarkMessagesAsReadRequest

type MarkMessagesAsReadRequest = {
    chat: ChatReference;
};

See Also
- https://developers.line.biz/en/reference/partner-docs/#mark-messages-from-users-as-read

type Membership

type Membership = {
    /**
     * Membership plan ID.
     */
    membershipId: number;
    /**
     * Membership plan name.
     */
    title: string;
    /**
     * Membership plan description.
     */
    description: string;
    /**
     * List of membership plan perks.
     * Minimum items: 1
     */
    benefits: Array<string>;
    /**
     * Monthly fee for membership plan. (e.g. 1500.00)
     */
    price: number;
    /**
     * The currency of membership.price.
     */
    currency: Membership.CurrencyEnum;
    /**
     * Number of members subscribed to the membership plan.
     */
    memberCount: number;
    /**
     * The upper limit of members who can subscribe. If no upper limit is set, it will be null.
     */
    memberLimit: number | null;
    /**
     * Payment method for users who subscribe to a membership plan.
     */
    isInAppPurchase: boolean;
    /**
     * Membership plan status.
     */
    isPublished: boolean;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type MembershipListResponse

type MembershipListResponse = {
    /**
     * List of membership information
     * Minimum items: 0
     */
    memberships: Array<Membership>;
};

List of memberships

type MembersIdsResponse

type MembersIdsResponse = {
    /**
     * List of user IDs of members in the group chat. Only users of LINE for iOS and LINE for Android are included in `memberIds`.
     * Maximum items: 100
     */
    memberIds: Array<string>;
    /**
     * A continuation token to get the next array of user IDs of the members in the group chat. Returned only when there are remaining user IDs that were not returned in `memberIds` in the original request.
     */
    next?: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type MentionSubstitutionObject

type MentionSubstitutionObject = SubstitutionObjectBase & {
    type: 'mention';
    mentionee: MentionTarget;
};

An object representing a mention substitution.
See Also
- https://developers.line.biz/en/reference/messaging-api/#text-message-v2-mention-object

type MentionTarget

type MentionTarget = AllMentionTarget | UserMentionTarget;

type MentionTargetBase

type MentionTargetBase = {
    /**
     * Target to be mentioned
     */
    type: string;
};

type Message

type Message =
    | AudioMessage
    | CouponMessage
    | FlexMessage
    | ImageMessage
    | ImagemapMessage
    | LocationMessage
    | StickerMessage
    | TemplateMessage
    | TextMessage
    | TextMessageV2
    | VideoMessage;

See Also
- https://developers.line.biz/en/reference/messaging-api/#message-common-properties

type MessageAction

type MessageAction = ActionBase & {
    type: 'message';
    text?: string;
};

type MessageBase

type MessageBase = {
    /**
     * Type of message
     */
    type: string;
    quickReply?: QuickReply;
    sender?: Sender;
};

type MessageImagemapAction

type MessageImagemapAction = ImagemapActionBase & {
    type: 'message';
    text: string;
    label?: string;
};

type MessageQuotaResponse

type MessageQuotaResponse = {
    type: QuotaType;
    /**
     * The target limit for sending messages in the current month. This property is returned when the `type` property has a value of `limited`.
     */
    value?: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-quota

type MessagingApiPagerCouponListResponse

type MessagingApiPagerCouponListResponse = {
    /**
     * List of coupon summary objects.
     */
    items: Array<CouponListResponse>;
    /**
     * Token for fetching the next page of results.
     */
    next?: string;
};

Paginated response object containing a list of coupons.

type MulticastRequest

type MulticastRequest = {
    /**
     * Messages to send
     * Minimum items: 1
     * Maximum items: 5
     */
    messages: Array<Message>;
    /**
     * Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE.
     * Minimum items: 1
     * Maximum items: 500
     */
    to: Array<string>;
    /**
     * `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.
     * Default: false
     */
    notificationDisabled?: boolean;
    /**
     * Name of aggregation unit. Case-sensitive.
     * Maximum items: 1
     */
    customAggregationUnits?: Array<string>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#send-multicast-message

type NarrowcastProgressResponse

type NarrowcastProgressResponse = {
    /**
     * The current status. One of:  `waiting`: Messages are not yet ready to be sent. They are currently being filtered or processed in some way. `sending`: Messages are currently being sent. `succeeded`: Messages were sent successfully. This may not mean the messages were successfully received. `failed`: Messages failed to be sent. Use the failedDescription property to find the cause of the failure.
     */
    phase: NarrowcastProgressResponse.PhaseEnum;
    /**
     * The number of users who successfully received the message.
     */
    successCount?: number;
    /**
     * The number of users who failed to send the message.
     */
    failureCount?: number;
    /**
     * The number of intended recipients of the message.
     */
    targetCount?: number;
    /**
     * The reason the message failed to be sent. This is only included with a `phase` property value of `failed`.
     */
    failedDescription?: string;
    /**
     * Error summary. This is only included with a phase property value of failed. One of:  `1`: An internal error occurred. `2`: An error occurred because there weren't enough recipients. `3`: A conflict error of requests occurs because a request that has already been accepted is retried. `4`: An audience of less than 50 recipients is included as a condition of sending. `5`: Message delivery has been canceled to prevent messages from being delivered only to a subset of the target audience.
     */
    errorCode?: number;
    /**
     * Narrowcast message request accepted time in milliseconds.  Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC
     */
    acceptedTime: Date;
    /**
     * Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed.  Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC
     */
    completedTime?: Date;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status

type NarrowcastRequest

type NarrowcastRequest = {
    /**
     * List of Message objects.
     * Minimum items: 1
     * Maximum items: 5
     */
    messages: Array<Message>;
    recipient?: Recipient;
    filter?: Filter;
    limit?: Limit;
    /**
     * `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.
     * Default: false
     */
    notificationDisabled?: boolean;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message

type NormalAcquisitionConditionRequest

type NormalAcquisitionConditionRequest = AcquisitionConditionRequestBase & {
    type: 'normal';
};

type NormalAcquisitionConditionResponse

type NormalAcquisitionConditionResponse = AcquisitionConditionResponseBase & {
    type: 'normal';
};

type NumberOfMessagesResponse

type NumberOfMessagesResponse = {
    /**
     * Aggregation process status. One of:  `ready`: The number of messages can be obtained. `unready`: We haven't finished calculating the number of sent messages for the specified in date. For example, this property is returned when the delivery date or a future date is specified. Calculation usually takes about a day. `unavailable_for_privacy`: The total number of messages on the specified day is less than 20. `out_of_service`: The specified date is earlier than the date on which we first started calculating sent messages (March 31, 2018).
     */
    status: NumberOfMessagesResponse.StatusEnum;
    /**
     * The number of messages delivered using the phone number on the date specified in `date`. The response has this property only when the value of `status` is `ready`.
     */
    success?: number;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type OperatorDemographicFilter

type OperatorDemographicFilter = DemographicFilterBase & {
    type: 'operator';
    and?: Array<DemographicFilter>;
    or?: Array<DemographicFilter>;
    not?: DemographicFilter;
};

type OperatorRecipient

type OperatorRecipient = RecipientBase & {
    type: 'operator';
    /**
     * Create a new recipient object by taking the logical conjunction (AND) of the specified array of recipient objects.
     */
    and?: Array<Recipient>;
    /**
     * Create a new recipient object by taking the logical disjunction (OR) of the specified array of recipient objects.
     */
    or?: Array<Recipient>;
    not?: Recipient;
};

type PnpMessagesRequest

type PnpMessagesRequest = {
    /**
     * Message to be sent.
     * Minimum items: 1
     * Maximum items: 5
     */
    messages: Array<Message>;
    /**
     * Message destination. Specify a phone number that has been normalized to E.164 format and hashed with SHA256.
     */
    to: string;
    /**
     * `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.
     * Default: false
     */
    notificationDisabled?: boolean;
};

See Also
- https://developers.line.biz/en/reference/partner-docs/#send-line-notification-message

type PostbackAction

type PostbackAction = ActionBase & {
    type: 'postback';
    /**
     * Minimum length: 0
     * Maximum length: 300
     */
    data?: string;
    displayText?: string;
    text?: string;
    inputOption?: PostbackAction.InputOptionEnum;
    fillInText?: string;
};

type PushMessageRequest

type PushMessageRequest = {
    /**
     * ID of the receiver.
     */
    to: string;
    /**
     * List of Message objects.
     * Minimum items: 1
     * Maximum items: 5
     */
    messages: Array<Message>;
    /**
     * `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.
     * Default: false
     */
    notificationDisabled?: boolean;
    /**
     * List of aggregation unit name. Case-sensitive. This functions can only be used by corporate users who have submitted the required applications.
     */
    customAggregationUnits?: Array<string>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#send-push-message

type PushMessageResponse

type PushMessageResponse = {
    /**
     * Array of sent messages.
     * Minimum items: 1
     * Maximum items: 5
     */
    sentMessages: Array<SentMessage>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#send-push-message-response

type QuickReply

type QuickReply = {
    /**
     * Quick reply button objects.
     * Maximum items: 13
     */
    items?: Array<QuickReplyItem>;
};

Quick reply
See Also
- https://developers.line.biz/en/reference/messaging-api/#items-object

type QuickReplyItem

type QuickReplyItem = {
    /**
     * URL of the icon that is displayed at the beginning of the button
     * Maximum length: 2000
     */
    imageUrl?: string;
    action?: Action;
    /**
     * `action`
     * Default: 'action'
     */
    type?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#items-object

type QuotaConsumptionResponse

type QuotaConsumptionResponse = {
    /**
     * The number of sent messages in the current month
     */
    totalUsage: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-consumption

type QuotaType

type QuotaType = 'none' | 'limited';

One of the following values to indicate whether a target limit is set or not.
See Also
- https://developers.line.biz/en/reference/messaging-api/#get-quota

type Recipient

type Recipient = AudienceRecipient | OperatorRecipient | RedeliveryRecipient;

Recipient

type RecipientBase

type RecipientBase = {
    /**
     * Type of recipient
     */
    type?: string;
};

type RedeliveryRecipient

type RedeliveryRecipient = RecipientBase & {
    type: 'redelivery';
    requestId?: string;
};

type ReferralAcquisitionConditionResponse

type ReferralAcquisitionConditionResponse = AcquisitionConditionResponseBase & {
    type: 'referral';
};

type ReplyMessageRequest

type ReplyMessageRequest = {
    /**
     * replyToken received via webhook.
     */
    replyToken: string;
    /**
     * List of messages.
     * Minimum items: 1
     * Maximum items: 5
     */
    messages: Array<Message>;
    /**
     * `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.
     * Default: false
     */
    notificationDisabled?: boolean;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#send-reply-message

type ReplyMessageResponse

type ReplyMessageResponse = {
    /**
     * Array of sent messages.
     * Minimum items: 1
     * Maximum items: 5
     */
    sentMessages: Array<SentMessage>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#send-reply-message-response

type RichMenuAliasListResponse

type RichMenuAliasListResponse = {
    /**
     * Rich menu aliases.
     */
    aliases: Array<RichMenuAliasResponse>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-list

type RichMenuAliasResponse

type RichMenuAliasResponse = {
    /**
     * Rich menu alias ID.
     */
    richMenuAliasId: string;
    /**
     * The rich menu ID associated with the rich menu alias.
     */
    richMenuId: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type RichMenuArea

type RichMenuArea = {
    bounds?: RichMenuBounds;
    action?: Action;
};

Rich menu area

type RichMenuBatchLinkOperation

type RichMenuBatchLinkOperation = RichMenuBatchOperationBase & {
    type: 'link';
    from: string;
    to: string;
};

Replace the rich menu with the rich menu specified in the to property for all users linked to the rich menu specified in the from property.

type RichMenuBatchOperation

type RichMenuBatchOperation =
    | RichMenuBatchLinkOperation
    | RichMenuBatchUnlinkOperation
    | RichMenuBatchUnlinkAllOperation;

Rich menu operation object represents the batch operation to the rich menu linked to the user.
See Also
- https://developers.line.biz/en/reference/messaging-api/#batch-control-rich-menus-of-users-operations

type RichMenuBatchOperationBase

type RichMenuBatchOperationBase = {
    /**
     * The type of operation to the rich menu linked to the user. One of link, unlink, or unlinkAll.
     */
    type: string;
};

type RichMenuBatchProgressPhase

type RichMenuBatchProgressPhase = 'ongoing' | 'succeeded' | 'failed';

The current status. One of: ongoing: Rich menu batch control is in progress. succeeded: Rich menu batch control is complete. failed: Rich menu batch control failed. This means that the rich menu for one or more users couldn't be controlled. There may also be users whose operations have been successfully completed.

type RichMenuBatchProgressResponse

type RichMenuBatchProgressResponse = {
    phase: RichMenuBatchProgressPhase;
    /**
     * The accepted time in milliseconds of the request of batch control the rich menu.  Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC
     */
    acceptedTime: Date;
    /**
     * The completed time in milliseconds of rich menu batch control. Returned when the phase property is succeeded or failed.  Format: ISO 8601 (e.g. 2023-06-08T10:15:30.121Z) Timezone: UTC
     */
    completedTime?: Date;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-batch-control-rich-menus-progress-status-response

type RichMenuBatchRequest

type RichMenuBatchRequest = {
    /**
     * Array of Rich menu operation object...
     * Maximum items: 1000
     */
    operations: Array<RichMenuBatchOperation>;
    /**
     * Key for retry. Key value is a string matching the regular expression pattern
     * Minimum length: 1
     * Maximum length: 100
     * Pattern: /^[a-zA-Z0-9_-]{1,100}$/
     */
    resumeRequestKey?: string;
};

type RichMenuBatchUnlinkAllOperation

type RichMenuBatchUnlinkAllOperation = RichMenuBatchOperationBase & {
    type: 'unlinkAll';
};

Unlink the rich menu from all users linked to the rich menu.

type RichMenuBatchUnlinkOperation

type RichMenuBatchUnlinkOperation = RichMenuBatchOperationBase & {
    type: 'unlink';
    from: string;
};

Unlink the rich menu for all users linked to the rich menu specified in the from property.

type RichMenuBounds

type RichMenuBounds = {
    /**
     * Horizontal position relative to the top-left corner of the area.
     * Minimum: 0
     * Maximum: 2147483647
     */
    x?: number;
    /**
     * Vertical position relative to the top-left corner of the area.
     * Minimum: 0
     * Maximum: 2147483647
     */
    y?: number;
    /**
     * Width of the area.
     * Minimum: 1
     * Maximum: 2147483647
     */
    width?: number;
    /**
     * Height of the area.
     * Minimum: 1
     * Maximum: 2147483647
     */
    height?: number;
};

Rich menu bounds
See Also
- https://developers.line.biz/en/reference/messaging-api/#bounds-object

type RichMenuBulkLinkRequest

type RichMenuBulkLinkRequest = {
    /**
     * ID of a rich menu
     */
    richMenuId: string;
    /**
     * Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
     * Minimum items: 1
     * Maximum items: 500
     */
    userIds: Array<string>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#link-rich-menu-to-users

type RichMenuBulkUnlinkRequest

type RichMenuBulkUnlinkRequest = {
    /**
     * Array of user IDs. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
     * Minimum items: 1
     * Maximum items: 500
     */
    userIds: Array<string>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#unlink-rich-menu-from-users

type RichMenuIdResponse

type RichMenuIdResponse = {
    /**
     * Rich menu ID
     */
    richMenuId: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type RichMenuListResponse

type RichMenuListResponse = {
    /**
     * Rich menus
     */
    richmenus: Array<RichMenuResponse>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-list

type RichMenuRequest

type RichMenuRequest = {
    size?: RichMenuSize;
    /**
     * `true` to display the rich menu by default. Otherwise, `false`.
     */
    selected?: boolean;
    /**
     * Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
     * Maximum length: 300
     */
    name?: string;
    /**
     * Text displayed in the chat bar
     * Maximum length: 14
     */
    chatBarText?: string;
    /**
     * Array of area objects which define the coordinates and size of tappable areas
     */
    areas?: Array<RichMenuArea>;
};

type RichMenuResponse

type RichMenuResponse = {
    /**
     * ID of a rich menu
     */
    richMenuId: string;
    size: RichMenuSize;
    /**
     * `true` to display the rich menu by default. Otherwise, `false`.
     */
    selected: boolean;
    /**
     * Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
     * Maximum length: 300
     */
    name: string;
    /**
     * Text displayed in the chat bar
     * Maximum length: 14
     */
    chatBarText: string;
    /**
     * Array of area objects which define the coordinates and size of tappable areas
     * Maximum items: 20
     */
    areas: Array<RichMenuArea>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#rich-menu-response-object

type RichMenuSize

type RichMenuSize = {
    /**
     * width
     * Minimum: 1
     * Maximum: 2147483647
     */
    width?: number;
    /**
     * height
     * Minimum: 1
     * Maximum: 2147483647
     */
    height?: number;
};

Rich menu size

type RichMenuSwitchAction

type RichMenuSwitchAction = ActionBase & {
    type: 'richmenuswitch';
    /**
     * Minimum length: 0
     * Maximum length: 300
     */
    data?: string;
    /**
     * Minimum length: 0
     * Maximum length: 32
     */
    richMenuAliasId?: string;
};

type RoomMemberCountResponse

type RoomMemberCountResponse = {
    /**
     * The count of members in the multi-person chat. The number returned excludes the LINE Official Account.
     */
    count: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-members-room-count

type RoomUserProfileResponse

type RoomUserProfileResponse = {
    /**
     * User's display name
     */
    displayName: string;
    /**
     * User ID
     */
    userId: string;
    /**
     * Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image.
     */
    pictureUrl?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-room-member-profile

type Sender

type Sender = {
    /**
     * Display name. Certain words such as `LINE` may not be used.
     * Maximum length: 20
     */
    name?: string;
    /**
     * URL of the image to display as an icon when sending a message
     * Maximum length: 2000
     */
    iconUrl?: string;
};

Change icon and display name

type SentMessage

type SentMessage = {
    /**
     * ID of the sent message.
     */
    id: string;
    /**
     * Quote token of the message. Only included when a message object that can be specified as a quote target was sent as a push or reply message.
     */
    quoteToken?: string;
};

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type SetWebhookEndpointRequest

type SetWebhookEndpointRequest = {
    /**
     * A valid webhook URL.
     * Minimum length: 0
     * Maximum length: 500
     */
    endpoint: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#set-webhook-endpoint-url

type ShowLoadingAnimationRequest

type ShowLoadingAnimationRequest = {
    /**
     * User ID of the target user for whom the loading animation is to be displayed.
     */
    chatId: string;
    /**
     * The number of seconds to display the loading indicator. It must be a multiple of 5. The maximum value is 60 seconds.
     * Minimum: 5
     * Maximum: 60
     */
    loadingSeconds?: number;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#display-a-loading-indicator-request-body

type StickerMessage

type StickerMessage = MessageBase & {
    type: 'sticker';
    packageId: string;
    stickerId: string;
    /**
     * Quote token of the message you want to quote.
     */
    quoteToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#sticker-message

type SubscribedMembershipPlan

type SubscribedMembershipPlan = {
    /**
     * Membership plan ID.
     */
    membershipId: number;
    /**
     * Membership plan name.
     */
    title: string;
    /**
     * Membership plan description.
     */
    description: string;
    /**
     * List of membership plan perks.
     * Minimum items: 1
     */
    benefits: Array<string>;
    /**
     * Monthly fee for membership plan. (e.g. 1500.00)
     */
    price: number;
    /**
     * The currency of membership.price.
     */
    currency: SubscribedMembershipPlan.CurrencyEnum;
};

Object containing information about the membership plan.

type SubscribedMembershipUser

type SubscribedMembershipUser = {
    /**
     * The user's member number in the membership plan.
     */
    membershipNo: number;
    /**
     * UNIX timestamp at which the user subscribed to the membership.
     */
    joinedTime: number;
    /**
     * Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9
     */
    nextBillingDate: string;
    /**
     * The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.
     */
    totalSubscriptionMonths: number;
};

Object containing user membership subscription information.

type Subscription

type Subscription = {
    membership: SubscribedMembershipPlan;
    user: SubscribedMembershipUser;
};

An array of memberships.

type SubscriptionPeriodDemographic

type SubscriptionPeriodDemographic =
    | 'day_7'
    | 'day_30'
    | 'day_90'
    | 'day_180'
    | 'day_365';

LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type SubscriptionPeriodDemographicFilter

type SubscriptionPeriodDemographicFilter = DemographicFilterBase & {
    type: 'subscriptionPeriod';
    gte?: SubscriptionPeriodDemographic;
    lt?: SubscriptionPeriodDemographic;
};

type SubstitutionObject

type SubstitutionObject = EmojiSubstitutionObject | MentionSubstitutionObject;

An object that defines the replacement value for a placeholder in the text.

type SubstitutionObjectBase

type SubstitutionObjectBase = {
    /**
     * Type of substitution object
     */
    type: string;
};

type Template

type Template =
    | ButtonsTemplate
    | CarouselTemplate
    | ConfirmTemplate
    | ImageCarouselTemplate;

type TemplateBase

type TemplateBase = {
    type: string;
};

type TemplateImageAspectRatio

type TemplateImageAspectRatio = 'rectangle' | 'square';

Aspect ratio of the image. This is only for the imageAspectRatio in ButtonsTemplate. Specify one of the following values: rectangle: 1.51:1 square: 1:1

type TemplateImageSize

type TemplateImageSize = 'cover' | 'contain';

Size of the image. This is only for the imageSize in ButtonsTemplate. Specify one of the following values: cover: The image fills the entire image area. Parts of the image that do not fit in the area are not displayed. contain: The entire image is displayed in the image area. A background is displayed in the unused areas to the left and right of vertical images and in the areas above and below horizontal images.

type TemplateMessage

type TemplateMessage = MessageBase & {
    type: 'template';
    altText: string;
    template: Template;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#template-messages

type TestWebhookEndpointRequest

type TestWebhookEndpointRequest = {
    /**
     * A webhook URL to be validated.
     * Minimum length: 0
     * Maximum length: 500
     */
    endpoint?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#test-webhook-endpoint

type TestWebhookEndpointResponse

type TestWebhookEndpointResponse = {
    /**
     * Result of the communication from the LINE platform to the webhook URL.
     */
    success?: boolean;
    /**
     * Time of the event in milliseconds. Even in the case of a redelivered webhook, it represents the time the event occurred, not the time it was redelivered.
     */
    timestamp: Date;
    /**
     * The HTTP status code. If the webhook response isn't received, the status code is set to zero or a negative number.
     */
    statusCode: number;
    /**
     * Reason for the response.
     */
    reason: string;
    /**
     * Details of the response.
     */
    detail: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#test-webhook-endpoint

type TextMessage

type TextMessage = MessageBase & {
    type: 'text';
    text: string;
    emojis?: Array<Emoji>;
    /**
     * Quote token of the message you want to quote.
     */
    quoteToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#text-message

type TextMessageV2

type TextMessageV2 = MessageBase & {
    type: 'textV2';
    text: string;
    /**
     * A mapping that specifies substitutions for parts enclosed in {} within the `text` field.
     */
    substitution?: {
        [key: string]: SubstitutionObject;
    };
    /**
     * Quote token of the message you want to quote.
     */
    quoteToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#text-message-v2

type UpdateRichMenuAliasRequest

type UpdateRichMenuAliasRequest = {
    /**
     * The rich menu ID to be associated with the rich menu alias.
     */
    richMenuId: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#update-rich-menu-alias

type URIAction

type URIAction = ActionBase & {
    type: 'uri';
    uri?: string;
    altUri?: AltUri;
};

type URIImagemapAction

type URIImagemapAction = ImagemapActionBase & {
    type: 'uri';
    linkUri: string;
    label?: string;
};

type UserMentionTarget

type UserMentionTarget = MentionTargetBase & {
    type: 'user';
    userId: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#text-message-v2-mentionee-user

type UserProfileResponse

type UserProfileResponse = {
    /**
     * User's display name
     */
    displayName: string;
    /**
     * User ID
     */
    userId: string;
    /**
     * Profile image URL. `https` image URL. Not included in the response if the user doesn't have a profile image.
     */
    pictureUrl?: string;
    /**
     * User's status message. Not included in the response if the user doesn't have a status message.
     */
    statusMessage?: string;
    /**
     * User's language, as a BCP 47 language tag. Not included in the response if the user hasn't yet consented to the LINE Privacy Policy.
     */
    language?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#get-profile

type ValidateMessageRequest

type ValidateMessageRequest = {
    /**
     * Array of message objects to validate
     * Minimum items: 1
     * Maximum items: 5
     */
    messages: Array<Message>;
};

type VideoMessage

type VideoMessage = MessageBase & {
    type: 'video';
    originalContentUrl: string;
    previewImageUrl: string;
    trackingId?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#video-message

namespace messagingApi.AgeDemographicFilter

namespace messagingApi.AgeDemographicFilter {}

namespace messagingApi.BotInfoResponse

namespace messagingApi.BotInfoResponse {}

type ChatModeEnum

type ChatModeEnum = 'chat' | 'bot';

type MarkAsReadModeEnum

type MarkAsReadModeEnum = 'auto' | 'manual';

namespace messagingApi.CashBackFixedPriceInfoResponse

namespace messagingApi.CashBackFixedPriceInfoResponse {}

type CurrencyEnum

type CurrencyEnum = 'JPY' | 'THB' | 'TWD';

namespace messagingApi.CouponCreateRequest

namespace messagingApi.CouponCreateRequest {}

type TimezoneEnum

type TimezoneEnum =
    | 'ETC_GMT_MINUS_12'
    | 'ETC_GMT_MINUS_11'
    | 'PACIFIC_HONOLULU'
    | 'AMERICA_ANCHORAGE'
    | 'AMERICA_LOS_ANGELES'
    | 'AMERICA_PHOENIX'
    | 'AMERICA_CHICAGO'
    | 'AMERICA_NEW_YORK'
    | 'AMERICA_CARACAS'
    | 'AMERICA_SANTIAGO'
    | 'AMERICA_ST_JOHNS'
    | 'AMERICA_SAO_PAULO'
    | 'ETC_GMT_MINUS_2'
    | 'ATLANTIC_CAPE_VERDE'
    | 'EUROPE_LONDON'
    | 'EUROPE_PARIS'
    | 'EUROPE_ISTANBUL'
    | 'EUROPE_MOSCOW'
    | 'ASIA_TEHRAN'
    | 'ASIA_TBILISI'
    | 'ASIA_KABUL'
    | 'ASIA_TASHKENT'
    | 'ASIA_COLOMBO'
    | 'ASIA_KATHMANDU'
    | 'ASIA_ALMATY'
    | 'ASIA_RANGOON'
    | 'ASIA_BANGKOK'
    | 'ASIA_TAIPEI'
    | 'ASIA_TOKYO'
    | 'AUSTRALIA_DARWIN'
    | 'AUSTRALIA_SYDNEY'
    | 'ASIA_VLADIVOSTOK'
    | 'ETC_GMT_PLUS_12'
    | 'PACIFIC_TONGATAPU';

type VisibilityEnum

type VisibilityEnum = 'UNLISTED' | 'PUBLIC';

namespace messagingApi.CouponResponse

namespace messagingApi.CouponResponse {}

type StatusEnum

type StatusEnum = 'DRAFT' | 'RUNNING' | 'CLOSED';

type TimezoneEnum

type TimezoneEnum =
    | 'ETC_GMT_MINUS_12'
    | 'ETC_GMT_MINUS_11'
    | 'PACIFIC_HONOLULU'
    | 'AMERICA_ANCHORAGE'
    | 'AMERICA_LOS_ANGELES'
    | 'AMERICA_PHOENIX'
    | 'AMERICA_CHICAGO'
    | 'AMERICA_NEW_YORK'
    | 'AMERICA_CARACAS'
    | 'AMERICA_SANTIAGO'
    | 'AMERICA_ST_JOHNS'
    | 'AMERICA_SAO_PAULO'
    | 'ETC_GMT_MINUS_2'
    | 'ATLANTIC_CAPE_VERDE'
    | 'EUROPE_LONDON'
    | 'EUROPE_PARIS'
    | 'EUROPE_ISTANBUL'
    | 'EUROPE_MOSCOW'
    | 'ASIA_TEHRAN'
    | 'ASIA_TBILISI'
    | 'ASIA_KABUL'
    | 'ASIA_TASHKENT'
    | 'ASIA_COLOMBO'
    | 'ASIA_KATHMANDU'
    | 'ASIA_ALMATY'
    | 'ASIA_RANGOON'
    | 'ASIA_BANGKOK'
    | 'ASIA_TAIPEI'
    | 'ASIA_TOKYO'
    | 'AUSTRALIA_DARWIN'
    | 'AUSTRALIA_SYDNEY'
    | 'ASIA_VLADIVOSTOK'
    | 'ETC_GMT_PLUS_12'
    | 'PACIFIC_TONGATAPU';

type VisibilityEnum

type VisibilityEnum = 'UNLISTED' | 'PUBLIC' | 'PRIVATE';

namespace messagingApi.DatetimePickerAction

namespace messagingApi.DatetimePickerAction {}

type ModeEnum

type ModeEnum = 'date' | 'time' | 'datetime';

namespace messagingApi.DiscountExplicitPriceInfoResponse

namespace messagingApi.DiscountExplicitPriceInfoResponse {}

type CurrencyEnum

type CurrencyEnum = 'JPY' | 'THB' | 'TWD';

namespace messagingApi.DiscountFixedPriceInfoResponse

namespace messagingApi.DiscountFixedPriceInfoResponse {}

type CurrencyEnum

type CurrencyEnum = 'JPY' | 'THB' | 'TWD';

namespace messagingApi.FlexBox

namespace messagingApi.FlexBox {}

type AlignItemsEnum

type AlignItemsEnum = 'center' | 'flex-start' | 'flex-end';

type JustifyContentEnum

type JustifyContentEnum =
    | 'center'
    | 'flex-start'
    | 'flex-end'
    | 'space-between'
    | 'space-around'
    | 'space-evenly';

type LayoutEnum

type LayoutEnum = 'horizontal' | 'vertical' | 'baseline';

type PositionEnum

type PositionEnum = 'relative' | 'absolute';

namespace messagingApi.FlexBubble

namespace messagingApi.FlexBubble {}

type DirectionEnum

type DirectionEnum = 'ltr' | 'rtl';

type SizeEnum

type SizeEnum = 'nano' | 'micro' | 'deca' | 'hecto' | 'kilo' | 'mega' | 'giga';

namespace messagingApi.FlexButton

namespace messagingApi.FlexButton {}

type AdjustModeEnum

type AdjustModeEnum = 'shrink-to-fit';

type GravityEnum

type GravityEnum = 'top' | 'bottom' | 'center';

type HeightEnum

type HeightEnum = 'md' | 'sm';

type PositionEnum

type PositionEnum = 'relative' | 'absolute';

type StyleEnum

type StyleEnum = 'primary' | 'secondary' | 'link';

namespace messagingApi.FlexIcon

namespace messagingApi.FlexIcon {}

type PositionEnum

type PositionEnum = 'relative' | 'absolute';

namespace messagingApi.FlexImage

namespace messagingApi.FlexImage {}

type AlignEnum

type AlignEnum = 'start' | 'end' | 'center';

type AspectModeEnum

type AspectModeEnum = 'fit' | 'cover';

type GravityEnum

type GravityEnum = 'top' | 'bottom' | 'center';

type PositionEnum

type PositionEnum = 'relative' | 'absolute';

namespace messagingApi.FlexSpan

namespace messagingApi.FlexSpan {}

type DecorationEnum

type DecorationEnum = 'none' | 'underline' | 'line-through';

type StyleEnum

type StyleEnum = 'normal' | 'italic';

type WeightEnum

type WeightEnum = 'regular' | 'bold';

namespace messagingApi.FlexText

namespace messagingApi.FlexText {}

type AdjustModeEnum

type AdjustModeEnum = 'shrink-to-fit';

type AlignEnum

type AlignEnum = 'start' | 'end' | 'center';

type DecorationEnum

type DecorationEnum = 'none' | 'underline' | 'line-through';

type GravityEnum

type GravityEnum = 'top' | 'bottom' | 'center';

type PositionEnum

type PositionEnum = 'relative' | 'absolute';

type StyleEnum

type StyleEnum = 'normal' | 'italic';

type WeightEnum

type WeightEnum = 'regular' | 'bold';

namespace messagingApi.GetMessageContentTranscodingResponse

namespace messagingApi.GetMessageContentTranscodingResponse {}

type StatusEnum

type StatusEnum = 'processing' | 'succeeded' | 'failed';

namespace messagingApi.Membership

namespace messagingApi.Membership {}

type CurrencyEnum

type CurrencyEnum = 'JPY' | 'TWD' | 'THB';

namespace messagingApi.MessageQuotaResponse

namespace messagingApi.MessageQuotaResponse {}

namespace messagingApi.NarrowcastProgressResponse

namespace messagingApi.NarrowcastProgressResponse {}

type PhaseEnum

type PhaseEnum = 'waiting' | 'sending' | 'succeeded' | 'failed';

namespace messagingApi.NumberOfMessagesResponse

namespace messagingApi.NumberOfMessagesResponse {}

type StatusEnum

type StatusEnum = 'ready' | 'unready' | 'unavailable_for_privacy' | 'out_of_service';

namespace messagingApi.PostbackAction

namespace messagingApi.PostbackAction {}

type InputOptionEnum

type InputOptionEnum =
    | 'closeRichMenu'
    | 'openRichMenu'
    | 'openKeyboard'
    | 'openVoice';

namespace messagingApi.RichMenuBatchProgressResponse

namespace messagingApi.RichMenuBatchProgressResponse {}

namespace messagingApi.SubscribedMembershipPlan

namespace messagingApi.SubscribedMembershipPlan {}

type CurrencyEnum

type CurrencyEnum = 'JPY' | 'TWD' | 'THB';

namespace messagingApi.SubscriptionPeriodDemographicFilter

namespace messagingApi.SubscriptionPeriodDemographicFilter {}

namespace moduleAttach

module 'dist/module-attach/api.d.ts' {}

class LineModuleAttachClient

class LineModuleAttachClient {}

See Also
- LineBotClient for a unified interface that wraps this client.

constructor

constructor(config: httpClientConfig);

Initializes a new LineModuleAttachClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://manager.line.biz.
Parameter
config.channelAccessToken The channel access token used for authorization.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new LineModuleAttachClient({ channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!, });

method attachModule

attachModule: (
    grantType: string,
    code: string,
    redirectUri: string,
    codeVerifier?: string,
    clientId?: string,
    clientSecret?: string,
    region?: string,
    basicSearchId?: string,
    scope?: string,
    brandType?: string
) => Promise<AttachModuleResponse>;

Attach by operation of the module channel provider Calls POST https://manager.line.biz/module/auth/v1/token. To inspect the HTTP status code or response headers, use attachModuleWithHttpInfo.
Parameter grantType
authorization_code
Parameter code
Authorization code received from the LINE Platform.
Parameter redirectUri
Specify the redirect_uri specified in the URL for authentication and authorization.
Parameter codeVerifier
Specify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
Parameter clientId
Instead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
Parameter clientSecret
Instead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
Parameter region
If you specified a value for region in the URL for authentication and authorization, specify the same value.
Parameter basicSearchId
If you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
Parameter scope
If you specified a value for scope in the URL for authentication and authorization, specify the same value.
Parameter brandType
If you specified a value for brand_type in the URL for authentication and authorization, specify the same value.
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method attachModuleWithHttpInfo

attachModuleWithHttpInfo: (
    grantType: string,
    code: string,
    redirectUri: string,
    codeVerifier?: string,
    clientId?: string,
    clientSecret?: string,
    region?: string,
    basicSearchId?: string,
    scope?: string,
    brandType?: string
) => Promise<Types.ApiResponseType<AttachModuleResponse>>;

Attach by operation of the module channel provider Calls POST https://manager.line.biz/module/auth/v1/token. This method returns the response body together with the underlying httpResponse.
Parameter grantType
authorization_code
Parameter code
Authorization code received from the LINE Platform.
Parameter redirectUri
Specify the redirect_uri specified in the URL for authentication and authorization.
Parameter codeVerifier
Specify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.
Parameter clientId
Instead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.
Parameter clientSecret
Instead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.
Parameter region
If you specified a value for region in the URL for authentication and authorization, specify the same value.
Parameter basicSearchId
If you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.
Parameter scope
If you specified a value for scope in the URL for authentication and authorization, specify the same value.
Parameter brandType
If you specified a value for brand_type in the URL for authentication and authorization, specify the same value.
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

type AttachModuleResponse

type AttachModuleResponse = {
    /**
     * User ID of the bot on the LINE Official Account.
     */
    bot_id: string;
    /**
     * Permissions (scope) granted by the LINE Official Account admin.
     */
    scopes: Array<string>;
};

Attach by operation of the module channel provider
See Also
- https://developers.line.biz/en/reference/partner-docs/#link-attach-by-operation-module-channel-provider

namespace moduleOperation

module 'dist/module/api.d.ts' {}

class LineModuleClient

class LineModuleClient {}

See Also
- LineBotClient for a unified interface that wraps this client.

constructor

constructor(config: httpClientConfig);

Initializes a new LineModuleClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://api.line.me.
Parameter
config.channelAccessToken The channel access token used for authorization.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new LineModuleClient({ channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!, });

method acquireChatControl

acquireChatControl: (
    chatId: string,
    acquireChatControlRequest?: AcquireChatControlRequest
) => Promise<Types.MessageAPIResponseBase>;

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel. Calls POST https://api.line.me/v2/bot/chat/{chatId}/control/acquire. To inspect the HTTP status code or response headers, use acquireChatControlWithHttpInfo.
Parameter chatId
The userId, roomId, or groupId
Parameter acquireChatControlRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method acquireChatControlWithHttpInfo

acquireChatControlWithHttpInfo: (
    chatId: string,
    acquireChatControlRequest?: AcquireChatControlRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel. Calls POST https://api.line.me/v2/bot/chat/{chatId}/control/acquire. This method returns the response body together with the underlying httpResponse.
Parameter chatId
The userId, roomId, or groupId
Parameter acquireChatControlRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method detachModule

detachModule: (
    detachModuleRequest?: DetachModuleRequest
) => Promise<Types.MessageAPIResponseBase>;

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account. Calls POST https://api.line.me/v2/bot/channel/detach. To inspect the HTTP status code or response headers, use detachModuleWithHttpInfo.
Parameter detachModuleRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method detachModuleWithHttpInfo

detachModuleWithHttpInfo: (
    detachModuleRequest?: DetachModuleRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account. Calls POST https://api.line.me/v2/bot/channel/detach. This method returns the response body together with the underlying httpResponse.
Parameter detachModuleRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method getModules

getModules: (start?: string, limit?: number) => Promise<GetModulesResponse>;

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels. Calls GET https://api.line.me/v2/bot/list. To inspect the HTTP status code or response headers, use getModulesWithHttpInfo.
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
Parameter limit
Specify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method getModulesWithHttpInfo

getModulesWithHttpInfo: (
    start?: string,
    limit?: number
) => Promise<Types.ApiResponseType<GetModulesResponse>>;

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels. Calls GET https://api.line.me/v2/bot/list. This method returns the response body together with the underlying httpResponse.
Parameter start
Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
Parameter limit
Specify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

method releaseChatControl

releaseChatControl: (chatId: string) => Promise<Types.MessageAPIResponseBase>;

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API. Calls POST https://api.line.me/v2/bot/chat/{chatId}/control/release. To inspect the HTTP status code or response headers, use releaseChatControlWithHttpInfo.
Parameter chatId
The userId, roomId, or groupId
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method releaseChatControlWithHttpInfo

releaseChatControlWithHttpInfo: (
    chatId: string
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API. Calls POST https://api.line.me/v2/bot/chat/{chatId}/control/release. This method returns the response body together with the underlying httpResponse.
Parameter chatId
The userId, roomId, or groupId
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

type AcquireChatControlRequest

type AcquireChatControlRequest = {
    /**
     * `True`: After the time limit (ttl) has passed, the initiative (Chat Control) will return to the Primary Channel. (Default) `False`: There's no time limit and the initiative (Chat Control) doesn't change over time.
     */
    expired?: boolean;
    /**
     * The time it takes for initiative (Chat Control) to return to the Primary Channel (the time that the module channel stays on the Active Channel). The value is specified in seconds. The maximum value is one year (3600 * 24 * 365). The default value is 3600 (1 hour).  * Ignored if the value of expired is false.
     * Maximum: 31536000
     */
    ttl?: number;
};

Request entity of the Acquire Control API
See Also
- https://developers.line.biz/en/reference/partner-docs/#acquire-control-api

type DetachModuleRequest

type DetachModuleRequest = {
    /**
     * User ID of the LINE Official Account bot attached to the module channel.
     */
    botId?: string;
};

Unlink (detach) the module channel by the operation of the module channel administrator
See Also
- https://developers.line.biz/en/reference/partner-docs/#unlink-detach-module-channel-by-operation-mc-admin

type GetModulesResponse

type GetModulesResponse = {
    /**
     * Array of Bot list Item objects representing basic information about the bot.
     */
    bots: Array<ModuleBot>;
    /**
     * Continuation token. Used to get the next array of basic bot information. This property is only returned if there are more unreturned results.
     */
    next?: string;
};

List of bots to which the module is attached
See Also
- https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api

type ModuleBot

type ModuleBot = {
    /**
     * Bot's user ID
     */
    userId: string;
    /**
     * Bot's basic ID
     */
    basicId: string;
    /**
     * Bot's premium ID. Not included in the response if the premium ID isn't set.
     */
    premiumId?: string;
    /**
     * Bot's display name
     */
    displayName: string;
    /**
     * Profile image URL. Image URL starting with `https://`. Not included in the response if the bot doesn't have a profile image.
     */
    pictureUrl?: string;
};

basic information about the bot.
See Also
- https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api

namespace shop

module 'dist/shop/api.d.ts' {}

class ShopClient

class ShopClient {}

See Also
- LineBotClient for a unified interface that wraps this client.

constructor

constructor(config: httpClientConfig);

Initializes a new ShopClient.
Parameter config
Configuration for this API client.
Parameter
config.baseURL The base URL for requests. Defaults to https://api.line.me.
Parameter
config.channelAccessToken The channel access token used for authorization.
Parameter
config.defaultHeaders Extra headers merged into every request.
Example 1
const client = new ShopClient({ channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!, });

method missionStickerV3

missionStickerV3: (
    missionStickerRequest: MissionStickerRequest
) => Promise<Types.MessageAPIResponseBase>;

Sends a mission sticker. Calls POST https://api.line.me/shop/v3/mission. To inspect the HTTP status code or response headers, use missionStickerV3WithHttpInfo.
Parameter missionStickerRequest
Returns
A promise resolving to the response body.
See Also
- LINE Developers documentation

method missionStickerV3WithHttpInfo

missionStickerV3WithHttpInfo: (
    missionStickerRequest: MissionStickerRequest
) => Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;

Sends a mission sticker. Calls POST https://api.line.me/shop/v3/mission. This method returns the response body together with the underlying httpResponse.
Parameter missionStickerRequest
Returns
A promise resolving to the response body together with the underlying httpResponse.
See Also
- LINE Developers documentation

type ErrorResponse

type ErrorResponse = {
    /**
     * Message containing information about the error.
     */
    message: string;
};

See Also
- https://developers.line.biz/en/reference/partner-docs/#send-mission-stickers-v3

type MissionStickerRequest

type MissionStickerRequest = {
    /**
     * Destination user ID
     */
    to: string;
    /**
     * Package ID for a set of stickers
     */
    productId: string;
    /**
     * `STICKER`
     */
    productType: string;
    /**
     * `false`
     */
    sendPresentMessage: boolean;
};

Send mission stickers (v3)
See Also
- https://developers.line.biz/en/reference/partner-docs/#send-mission-stickers-v3

namespace webhook

module 'dist/webhook/api.d.ts' {}

type AccountLinkEvent

type AccountLinkEvent = EventBase & {
    type: 'accountLink';
    /**
     * Reply token used to send reply message to this event. This property won't be included if linking the account has failed.
     */
    replyToken?: string;
    link: LinkContent;
};

Event object for when a user has linked their LINE account with a provider's service account. You can reply to account link events.
See Also
- https://developers.line.biz/en/reference/messaging-api/#account-link-event

type ActivatedEvent

type ActivatedEvent = EventBase & {
    type: 'activated';
    chatControl: ChatControl;
};

This event indicates that the module channel has been switched to Active Channel by calling the Acquire Control API. Sent to the webhook URL server of the module channel.
See Also
- https://developers.line.biz/en/reference/partner-docs/#activated-event

type AllMentionee

type AllMentionee = MentioneeBase & {
    type: 'all';
};

Mentioned target is entire group

type AttachedModuleContent

type AttachedModuleContent = ModuleContentBase & {
    type: 'attached';
    /**
     * User ID of the bot on the attached LINE Official Account
     */
    botId: string;
    /**
     * An array of strings indicating the scope permitted by the admin of the LINE Official Account.
     */
    scopes: Array<string>;
};

See Also
- https://developers.line.biz/en/reference/partner-docs/#attached-event

type AudioMessageContent

type AudioMessageContent = MessageContentBase & {
    type: 'audio';
    contentProvider: ContentProvider;
    /**
     * Length of audio file (milliseconds)
     */
    duration?: number;
    /**
     * Token used to mark the message as read.
     */
    markAsReadToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#wh-audio

type BeaconContent

type BeaconContent = {
    /**
     * Hardware ID of the beacon that was detected
     */
    hwid: string;
    /**
     * Type of beacon event.
     */
    type: BeaconContent.TypeEnum;
    /**
     * Device message of beacon that was detected.
     */
    dm?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#beacon-event

type BeaconEvent

type BeaconEvent = EventBase & {
    type: 'beacon';
    /**
     * Reply token used to send reply message to this event
     */
    replyToken: string;
    beacon: BeaconContent;
};

Event object for when a user enters the range of a LINE Beacon. You can reply to beacon events.
See Also
- https://developers.line.biz/en/reference/messaging-api/#beacon-event

type BotResumedEvent

type BotResumedEvent = EventBase & {
    type: 'botResumed';
};

This event indicates that the LINE Official Account has returned from the suspended state. Sent to the webhook URL server of the module channel.
See Also
- https://developers.line.biz/en/reference/partner-docs/#botresumed-event

type BotSuspendedEvent

type BotSuspendedEvent = EventBase & {
    type: 'botSuspended';
};

This event indicates that the LINE Official Account has been suspended (Suspend). Sent to the webhook URL server of the module channel.
See Also
- https://developers.line.biz/en/reference/partner-docs/#botsuspend-event

type CallbackRequest

type CallbackRequest = {
    /**
     * User ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, `U[0-9a-f]{32}`.
     * Minimum length: 33
     * Maximum length: 33
     * Pattern: /^U[0-9a-f]{32}$/
     */
    destination: string;
    /**
     * Array of webhook event objects. The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication.
     */
    events: Array<Event>;
};

The request body contains a JSON object with the user ID of a bot that should receive webhook events and an array of webhook event objects.
See Also
- https://developers.line.biz/en/reference/messaging-api/#request-body

type ChatControl

type ChatControl = {
    expireAt: number;
};

See Also
- https://developers.line.biz/en/reference/partner-docs/#activated-event

type ContentProvider

type ContentProvider = {
    /**
     * Provider of the image file.
     */
    type: ContentProvider.TypeEnum;
    /**
     * URL of the image file. Only included when contentProvider.type is external.
     */
    originalContentUrl?: string;
    /**
     * URL of the preview image. Only included when contentProvider.type is external.
     */
    previewImageUrl?: string;
};

Provider of the media file.

type DeactivatedEvent

type DeactivatedEvent = EventBase & {
    type: 'deactivated';
};

This event indicates that the module channel has been switched to Standby Channel by calling Acquire Control API or Release Control API. Sent to the webhook URL server of the module channel.
See Also
- https://developers.line.biz/en/reference/partner-docs/#deactivated-event

type DeliveryContext

type DeliveryContext = {
    /**
     * Whether the webhook event is a redelivered one or not.
     */
    isRedelivery: boolean;
};

webhook's delivery context information

type DetachedModuleContent

type DetachedModuleContent = ModuleContentBase & {
    type: 'detached';
    /**
     * Detached LINE Official Account bot user ID
     */
    botId: string;
    /**
     * Reason for detaching
     */
    reason: DetachedModuleContent.ReasonEnum;
};

See Also
- https://developers.line.biz/en/reference/partner-docs/#detached-event

type Emoji

type Emoji = {
    /**
     * Index position for a character in text, with the first character being at position 0.
     */
    index: number;
    /**
     * The length of the LINE emoji string. For LINE emoji (hello), 7 is the length.
     */
    length: number;
    /**
     * Product ID for a LINE emoji set.
     */
    productId: string;
    /**
     * ID for a LINE emoji inside a set.
     */
    emojiId: string;
};

Webhook Type Definition Webhook event definition of the LINE Messaging API
The version of the OpenAPI document: 1.0.0
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type Event

type Event =
    | AccountLinkEvent
    | ActivatedEvent
    | BeaconEvent
    | BotResumedEvent
    | BotSuspendedEvent
    | DeactivatedEvent
    | PnpDeliveryCompletionEvent
    | FollowEvent
    | JoinEvent
    | LeaveEvent
    | MemberJoinedEvent
    | MemberLeftEvent
    | MembershipEvent
    | MessageEvent
    | MessageEditedEvent
    | ModuleEvent
    | PostbackEvent
    | UnfollowEvent
    | UnsendEvent
    | VideoPlayCompleteEvent;

Webhook event

type EventBase

type EventBase = {
    /**
     * Type of the event
     */
    type: string;
    source?: Source;
    /**
     * Time of the event in milliseconds.
     */
    timestamp: number;
    mode: EventMode;
    /**
     * Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.
     */
    webhookEventId: string;
    deliveryContext: DeliveryContext;
};

type EventMode

type EventMode = 'active' | 'standby';

Channel state.

type FileMessageContent

type FileMessageContent = MessageContentBase & {
    type: 'file';
    /**
     * File name
     */
    fileName: string;
    /**
     * File size in bytes
     */
    fileSize: number;
    /**
     * Token used to mark the message as read.
     */
    markAsReadToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#wh-file

type FollowDetail

type FollowDetail = {
    /**
     * Whether a user has added your LINE Official Account as a friend or unblocked.
     */
    isUnblocked: boolean;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#follow-event

type FollowEvent

type FollowEvent = EventBase & {
    type: 'follow';
    /**
     * Reply token used to send reply message to this event
     */
    replyToken: string;
    follow: FollowDetail;
};

Event object for when your LINE Official Account is added as a friend (or unblocked). You can reply to follow events.
See Also
- https://developers.line.biz/en/reference/messaging-api/#follow-event

type GroupSource

type GroupSource = SourceBase & {
    type: 'group';
    /**
     * Group ID of the source group chat
     */
    groupId: string;
    /**
     * ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId.
     */
    userId?: string;
};

type ImageMessageContent

type ImageMessageContent = MessageContentBase & {
    type: 'image';
    contentProvider: ContentProvider;
    imageSet?: ImageSet;
    /**
     * Quote token to quote this message.
     */
    quoteToken: string;
    /**
     * Token used to mark the message as read.
     */
    markAsReadToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#wh-image

type ImageSet

type ImageSet = {
    /**
     * Image set ID. Only included when multiple images are sent simultaneously.
     */
    id: string;
    /**
     * An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android.
     */
    index?: number;
    /**
     * The total number of images sent simultaneously.
     */
    total?: number;
};

Webhook Type Definition Webhook event definition of the LINE Messaging API
The version of the OpenAPI document: 1.0.0
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

type JoinedMembers

type JoinedMembers = {
    /**
     * Users who joined. Array of source user objects.
     */
    members: Array<UserSource>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#member-joined-event

type JoinedMembershipContent

type JoinedMembershipContent = MembershipContentBase & {
    type: 'joined';
    /**
     * The ID of the membership that the user joined. This is defined for each membership.
     */
    membershipId: number;
};

type JoinEvent

type JoinEvent = EventBase & {
    type: 'join';
    /**
     * Reply token used to send reply message to this event
     */
    replyToken: string;
};

Event object for when your LINE Official Account joins a group chat or multi-person chat. You can reply to join events.
See Also
- https://developers.line.biz/en/reference/messaging-api/#join-event

type LeaveEvent

type LeaveEvent = EventBase & {
    type: 'leave';
};

Event object for when a user removes your LINE Official Account from a group chat or when your LINE Official Account leaves a group chat or multi-person chat.
See Also
- https://developers.line.biz/en/reference/messaging-api/#leave-event

type LeftMembers

type LeftMembers = {
    /**
     * Users who left. Array of source user objects.
     */
    members: Array<UserSource>;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#member-left-event

type LeftMembershipContent

type LeftMembershipContent = MembershipContentBase & {
    type: 'left';
    /**
     * The ID of the membership that the user left. This is defined for each membership.
     */
    membershipId: number;
};

type LinkContent

type LinkContent = {
    /**
     * One of the following values to indicate whether linking the account was successful or not
     */
    result: LinkContent.ResultEnum;
    /**
     * Specified nonce (number used once) when verifying the user ID.
     */
    nonce: string;
};

Content of the account link event.
See Also
- https://developers.line.biz/en/reference/messaging-api/#account-link-event

type LocationMessageContent

type LocationMessageContent = MessageContentBase & {
    type: 'location';
    /**
     * Title
     */
    title?: string;
    /**
     * Address
     */
    address?: string;
    /**
     * Latitude
     */
    latitude: number;
    /**
     * Longitude
     */
    longitude: number;
    /**
     * Token used to mark the message as read.
     */
    markAsReadToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#wh-location

type MemberJoinedEvent

type MemberJoinedEvent = EventBase & {
    type: 'memberJoined';
    /**
     * Reply token used to send reply message to this event
     */
    replyToken: string;
    joined: JoinedMembers;
};

Event object for when a user joins a group chat or multi-person chat that the LINE Official Account is in.
See Also
- https://developers.line.biz/en/reference/messaging-api/#member-joined-event

type MemberLeftEvent

type MemberLeftEvent = EventBase & {
    type: 'memberLeft';
    left: LeftMembers;
};

Event object for when a user leaves a group chat or multi-person chat that the LINE Official Account is in.
See Also
- https://developers.line.biz/en/reference/messaging-api/#member-left-event

type MembershipContent

type MembershipContent =
    | JoinedMembershipContent
    | LeftMembershipContent
    | RenewedMembershipContent;

Content of the membership event.
See Also
- https://developers.line.biz/en/reference/messaging-api/#membership-event

type MembershipContentBase

type MembershipContentBase = {
    /**
     * Type of membership event.
     */
    type: string;
};

type MembershipEvent

type MembershipEvent = EventBase & {
    type: 'membership';
    /**
     * Reply token used to send reply message to this event
     */
    replyToken: string;
    membership: MembershipContent;
};

This event indicates that a user has subscribed (joined), unsubscribed (left), or renewed the bot's membership.
See Also
- https://developers.line.biz/en/reference/messaging-api/#membership-event

type Mention

type Mention = {
    /**
     * Array of one or more mention objects. Max: 20 mentions
     */
    mentionees: Array<Mentionee>;
};

type Mentionee

type Mentionee = AllMentionee | UserMentionee;

See Also
- https://developers.line.biz/en/reference/messaging-api/#wh-text

type MentioneeBase

type MentioneeBase = {
    /**
     * Mentioned target.
     */
    type: string;
    /**
     * Index position of the user mention for a character in text, with the first character being at position 0.
     */
    index: number;
    /**
     * The length of the text of the mentioned user. For a mention @example, 8 is the length.
     */
    length: number;
};

type MessageContent

type MessageContent =
    | AudioMessageContent
    | FileMessageContent
    | ImageMessageContent
    | LocationMessageContent
    | StickerMessageContent
    | TextMessageContent
    | VideoMessageContent;

See Also
- https://developers.line.biz/en/reference/messaging-api/#message-event

type MessageContentBase

type MessageContentBase = {
    /**
     * Type
     */
    type: string;
    /**
     * Message ID
     */
    id: string;
};

type MessageEditedEvent

type MessageEditedEvent = EventBase & {
    type: 'messageEdited';
    replyToken?: string;
    message: MessageContent;
};

Webhook event object which contains the edited message. This event is triggered when a user edits a text message. Currently, message editing is not available in one-on-one chats with LINE Official Accounts, so this event is only triggered in group chats. Multiple messageEdited webhook events may arrive out of order. The event with the largest timestamp represents the latest edit state.
See Also
- https://developers.line.biz/en/reference/messaging-api/#edit-event

type MessageEvent

type MessageEvent = EventBase & {
    type: 'message';
    replyToken?: string;
    message: MessageContent;
};

Webhook event object which contains the sent message.
See Also
- https://developers.line.biz/en/reference/messaging-api/#message-event

type ModuleContent

type ModuleContent = AttachedModuleContent | DetachedModuleContent;

See Also
- https://developers.line.biz/en/reference/partner-docs/#module-channel-specific-webhook-events

type ModuleContentBase

type ModuleContentBase = {
    /**
     * Type
     */
    type: string;
};

type ModuleEvent

type ModuleEvent = EventBase & {
    type: 'module';
    module: ModuleContent;
};

This event indicates that the module channel has been attached to the LINE Official Account. Sent to the webhook URL server of the module channel.
See Also
- https://developers.line.biz/en/reference/partner-docs/#module-channel-specific-webhook-events

type PnpDelivery

type PnpDelivery = {
    /**
     * A hashed phone number string or a string specified by `X-Line-Delivery-Tag` header
     */
    data: string;
};

A delivery object containing a hashed phone number string or a string specified by X-Line-Delivery-Tag header
See Also
- https://developers.line.biz/en/docs/partner-docs/line-notification-messages/message-sending-complete-webhook-event/#overview-delivery-webhook-event

type PnpDeliveryCompletionEvent

type PnpDeliveryCompletionEvent = EventBase & {
    type: 'delivery';
    delivery: PnpDelivery;
};

When a request is made to the LINE notification messages API and delivery of the LINE notification message to the user is completed, a dedicated webhook event (delivery completion event) is sent from the LINE Platform to the webhook URL of the bot server.
See Also
- https://developers.line.biz/en/docs/partner-docs/line-notification-messages/message-sending-complete-webhook-event/#overview-delivery-webhook-event

type PostbackContent

type PostbackContent = {
    /**
     * Postback data
     */
    data: string;
    params?: {
        [key: string]: string;
    };
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#postback-event

type PostbackEvent

type PostbackEvent = EventBase & {
    type: 'postback';
    /**
     * Reply token used to send reply message to this event
     */
    replyToken?: string;
    postback: PostbackContent;
};

Event object for when a user performs a postback action which initiates a postback. You can reply to postback events.
See Also
- https://developers.line.biz/en/reference/messaging-api/#postback-event

type RenewedMembershipContent

type RenewedMembershipContent = MembershipContentBase & {
    type: 'renewed';
    /**
     * The ID of the membership that the user renewed. This is defined for each membership.
     */
    membershipId: number;
};

type RoomSource

type RoomSource = SourceBase & {
    type: 'room';
    /**
     * ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId.
     */
    userId?: string;
    /**
     * Room ID of the source multi-person chat
     */
    roomId: string;
};

type Source

type Source = GroupSource | RoomSource | UserSource;

the source of the event.
See Also
- https://developers.line.biz/en/reference/messaging-api/#source-user

type SourceBase

type SourceBase = {
    /**
     * source type
     */
    type: string;
};

type StickerMessageContent

type StickerMessageContent = MessageContentBase & {
    type: 'sticker';
    /**
     * Package ID
     */
    packageId: string;
    /**
     * Sticker ID
     */
    stickerId: string;
    stickerResourceType: StickerMessageContent.StickerResourceTypeEnum;
    /**
     * Array of up to 15 keywords describing the sticker. If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned. The keyword selection is random for each event, so different keywords may be returned for the same sticker.
     * Maximum items: 15
     */
    keywords?: Array<string>;
    /**
     * Any text entered by the user. This property is only included for message stickers. Max character limit: 100
     * Maximum length: 100
     */
    text?: string;
    /**
     * Quote token to quote this message.
     */
    quoteToken: string;
    /**
     * Message ID of a quoted message. Only included when the received message quotes a past message.
     */
    quotedMessageId?: string;
    /**
     * Token used to mark the message as read.
     */
    markAsReadToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#wh-sticker

type TextMessageContent

type TextMessageContent = MessageContentBase & {
    type: 'text';
    /**
     * Message text.
     */
    text: string;
    /**
     * Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji.
     */
    emojis?: Array<Emoji>;
    mention?: Mention;
    /**
     * Quote token to quote this message.
     */
    quoteToken: string;
    /**
     * Message ID of a quoted message. Only included when the received message quotes a past message.
     */
    quotedMessageId?: string;
    /**
     * Token used to mark the message as read.
     */
    markAsReadToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#wh-text

type UnfollowEvent

type UnfollowEvent = EventBase & {
    type: 'unfollow';
};

Event object for when your LINE Official Account is blocked.
See Also
- https://developers.line.biz/en/reference/messaging-api/#unfollow-event

type UnsendDetail

type UnsendDetail = {
    /**
     * The message ID of the unsent message
     */
    messageId: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#unsend-event

type UnsendEvent

type UnsendEvent = EventBase & {
    type: 'unsend';
    unsend: UnsendDetail;
};

Event object for when the user unsends a message.
See Also
- https://developers.line.biz/en/reference/messaging-api/#unsend-event

type UserMentionee

type UserMentionee = MentioneeBase & {
    type: 'user';
    /**
     * User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information.
     */
    userId?: string;
    /**
     * Whether the mentioned user is the bot that receives the webhook.
     */
    isSelf?: boolean;
};

Mentioned target is user

type UserSource

type UserSource = SourceBase & {
    type: 'user';
    /**
     * ID of the source user
     */
    userId?: string;
};

type VideoMessageContent

type VideoMessageContent = MessageContentBase & {
    type: 'video';
    /**
     * Length of video file (milliseconds)
     */
    duration?: number;
    contentProvider: ContentProvider;
    /**
     * Quote token to quote this message.
     */
    quoteToken: string;
    /**
     * Token used to mark the message as read.
     */
    markAsReadToken?: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#wh-video

type VideoPlayComplete

type VideoPlayComplete = {
    /**
     * ID used to identify a video. Returns the same value as the trackingId assigned to the video message.
     */
    trackingId: string;
};

See Also
- https://developers.line.biz/en/reference/messaging-api/#video-viewing-complete

type VideoPlayCompleteEvent

type VideoPlayCompleteEvent = EventBase & {
    type: 'videoPlayComplete';
    /**
     * Reply token used to send reply message to this event
     */
    replyToken: string;
    videoPlayComplete: VideoPlayComplete;
};

Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.
See Also
- https://developers.line.biz/en/reference/messaging-api/#video-viewing-complete

namespace webhook.AccountLinkEvent

namespace webhook.AccountLinkEvent {}

namespace webhook.ActivatedEvent

namespace webhook.ActivatedEvent {}

namespace webhook.BeaconContent

namespace webhook.BeaconContent {}

type TypeEnum

type TypeEnum = 'enter' | 'banner' | 'stay';

namespace webhook.BeaconEvent

namespace webhook.BeaconEvent {}

namespace webhook.BotResumedEvent

namespace webhook.BotResumedEvent {}

namespace webhook.BotSuspendedEvent

namespace webhook.BotSuspendedEvent {}

namespace webhook.ContentProvider

namespace webhook.ContentProvider {}

type TypeEnum

type TypeEnum = 'line' | 'external';

namespace webhook.DeactivatedEvent

namespace webhook.DeactivatedEvent {}

namespace webhook.DetachedModuleContent

namespace webhook.DetachedModuleContent {}

type ReasonEnum

type ReasonEnum = 'bot_deleted';

namespace webhook.Event

namespace webhook.Event {}

namespace webhook.FollowEvent

namespace webhook.FollowEvent {}

namespace webhook.JoinEvent

namespace webhook.JoinEvent {}

namespace webhook.LeaveEvent

namespace webhook.LeaveEvent {}

namespace webhook.LinkContent

namespace webhook.LinkContent {}

type ResultEnum

type ResultEnum = 'ok' | 'failed';

namespace webhook.MemberJoinedEvent

namespace webhook.MemberJoinedEvent {}

namespace webhook.MemberLeftEvent

namespace webhook.MemberLeftEvent {}

namespace webhook.MembershipEvent

namespace webhook.MembershipEvent {}

namespace webhook.MessageEditedEvent

namespace webhook.MessageEditedEvent {}

namespace webhook.MessageEvent

namespace webhook.MessageEvent {}

namespace webhook.ModuleEvent

namespace webhook.ModuleEvent {}

namespace webhook.PnpDeliveryCompletionEvent

namespace webhook.PnpDeliveryCompletionEvent {}

namespace webhook.PostbackEvent

namespace webhook.PostbackEvent {}

namespace webhook.StickerMessageContent

namespace webhook.StickerMessageContent {}

type StickerResourceTypeEnum

type StickerResourceTypeEnum =
    | 'STATIC'
    | 'ANIMATION'
    | 'SOUND'
    | 'ANIMATION_SOUND'
    | 'POPUP'
    | 'POPUP_SOUND'
    | 'CUSTOM'
    | 'MESSAGE'
    | 'NAME_TEXT'
    | 'PER_STICKER_TEXT';

namespace webhook.UnfollowEvent

namespace webhook.UnfollowEvent {}

namespace webhook.UnsendEvent

namespace webhook.UnsendEvent {}

namespace webhook.VideoPlayCompleteEvent

namespace webhook.VideoPlayCompleteEvent {}

Package Files (361)

Dependencies (1)

@types/node

Dev Dependencies (13)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@line/bot-sdk.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@line/bot-sdk)

HTML

<a href="https://www.jsdocs.io/package/@line/bot-sdk"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated just now.
Package analyzed in 10096 ms.
Missing or incorrect documentation? Open an issue for this package.

@line/bot-sdk

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Type Aliases

Namespaces

Variables

variable LINE_REQUEST_ID_HTTP_HEADER_NAME

variable LINE_SIGNATURE_HTTP_HEADER_NAME

Functions

function middleware

function validateSignature

Classes

class HTTPFetchError

constructor

property body

property headers

property status

property statusText

class JSONParseError

constructor

property raw

class LineBotClient

Example 1

Example 2

Example 3

property clients

method fromChannelAccessToken

class SignatureValidationFailed

constructor

property signature

Interfaces

interface ApiResponseType

property body

property httpResponse

interface LineBotClientChannelAccessTokenConfig

Example 1

property channelAccessToken

interface MiddlewareConfig

property channelSecret

property skipSignatureVerification

Type Aliases

type MessageAPIResponseBase

Namespaces

namespace channelAccessToken

class ChannelAccessTokenClient

constructor

Parameter config

Parameter

Parameter

Example 1

method getsAllValidChannelAccessTokenKeyIds

Parameter clientAssertionType

Parameter clientAssertion

Returns

See Also

method getsAllValidChannelAccessTokenKeyIdsWithHttpInfo

Parameter clientAssertionType

Parameter clientAssertion

Returns

See Also

method issueChannelToken

Parameter grantType

Parameter clientId

Parameter clientSecret

Returns

See Also

method issueChannelTokenByJWT

Parameter grantType

Parameter clientAssertionType

Parameter clientAssertion

Returns

See Also

method issueChannelTokenByJWTWithHttpInfo

Parameter grantType

Parameter clientAssertionType