Skip to content

@line/bot-sdkDocs


@line/bot-sdk / messagingApi / NarrowcastProgressResponse

Type Alias: NarrowcastProgressResponse

NarrowcastProgressResponse: object

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 declaration

acceptedTime

acceptedTime: Date

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

See

acceptedTime Documentation

completedTime?

optional completedTime: 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

See

completedTime Documentation

errorCode?

optional errorCode: number

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.

See

errorCode Documentation

failedDescription?

optional failedDescription: string

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

See

failedDescription Documentation

failureCount?

optional failureCount: number

The number of users who failed to send the message.

See

failureCount Documentation

phase

phase: PhaseEnum

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.

See

phase Documentation

successCount?

optional successCount: number

The number of users who successfully received the message.

See

successCount Documentation

targetCount?

optional targetCount: number

The number of intended recipients of the message.

See

targetCount Documentation

Defined in

lib/messaging-api/model/narrowcastProgressResponse.ts:13