You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add forbidPartialDelivery option to the Narrowcast Limit Object (#685)
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]>
Copy file name to clipboardExpand all lines: lib/line/bot/v2/messaging_api/model/limit.rb
+6Lines changed: 6 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -20,17 +20,23 @@ class Limit
20
20
# @!attribute [rw] up_to_remaining_quota
21
21
# @return [Boolean,nil] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random.
22
22
attr_accessor:up_to_remaining_quota
23
+
# @!attribute [rw] forbid_partial_delivery
24
+
# @return [Boolean,nil] 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.
25
+
attr_accessor:forbid_partial_delivery
23
26
24
27
# @param max [Integer,nil] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random.
25
28
# @param up_to_remaining_quota [Boolean,nil] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random.
29
+
# @param forbid_partial_delivery [Boolean,nil] 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.
Copy file name to clipboardExpand all lines: lib/line/bot/v2/messaging_api/model/narrowcast_progress_response.rb
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ class NarrowcastProgressResponse
29
29
# @return [String,nil] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`.
30
30
attr_accessor:failed_description
31
31
# @!attribute [rw] error_code
32
-
# @return [Integer,nil] 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.
32
+
# @return [Integer,nil] 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.
33
33
attr_accessor:error_code
34
34
# @!attribute [rw] accepted_time
35
35
# @return [String] Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC
@@ -43,7 +43,7 @@ class NarrowcastProgressResponse
43
43
# @param failure_count [Integer,nil] The number of users who failed to send the message.
44
44
# @param target_count [Integer,nil] The number of intended recipients of the message.
45
45
# @param failed_description [String,nil] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`.
46
-
# @param error_code [Integer,nil] 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.
46
+
# @param error_code [Integer,nil] 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.
47
47
# @param accepted_time [String] Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC
48
48
# @param completed_time [String,nil] 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
Copy file name to clipboardExpand all lines: sig/line/bot/v2/messaging_api/model/limit.rbs
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -16,13 +16,16 @@ module Line
16
16
classLimit
17
17
attr_accessor max: Integer?
18
18
attr_accessor up_to_remaining_quota: bool?
19
+
attr_accessor forbid_partial_delivery: bool?
19
20
20
21
21
22
# @param max [Integer,nil] The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random.
22
23
# @param up_to_remaining_quota [bool,nil] If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`. Targets will be selected at random.
24
+
# @param forbid_partial_delivery [bool,nil] 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.
Copy file name to clipboardExpand all lines: sig/line/bot/v2/messaging_api/model/narrowcast_progress_response.rbs
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ module Line
28
28
# @param failure_count [Integer,nil] The number of users who failed to send the message.
29
29
# @param target_count [Integer,nil] The number of intended recipients of the message.
30
30
# @param failed_description [String,nil] The reason the message failed to be sent. This is only included with a `phase` property value of `failed`.
31
-
# @param error_code [Integer,nil] 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.
31
+
# @param error_code [Integer,nil] 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.
32
32
# @param accepted_time [String] Narrowcast message request accepted time in milliseconds. Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z) Timezone: UTC
33
33
# @param completed_time [String,nil] 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
0 commit comments