| 1 | /**
|
| 2 | * LINE Messaging API
|
| 3 | * This document describes LINE Messaging API.
|
| 4 | *
|
| 5 | * The version of the OpenAPI document: 0.0.1
|
| 6 | *
|
| 7 | *
|
| 8 | * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
| 9 | * https://openapi-generator.tech
|
| 10 | * Do not edit the class manually.
|
| 11 | */
|
| 12 | export type NarrowcastProgressResponse = {
|
| 13 | /**
|
| 14 | * 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.
|
| 15 | *
|
| 16 | * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">phase Documentation</a>
|
| 17 | */
|
| 18 | phase: NarrowcastProgressResponse.PhaseEnum;
|
| 19 | /**
|
| 20 | * The number of users who successfully received the message.
|
| 21 | *
|
| 22 | * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">successCount Documentation</a>
|
| 23 | */
|
| 24 | successCount?: number;
|
| 25 | /**
|
| 26 | * The number of users who failed to send the message.
|
| 27 | *
|
| 28 | * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">failureCount Documentation</a>
|
| 29 | */
|
| 30 | failureCount?: number;
|
| 31 | /**
|
| 32 | * The number of intended recipients of the message.
|
| 33 | *
|
| 34 | * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">targetCount Documentation</a>
|
| 35 | */
|
| 36 | targetCount?: number;
|
| 37 | /**
|
| 38 | * The reason the message failed to be sent. This is only included with a `phase` property value of `failed`.
|
| 39 | *
|
| 40 | * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">failedDescription Documentation</a>
|
| 41 | */
|
| 42 | failedDescription?: string;
|
| 43 | /**
|
| 44 | * 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.
|
| 45 | *
|
| 46 | * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">errorCode Documentation</a>
|
| 47 | */
|
| 48 | errorCode?: number;
|
| 49 | /**
|
| 50 | * Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC
|
| 51 | *
|
| 52 | * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">acceptedTime Documentation</a>
|
| 53 | */
|
| 54 | acceptedTime: Date;
|
| 55 | /**
|
| 56 | * 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
|
| 57 | *
|
| 58 | * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">completedTime Documentation</a>
|
| 59 | */
|
| 60 | completedTime?: Date;
|
| 61 | };
|
| 62 | export declare namespace NarrowcastProgressResponse {
|
| 63 | type PhaseEnum = "waiting" | "sending" | "succeeded" | "failed";
|
| 64 | }
|