Appearance
@line/bot-sdk / messagingApi / NarrowcastProgressResponse
Type Alias: NarrowcastProgressResponse
NarrowcastProgressResponse =
object
Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:13
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.
Properties
acceptedTime
acceptedTime:
Date
Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:55
Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC
See
completedTime?
optionalcompletedTime:Date
Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:61
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
errorCode?
optionalerrorCode:number
Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:49
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.
See
failedDescription?
optionalfailedDescription:string
Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:43
The reason the message failed to be sent. This is only included with a phase property value of failed.
See
failedDescription Documentation
failureCount?
optionalfailureCount:number
Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:31
The number of users who failed to send the message.
See
phase
phase:
PhaseEnum
Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:19
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
successCount?
optionalsuccessCount:number
Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:25
The number of users who successfully received the message.
See
targetCount?
optionaltargetCount:number
Defined in: lib/messaging-api/model/narrowcastProgressResponse.ts:37
The number of intended recipients of the message.