Skip to content

Commit a255221

Browse files
github-actions[bot]github-actions
andauthored
Add forbidPartialDelivery option to the Narrowcast Limit Object (#1430)
line/line-openapi#114 ## Add forbidPartialDelivery option to the Narrowcast Limit Object We add a new `forbidPartialDelivery` option to the Narrowcast Limit Object. When set to true, this option prevents messages from being delivered to only a subset of the target audience. If partial delivery occurs, the narrowcast request will succeed but fail asynchronously. You can verify whether the message delivery was canceled by checking the narrowcast message progress. This property can only be set to true when upToRemainingQuota is also true. For more details, see the https://developers.line.biz/en/news/2025/10/21/narrowcast-message-update/. ### Example: ```json { "max": 100, "upToRemainingQuota": true, "forbidPartialDelivery": true } ``` Co-authored-by: github-actions <[email protected]>
1 parent 81d9e9a commit a255221

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

lib/messaging-api/model/limit.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,10 @@ export type Limit = {
2626
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message">upToRemainingQuota Documentation</a>
2727
*/
2828
upToRemainingQuota?: boolean /* = false*/;
29+
/**
30+
* 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.
31+
*
32+
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message">forbidPartialDelivery Documentation</a>
33+
*/
34+
forbidPartialDelivery?: boolean /* = false*/;
2935
};

lib/messaging-api/model/narrowcastProgressResponse.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export type NarrowcastProgressResponse = {
4242
*/
4343
failedDescription?: string /**/;
4444
/**
45-
* 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.
45+
* 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.
4646
*
4747
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">errorCode Documentation</a>
4848
*/

line-openapi

0 commit comments

Comments
 (0)