line-bot-sdk-nodejs

Appearance

@line/bot-sdk

@line/bot-sdk / messagingApi / NarrowcastProgressResponse

Type Alias: NarrowcastProgressResponse ​

NarrowcastProgressResponse = object

Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:16

See ​

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

Properties ​

acceptedTime ​

acceptedTime: Date

Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:44

Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC

completedTime? ​

optional completedTime?: Date

Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:48

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

errorCode? ​

optional errorCode?: number

Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:40

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.

failedDescription? ​

optional failedDescription?: string

Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:36

The reason the message failed to be sent. This is only included with a phase property value of failed.

failureCount? ​

optional failureCount?: number

Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:28

The number of users who failed to send the message.

phase ​

phase: PhaseEnum

Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:20

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.

successCount? ​

optional successCount?: number

Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:24

The number of users who successfully received the message.

targetCount? ​

optional targetCount?: number

Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:32

The number of intended recipients of the message.