Skip to content

Commit 47ad85a

Browse files
authored
feat(#2092): document recipient resolving multiple recipients (#2093)
1 parent e0267b6 commit 47ad85a

File tree

1 file changed

+4
-3
lines changed
  • content/en/building/reference/app-settings

1 file changed

+4
-3
lines changed

content/en/building/reference/app-settings/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ An outgoing SMS message configuration has the following fields:
6868
|-------|---------|----------|
6969
|`translation_key`|The translation key of the message to send out. Available in 2.15+.|yes|
7070
|`messages`| (**deprecated**) Array of message objects, each with `content` and `locale` properties. From 2.15 on use `translation_key` instead.|no|
71-
|`recipient`| Recipient of the message.|no|
71+
|`recipient`| Specifies the intended recipient of the message. As of 5.1.0, an array of multiple recipients may be provided, in which case the first existing recipient will be resolved. |no|
7272

7373
### `recipient` values and resolutions:
7474

@@ -88,8 +88,9 @@ An outgoing SMS message configuration has the following fields:
8888
| *valid phone number* | requested phone number |
8989

9090
> [!NOTE]
91-
> - if `recipient` resolution does not yield a phone number, it will default to submitter's phone number
92-
> - if there is no submitter phone number available, the actual `recipient` property value will be used
91+
> - when recipient is an array, the first resolved recipient from the array will be selected.
92+
> - if `recipient` resolution does not yield a phone number, it will default to submitter's phone number. This behavior can be changed with [default_to_sender]({{% ref "building/reference/app-settings/sms/#app_settingsjson-sms" %}}) paramter.
93+
> - if there is no submitter phone number available or `default_to_sender` is `false`, the actual `recipient` property value will be used. When recipient is an array, first field of an array will be used.
9394
> - when mapping a contact phone number, subject (`patient` and/or `place`) lineage and `linked_docs` take precedence over `submitter` lineage and `linked_docs`.
9495
> - except for `link:<tag>`, phone numbers are resolved to the primary contacts of the requested places. `linked_docs` hydration is shallow, so the primary contact of the linked doc will not be available.
9596

0 commit comments

Comments
 (0)