Description
Feature script name |
SubscriberValidity |
|---|---|
Applicable contexts |
All services |
Prerequisite features |
The Subscriber Validity feature performs a check that a subscriber is within a validity period within two inclusive dates. If the start date is not present, all dates prior to the end date are considered valid. If the end date is not present, then all dates from the start date are considered valid.
The validity dates are set on a per-subscriber basis.
If the current date at session initiation is within the valid period for the subscriber, the feature will have no effect on the call.
If the current date at session initiation is outside the valid period for the subscriber, the feature will release the call.
OCS interface
This feature has no interaction with the OCS (except for preventing the initial credit check by releasing the session).
Session state inputs and outputs
Inputs
| Name | Type | Format | Description | Behaviour if null/invalid |
|---|---|---|---|---|
ValidityStart |
long |
The time in UTC milliseconds from the epoch |
Start of the subscriber’s validity period |
value ⇐0 implies validity until ValidityEnd |
ValidityEnd |
long |
The time in UTC milliseconds from the epoch |
End of the subscriber’s validity period |
value ⇐0 implies validity from ValidityStart |
Feature responses
| Response | Reason |
|---|---|
featureFailedToExecute |
invalid subscriber |
featureHasFinished |
feature has finished |
Configuration
There are no general, feature-wide configuration parameters for this feature.
The subscriber validity fields are read using the Subscriber Data Lookup Feature.
| Parameter | Type | Description |
|---|---|---|
ValidityStart |
String |
Time and timezone of subscription validity |
ValidityEnd |
String |
Time and timezone of subscription validity |
-
The format of these parameters must follow the ISO 8601 standard, specifically the
YYYY-MM-DDThh:mm:ss±hh:mmformat. -
ValidityEnd must be: the same day as ValidityStart or later; not set.
-
ValidityStart must be: the same day as ValidityEnd or earlier; not set.
Example:
ValidityStart |
2011-03-04T12:00:00+02:00 |
|---|---|
ValidityEnd |
2070-03-04T00:00:00-08:00 |
If neither ValidityEnd nor ValidityStart are set, the session is valid.
Provisioning interfaces
The Subscriber Validity Feature is provisioned using the Subscriber Data Lookup Feature.
