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 (#750)
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]>
<sectionclass="phpdocumentor-description"><p>Error summary. This is only included with a phase property value of failed. One of: <codeclass="prettyprint">1</code>: An internal error occurred. <codeclass="prettyprint">2</code>: An error occurred because there weren't enough recipients. <codeclass="prettyprint">3</code>: A conflict error of requests occurs because a request that has already been accepted is retried. <codeclass="prettyprint">4</code>: An audience of less than 50 recipients is included as a condition of sending.</p>
2385
+
<sectionclass="phpdocumentor-description"><p>Error summary. This is only included with a phase property value of failed. One of: <codeclass="prettyprint">1</code>: An internal error occurred. <codeclass="prettyprint">2</code>: An error occurred because there weren't enough recipients. <codeclass="prettyprint">3</code>: A conflict error of requests occurs because a request that has already been accepted is retried. <codeclass="prettyprint">4</code>: An audience of less than 50 recipients is included as a condition of sending.<codeclass="prettyprint">5</code>: Message delivery has been canceled to prevent messages from being delivered only to a subset of the target audience.</p>
@@ -374,6 +381,33 @@ public function setUpToRemainingQuota($upToRemainingQuota)
374
381
375
382
return$this;
376
383
}
384
+
385
+
/**
386
+
* Gets forbidPartialDelivery
387
+
*
388
+
* @return bool|null
389
+
*/
390
+
publicfunctiongetForbidPartialDelivery()
391
+
{
392
+
return$this->container['forbidPartialDelivery'];
393
+
}
394
+
395
+
/**
396
+
* Sets forbidPartialDelivery
397
+
*
398
+
* @param bool|null $forbidPartialDelivery 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: src/clients/messaging-api/lib/Model/NarrowcastProgressResponse.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -545,7 +545,7 @@ public function getErrorCode()
545
545
/**
546
546
* Sets errorCode
547
547
*
548
-
* @param int|null $errorCode 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.
548
+
* @param int|null $errorCode 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.
0 commit comments