Simswap
SimswapSubscriptions
Sim Swap Subscriptions
Create a sim swap event subscription for a phone number
Retrieve a list of sim swap event subscription
Retrieve a sim swap event subscription for a phone number
Delete a sim swap event subscription
ModelsExpand Collapse
SimSwapConfig object { subscriptionDetail, subscriptionExpireTime, subscriptionMaxEvents } Implementation-specific configuration parameters needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like subscriptionExpireTime or subscriptionMaxEvents to limit subscription lifetime.
Event type attributes must be defined in subscriptionDetail
Implementation-specific configuration parameters needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like subscriptionExpireTime or subscriptionMaxEvents to limit subscription lifetime.
Event type attributes must be defined in subscriptionDetail
subscriptionDetail: object { phoneNumber } The detail of the requested event subscription
The detail of the requested event subscription
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ’+’.
The subscription expiration time (in date-time format) requested by the API consumer. It must follow RFC 3339 and must have time zone.
SimSwapSubscription object { id, config, protocol, 5 more } Represents a event-type subscription.
Represents a event-type subscription.
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as subscriptionId as per Commonalities Event Notification Model.
Implementation-specific configuration parameters needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like subscriptionExpireTime or subscriptionMaxEvents to limit subscription lifetime.
Event type attributes must be defined in subscriptionDetail
Implementation-specific configuration parameters needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like subscriptionExpireTime or subscriptionMaxEvents to limit subscription lifetime.
Event type attributes must be defined in subscriptionDetail
subscriptionDetail: object { phoneNumber } The detail of the requested event subscription
The detail of the requested event subscription
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ’+’.
The subscription expiration time (in date-time format) requested by the API consumer. It must follow RFC 3339 and must have time zone.
Camara Event types eligible for subscription:
- org.camaraproject.sim-swap-subscriptions.v0.swapped: receive a notification when a sim swap is performed on the line. Note: for the Commonalities meta-release v0.4 we enforce to have only event type per subscription then for following meta-release use of array MUST be decided at API project level.
Date when the event subscription will expire. Only provided when subscriptionExpireTime is indicated by API client or Telco Operator has specific policy about that.
It must follow RFC 3339 and must have time zone.
Date when the event subscription will begin/began It must follow RFC 3339 and must have time zone.
status: optional "ACTIVATION_REQUESTED" or "ACTIVE" or "EXPIRED" or 2 moreCurrent status of the subscription - Management of Subscription State engine is not mandatory for now. Note not all statuses may be considered to be implemented. Details:
ACTIVATION_REQUESTED: Subscription creation (POST) is triggered but subscription creation process is not finished yet.ACTIVE: Subscription creation process is completed. Subscription is fully operative.INACTIVE: Subscription is temporarily inactive, but its workflow logic is not deleted.EXPIRED: Subscription is ended (no longer active). This status applies when subscription is ended due to SUBSCRIPTION_EXPIRED event.DELETED: Subscription is ended as deleted (no longer active). This status applies when subscription information is kept (i.e. subscription workflow is no longer active but its metainformation is kept).
Current status of the subscription - Management of Subscription State engine is not mandatory for now. Note not all statuses may be considered to be implemented. Details:
ACTIVATION_REQUESTED: Subscription creation (POST) is triggered but subscription creation process is not finished yet.ACTIVE: Subscription creation process is completed. Subscription is fully operative.INACTIVE: Subscription is temporarily inactive, but its workflow logic is not deleted.EXPIRED: Subscription is ended (no longer active). This status applies when subscription is ended due toSUBSCRIPTION_EXPIREDevent.DELETED: Subscription is ended as deleted (no longer active). This status applies when subscription information is kept (i.e. subscription workflow is no longer active but its metainformation is kept).
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as subscriptionId as per Commonalities Event Notification Model.
Implementation-specific configuration parameters needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like subscriptionExpireTime or subscriptionMaxEvents to limit subscription lifetime.
Event type attributes must be defined in subscriptionDetail
Implementation-specific configuration parameters needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like subscriptionExpireTime or subscriptionMaxEvents to limit subscription lifetime.
Event type attributes must be defined in subscriptionDetail
subscriptionDetail: object { phoneNumber } The detail of the requested event subscription
The detail of the requested event subscription
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ’+’.
The subscription expiration time (in date-time format) requested by the API consumer. It must follow RFC 3339 and must have time zone.
Camara Event types eligible for subscription:
- org.camaraproject.sim-swap-subscriptions.v0.swapped: receive a notification when a sim swap is performed on the line. Note: for the Commonalities meta-release v0.4 we enforce to have only event type per subscription then for following meta-release use of array MUST be decided at API project level.
Date when the event subscription will expire. Only provided when subscriptionExpireTime is indicated by API client or Telco Operator has specific policy about that.
It must follow RFC 3339 and must have time zone.
Date when the event subscription will begin/began It must follow RFC 3339 and must have time zone.
status: optional "ACTIVATION_REQUESTED" or "ACTIVE" or "EXPIRED" or 2 moreCurrent status of the subscription - Management of Subscription State engine is not mandatory for now. Note not all statuses may be considered to be implemented. Details:
ACTIVATION_REQUESTED: Subscription creation (POST) is triggered but subscription creation process is not finished yet.ACTIVE: Subscription creation process is completed. Subscription is fully operative.INACTIVE: Subscription is temporarily inactive, but its workflow logic is not deleted.EXPIRED: Subscription is ended (no longer active). This status applies when subscription is ended due to SUBSCRIPTION_EXPIRED event.DELETED: Subscription is ended as deleted (no longer active). This status applies when subscription information is kept (i.e. subscription workflow is no longer active but its metainformation is kept).
Current status of the subscription - Management of Subscription State engine is not mandatory for now. Note not all statuses may be considered to be implemented. Details:
ACTIVATION_REQUESTED: Subscription creation (POST) is triggered but subscription creation process is not finished yet.ACTIVE: Subscription creation process is completed. Subscription is fully operative.INACTIVE: Subscription is temporarily inactive, but its workflow logic is not deleted.EXPIRED: Subscription is ended (no longer active). This status applies when subscription is ended due toSUBSCRIPTION_EXPIREDevent.DELETED: Subscription is ended as deleted (no longer active). This status applies when subscription information is kept (i.e. subscription workflow is no longer active but its metainformation is kept).