The <insertSubscriberRequest> request provisions stand-alone IMSI and MSISDN routing entities or groups of related IMSI/MSISDN routing entities. This is referred to as subscriber data. This data contains relationships between IMSI and MSISDN routing entities along with an optional Account ID value. Each routing entity contains up to eight destination names. Each destination contains FQDN and realm values, which are used for routing messages.
When the group="y" attribute is specified, the <insertSubscriberRequest> request establishes relationships between IMSI, MSISDN and Account ID values. When adding a new IMSI or MSISDN value to a subscriber, the <insertSubscriberRequest> request creates a new IMSI or MSISDN routing entity. If any IMSI or MSISDN exists in the SDS database, the request fails, regardless of the group="y" attribute specification.
After a subscriber is created, all subsequent requests can use any of the subscriber's IMSI, MSISDN, or Account ID values to update, delete, or read the subscriber.
If the group="n" attribute is specified, the request establishes stand-alone entries of IMSI and MSISDN.
The request can also be used to remove a destination value from existing IMSI and/or MSISDN routing entities by specifying "none" as the destination name.
<insertSubscriberRequest [timeout="timeout"] [group="group"]> <insertAddressList> [ <accountId>accountId</accountId> ] [ <imsi>imsi</msi> … [ <imsi>imsi</msi> ] [ <msisdn>msisdn</msisdn> … <msisdn>msisdn</msisdn> ] </insertAddressList> <destinationList> [ <imshss>imshss</imshss> ] [ <ltehss>ltehss</ltehss> ] [ <pcrf>pcrf</pcrf> ] [ <ocs>ocs</ocs> ] [ <ofcs>ofcs</ofcs> ] [ <aaa>aaa</aaa> ] [ <userdef1>userdef1</userdef1> ] [ <userdef2>userdef2</userdef2> ] </destinationList> </updateSubscriberRequest>
Parameter | Description | Values |
---|---|---|
timeout (Optional) | The amount of time (in seconds) to wait before being able to perform a write if another connection is performing a write, or has a transaction open. Clients waiting to write will be processed in the order that their requests were received.
If the request is being performed within a transaction, this parameter will have no effect, as the client already has a transaction open. |
0 (return immediately if not available) to 3600 seconds (default is 0). |
group (Optional) | Indicates if relationships between a group of related IMSI and/or MSISDN routing entities and Account ID value should be created/updated. |
|
insertAddressList | XML tag that contains a list of addresses to be created or updated. | Must have at least 1 of the following tags and values:
|
accountId (Optional) | A user-defined Account ID value to add or update. | 1 to 26 numeric digits. |
imsi (Optional) | An IMSI (specified in E.212 format) value to add or update. | 10 to 15 numeric digits. |
msisdn (Optional) | An MSISDN (specified in E.164 international public telecommunication numbering plan format) value to add or update. | 8 to 15 numeric digits. |
destinationList (Optional) | XML tag that contains a list of destination values to update or set in the routing entity(s). | Can be empty, or contain any of the following destination tags and values: imshss, ltehss, pcrf, ocs, ofcs, aaa, userdef1, and/or userdef2. |
imshss (Optional) | The name of the IMS HSS destination. | A string with 1 to 32 characters. |
ltehss (Optional) | The name of the LTE HSS destination. | A string with 1 to 32 characters. |
pcrf (Optional) | The name of the PCRF destination. | A string with 1 to 32 characters. |
ocs (Optional) | The name of the OCS destination. | A string with 1 to 32 characters. |
ofcs (Optional) | The name of the OFCS destination. | A string with 1 to 32 characters. |
aaa (Optional) | The name of the AAA server destination. | A string with 1 to 32 characters. |
userdef1 (Optional) | The name of the first user defined destination. | A string with 1 to 32 characters. |
userdef2 (Optional) | The name of the second user defined destination. | A string with 1 to 32 characters. |