You can define notification policies to limit the use of SMS and voice messages for pairing and authentication.
Property | Type | Required? | Mutable? | Description |
---|---|---|---|---|
name |
String | Required | Mutable | The name to use for the notification policy. Must be unique among the notification policies in the environment. |
default |
Boolean | Optional | Mutable | Indication of whether this policy is the default notification policy for the environment. If the parameter is not provided, the value used is false |
quotas |
Array | Required | Mutable | Collection of objects that define the SMS/Voice limits. Each object contain the following elements: type , deliveryMethods , total . Currently, a policy can contain ony one such object. Note that instead of total , you can use the pair of fields: claimed and unclaimed . |
quotas[].type |
String | Required | Mutable | Specifies whether the limit defined is per-user or per environment. Value must be either USER or ENVIRONMENT . |
quotas[].deliveryMethods |
Array | Required | Mutable | The delivery methods for which the limit is being defined. Currently, the content of the array must be SMS , Voice . This means that the combined total of SMS and Voice notifications must be below the limit defined. |
quotas[].total |
Integer | Required/Optional | Mutable | The maximum number of notifications allowed per day. |
quotas[].claimed |
Integer | Required/Optional | Mutable | The maximum number of notifications that can be received and responded to each day. Used in conjunction with unclaimed in place of the single field total . |
quotas[].unclaimed |
Integer | Required/Optional | Mutable | The maximum number of notifications that can be received and not responded to each day. Used in conjunction with claimed in place of the single field total . |
When you create/update a notification policy, the response also includes the following information:
id
- the ID assigned to the notification policycreatedAt
- date and time when the policy was createdupdatedAt
- date and time when the policy was updated