Salesforce UX API
TMF638-NetworkSettingsTowardsEDA
This operation allows you to view/update of a below service entity based on MSISDN.
This API is designed to support multiple services for update or fetch service in/from network settings (EDA).
Please note that all services in the request body are optional, it will support to update one service/ multiple services in single request.
Suppose
• If you want to update the "smsService", then you can pass only the smsService node/object in request body, no need to pass rest of the services node/object in request.
• If you want to update the "smsService & mmsService" together then the request body will have the smsService & mmsService nodes/objects in request body.
---> Update Network Settings
Request
This section defines all the possible data structures sent by the client when consuming the method.
URL
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/service/{id}URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| id | string | MSISDN (Mobile Subscriber ISDN Number), Identifier of the Service. | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | Y |
Request
Request For Enable Services
{
"serviceType": "Prepaid",
"supportingResource": [
{
"id": "313790888003780",
"name": "IMSI"
}
],
"serviceRelationship": [
{
"service": {
"category": "smsService",
"supportingService": [
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "ts21",
"value": "1",
"@type": "ts"
},
{
"name": "ts22",
"value": "1",
"@type": "ts"
}
]
}
]
}
]
}
},
{
"service": {
"category": "mmsService",
"supportingService": [
{
"feature": [
{
"name": "EPS",
"featureCharacteristic": [
{
"name": "epsprofileid",
"value": "1004",
"@type": "epsProfile"
}
]
}
]
}
]
}
},
{
"service": {
"category": "callWaiting",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"featureCharacteristic": [
{
"name": "cw-operator-configuration",
"value": "true",
"@type": "communication-waiting"
}
]
}
]
},
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "provisionState",
"value": "1",
"@type": "caw"
},
{
"name": "activationState",
"value": "1",
"@type": "caw"
}
]
}
]
}
]
}
},
{
"service": {
"category": "callerId",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"featureCharacteristic": [
{
"name": "activated",
"value": "false",
"@type": "oir-operator-configuration"
},
{
"name": "mode",
"value": "permanent",
"@type": "oir-operator-configuration"
},
{
"name": "restriction",
"value": "all-private-information",
"@type": "oir-operator-configuration"
}
]
}
]
}
]
}
}
]
}Request For Disable Services
{
"serviceType": "Prepaid",
"supportingResource": [
{
"id": "313790888003780",
"name": "IMSI"
}
],
"serviceRelationship": [
{
"service": {
"category": "smsService",
"supportingService": [
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "ts21",
"value": "0",
"@type": "ts"
},
{
"name": "ts22",
"value": "0",
"@type": "ts"
}
]
}
]
}
]
}
},
{
"service": {
"category": "callWaiting",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"featureCharacteristic": [
{
"name": "cw-operator-configuration",
"value": "false",
"@type": "communication-waiting"
},
{
"name": "cw-user-configuration",
"value": "false",
"@type": "communication-waiting"
}
]
}
]
},
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "provisionState",
"value": "1",
"@type": "caw"
},
{
"name": "activationState",
"value": "0",
"@type": "caw"
}
]
}
]
}
]
}
},
{
"service": {
"category": "callerId",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"featureCharacteristic": [
{
"name": "activated",
"value": "true",
"@type": "oir-operator-configuration"
},
{
"name": "mode",
"value": "permanent",
"@type": "oir-operator-configuration"
},
{
"name": "restriction",
"value": "all-private-information",
"@type": "oir-operator-configuration"
}
]
}
]
}
]
}
}
]
}Update Call-Forwarding Settings in EDA
Note - ESB request will be dynamic, both (MTAS & HLR) settings can be updated together or can be update individually. It's up to requirement how you want to modify settings.
Currently the CFB, CFNR/CFNRY, CFB only in applicable
Enable CFU, CFB & CFNR Ruleset towards EDA
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/service/12218073093' \
--header 'X-Correlation-ID: 87654321' \
--header 'client_id: abcd' \
--header 'client_secret: 1234567' \
--header 'Content-Type: application/json' \
--data-raw '{
"serviceType": "Prepaid",
"serviceRelationship": [
{
"service": {
"category": "callForwarding",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"featureCharacteristic": [
{
"name": "cfu",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566"
}
},
{
"name": "cfb",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566"
}
},
{
"name": "cfnr",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566",
"NoReplyTimer": "10"
}
}
]
}
]
},
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "cfu",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566"
}
},
{
"name": "cfb",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566"
}
},
{
"name": "cfnry",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566",
"NoReplyTimer": "10"
}
}
]
}
]
}
]
}
}
]
}'Disable CFU, CFB & CFNR Ruleset towards EDA
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/service/12218073093' \
--header 'X-Correlation-ID: 87654321' \
--header 'client_id: abcd' \
--header 'client_secret: 1234567' \
--header 'Content-Type: application/json' \
--data-raw '{
"serviceType": "Prepaid",
"serviceRelationship": [
{
"service": {
"category": "callForwarding",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"featureCharacteristic": [
{
"name": "cfu",
"valueType": "object",
"value": {
"action": "disable"
}
},
{
"name": "cfb",
"valueType": "object",
"value": {
"action": "disable"
}
},
{
"name": "cfnr",
"valueType": "object",
"value": {
"action": "disable"
}
}
]
}
]
},
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "cfu",
"valueType": "object",
"value": {
"action": "disable"
}
},
{
"name": "cfb",
"valueType": "object",
"value": {
"action": "disable"
}
},
{
"name": "cfnry",
"valueType": "object",
"value": {
"action": "disable"
}
}
]
}
]
}
]
}
}
]
}'Disable CFU and Enable CFB & CFNR Ruleset towards EDA
Note - You can do disable & enable Ruleset together with any combination of CFU, CFB & CFNR.
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/service/12218073093' \
--header 'X-Correlation-ID: 87654321' \
--header 'client_id: abcd' \
--header 'client_secret: 1234567' \
--header 'Content-Type: application/json' \
--data-raw '{
"serviceType": "Prepaid",
"serviceRelationship": [
{
"service": {
"category": "callForwarding",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"featureCharacteristic": [
{
"name": "cfu",
"valueType": "object",
"value": {
"action": "disable"
}
},
{
"name": "cfb",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566"
}
},
{
"name": "cfnr",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566",
"NoReplyTimer": "10"
}
}
]
}
]
},
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "cfu",
"valueType": "object",
"value": {
"action": "disable"
}
},
{
"name": "cfb",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566"
}
},
{
"name": "cfnry",
"valueType": "object",
"value": {
"action": "enable",
"forwardingNumber": "12233445566",
"NoReplyTimer": "10"
}
}
]
}
]
}
]
}
}
]
}'Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| serviceType | string | Business type of the service | Y |
| supportingResource | array | A list of supporting resources. Note: It is mandatory if category is roamingService or mmsService whenever the Feature name is EPS and IMS | Y* |
| supportingResource.id | string | unique identifier. Note: It is mandatory if category is roamingService or mmsService whenever the Feature name is EPS and IMS | Y* |
| supportingResource.name | string | Name of the related entity. Note: It is mandatory if category is roamingService or mmsService whenever the Feature name is EPS and IMS | Y* |
| serviceRelationship | array | A list of service relationships | Y |
| serviceRelationship.service | object | A service ref or value | Y |
| serviceRelationship.service.category | string | Resource facing service. | Y |
| serviceRelationship.service.supportingService | array | A list of supporting services | N |
| serviceRelationship.service.supportingService.feature | array | A list of feature associated with this service. | N |
| serviceRelationship.service.supportingService. feature.name | string | Name for the feature or Network Element | Y |
| serviceRelationship.service.supportingService. feature.isEnabled | boolean | Communication diversion service Note1: the value will be "true" whenever want to disable/inactive the streamSaver service otherwise this field itself not needed Eg: "isEnabled":true | N |
| serviceRelationship.service.supportingService. feature.featureCharacteristic | array | A list of Characteristics for a particular feature. | N |
| serviceRelationship.service.supportingService. feature.featureCharacteristic.name | string | Attribute name of Network Element | Y |
| serviceRelationship.service.supportingService. feature.featureCharacteristic.value | string | Attribute value of Network Element | Y |
| serviceRelationship.service.supportingService. feature.featureCharacteristic.@type | string | Reference type of featureCharacteristic. Conditional Mandatory Note1 - @type is mandatory when the "serviceRelationship.service.category" = "internationalCalls" or "callWaiting" or "callForwarding" only for HLR network element call. Note2 - @type is mandatory when the "serviceRelationship.service.category" = "callerId" only for MTAS network element call. | Y* |
| serviceRelationship.service.supportingService. feature.featureCharacteristic.@baseType | string | Services base type | N |
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
OK - PATCH request processed successfully, response body contains an entity corresponding to the requested resource.
{
"id": "17873904518",
"description": "MSISDN",
"supportingResource": [
{
"id": "313790888003780",
"name": "IMSI"
}
],
"serviceRelationship": [
{
"service": {
"category": "smsService",
"supportingService": [
{
"feature": [
{
"name": "HLR"
}
]
}
]
}
},
{
"service": {
"category": "mmsService",
"supportingService": [
{
"feature": [
{
"name": "EPS"
}
]
}
]
}
},
{
"service": {
"category": "callWaiting",
"supportingService": [
{
"feature": [
{
"name": "MTAS"
}
]
},
{
"feature": [
{
"name": "HLR"
}
]
}
]
}
},
{
"service": {
"category": "callForwarding",
"supportingService": [
{
"feature": [
{
"name": "MTAS"
}
]
},
{
"feature": [
{
"name": "HLR"
}
]
}
]
}
},
{
"service": {
"category": "callerId",
"supportingService": [
{
"feature": [
{
"name": "MTAS"
}
]
}
]
}
}
]
}Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | Unique identifier of the service. | N |
| description | string | Free-text description of the service. | N |
| supportingResource | array | A list of supporting resources | N |
| supportingResource.id | string | value of Mobile Subscriber ISDN Number, (E164) | N |
| supportingResource.name | string | Name of the related entity. | N |
| serviceRelationship | array | A list of service relationships | N |
| serviceRelationship.service | object | A service ref or value | N |
| serviceRelationship.service.category | string | Resource facing service. | N |
| serviceRelationship.service.supportingService | array | A list of supporting services | N |
| serviceRelationship.service.supportingService.feature | array | A list of feature associated with this service. | N |
| serviceRelationship.service.supportingService.feature.name | string | Name for the feature or Network Element | N |
| serviceRelationship.service.supportingService. serviceCharacteristic | array | A list of characteristics | N |
| serviceRelationship.service.supportingService. serviceCharacteristic.name | string | Name of the characteristic. | N |
| serviceRelationship.service.supportingService. serviceCharacteristic.value | string | Value of the characteristic. | N |
---> View Network Settings
Request
This section defines all the possible data structures sent by the client when consuming the method.
URL
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/service/{id}URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. | Y |
| id | string | Mobile Subscriber ISDN Number (MSISDN) | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| serviceRelationship.service.category | string | Resource facing service. Eg: VMS/SMS/MMS/Roaming /Hotspot Service etc, possible values are below mobileService callBarringService vmsService smsService dataService roamingService internationalCalls streamSaver hotspot mmsService callWaiting callForwarding callerId | N |
| serviceType | string | Business type of the service Eg: Prepaid/Postpaid | Y |
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
OK - retrieveService request processed successfully, response body contains an entity corresponding to the requested resource.
{
"id": "17873904518",
"description": "Mobile Subscriber ISDN Number",
"serviceRelationship": [
{
"service": {
"category": "mobileService",
"state": "active",
"supportingService": [
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "ts11",
"value": "1"
}
]
}
],
"supportingResource": [
{
"id": "313790701083856",
"name": "IMSI"
}
]
}
]
}
},
{
"service": {
"category": "callBarringService",
"state": "active",
"supportingService": [
{
"feature": [
{
"name": "HLR"
}
],
"supportingResource": [
{
"id": "313790701083856",
"name": "IMSI"
}
]
},
{
"feature": [
{
"name": "MTAS"
}
]
}
]
}
},
{
"service": {
"category": "smsService",
"state": "inactive",
"supportingService": [
{
"feature": [
{
"name": "HLR"
}
],
"supportingResource": [
{
"id": "313790701083856",
"name": "IMSI"
}
]
}
]
}
},
{
"service": {
"category": "hotspot",
"state": "active",
"supportingService": [
{
"feature": [
{
"name": "SAPC",
"featureCharacteristic": [
{
"name": "pcGroupId",
"value": "PRVDPREMHSV1"
}
]
}
]
}
]
}
},
{
"service": {
"category": "mmsService",
"state": "active",
"supportingService": [
{
"feature": [
{
"name": "EPS",
"featureCharacteristic": [
{
"name": "epsProfileId",
"value": "epsProfile"
},
{
"name": "IMSI",
"value": "313790701083856"
},
{
"name": "msisdn",
"value": "17873904518"
},
{
"name": "epsOdb",
"value": "NONE"
},
{
"name": "epsRoamingAllowed",
"value": "false"
},
{
"name": "mmeAddress",
"value": "prmimme01.epc.mnc790.mcc313.3gppnetwork.org"
},
{
"name": "epsLocationState",
"value": "LOCATED"
},
{
"name": "epsRoamingRestriction",
"value": "true"
},
{
"name": "epsExtendedAccessRestriction",
"value": "0"
},
{
"name": "epsAaaRegistrationState",
"value": "AAA_ASSIGNED"
},
{
"name": "epsAaaAddress",
"value": "prmiaaa01.epc.mnc790.mcc313.3gppnetwork.org"
},
{
"name": "epsAaaRealm",
"value": "epc.mnc790.mcc313.3gppnetwork.org"
},
{
"name": "epsDynamicPdnInformation",
"value": "ims$topon.pgw.prmiepgc01.node.epc.mnc790.mcc313.3gppnetwork.org$epc.mnc790.mcc313.3gppnetwork.org$$,testapn$topon.pgw.prmiepgc01.node.epc.mnc790.mcc313.3gppnetwork.org$epc.mnc790.mcc313.3gppnetwork.org$$"
},
{
"name": "epsUeSrVccCap",
"value": "1"
},
{
"name": "epsTenantId",
"value": "3"
},
{
"name": "epsSessionTransferNumber",
"value": "468509990002"
},
{
"name": "epsImeiSv",
"value": "3510850301377612"
},
{
"name": "epsLastUpdateLocationDate",
"value": "20240308T180117590"
},
{
"name": "epsMmeRealm",
"value": "epc.mnc790.mcc313.3gppnetwork.org"
}
]
}
],
"supportingResource": [
{
"id": "313790701083856",
"name": "IMSI"
}
]
}
]
}
},
{
"service": {
"category": "callWaiting",
"state": "inactive",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"featureCharacteristic": [
{
"name": "service-profile-identity",
"value": "sip:PRVOLTE@ims.mnc790.mcc313.3gppnetwork.org"
}
]
}
]
},
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "caw.ts10.activationState",
"value": "0"
},
{
"name": "caw.bs30.activationState",
"value": "0"
}
]
}
],
"supportingResource": [
{
"id": "313790701083856",
"name": "IMSI"
}
]
}
]
}
},
{
"service": {
"category": "callForwarding",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"@type": "CdivUserConfiguration",
"featureCharacteristic": [
{
"name": "cfb",
"value": "active",
"characteristicRelationship": [
{
"id": "cfb",
"relationshipType": "id"
},
{
"id": "tel:12233445566;phone-context=ims.mnc790.mcc313.3gppnetwork.org",
"relationshipType": "target"
},
{
"id": "busy",
"relationshipType": "cdiv-call-state"
}
]
},
{
"name": "cfu",
"value": "active",
"characteristicRelationship": [
{
"id": "cfu",
"relationshipType": "id"
},
{
"id": "tel:12233445566;phone-context=ims.mnc790.mcc313.3gppnetwork.org",
"relationshipType": "target"
}
]
},
{
"name": "cfnr",
"value": "active",
"characteristicRelationship": [
{
"id": "cfnr",
"relationshipType": "id"
},
{
"id": "tel:12233445566;phone-context=ims.mnc790.mcc313.3gppnetwork.org",
"relationshipType": "target"
},
{
"id": "10",
"relationshipType": "NoReplyTimer"
},
{
"id": "no-answer",
"relationshipType": "cdiv-call-state"
}
]
}
]
}
]
},
{
"feature": [
{
"name": "HLR",
"featureCharacteristic": [
{
"name": "cfb",
"value": "Inactive",
"characteristicRelationship": [
{
"id": "1",
"relationshipType": "provisionState"
},
{
"id": "0",
"relationshipType": "ts10.activationState"
},
{
"id": "0",
"relationshipType": "bs30.activationState"
}
]
},
{
"name": "cfu",
"value": "Inactive",
"characteristicRelationship": [
{
"id": "1",
"relationshipType": "provisionState"
},
{
"id": "0",
"relationshipType": "ts10.activationState"
},
{
"id": "0",
"relationshipType": "bs30.activationState"
}
]
},
{
"name": "cfnry",
"value": "Inactive",
"characteristicRelationship": [
{
"id": "1",
"relationshipType": "provisionState"
},
{
"id": "0",
"relationshipType": "ts10.activationState"
},
{
"id": "0",
"relationshipType": "bs30.activationState"
}
]
},
{
"name": "cfnrc",
"value": "Inactive",
"characteristicRelationship": [
{
"id": "1",
"relationshipType": "provisionState"
},
{
"id": "0",
"relationshipType": "ts10.activationState"
},
{
"id": "0",
"relationshipType": "bs30.activationState"
}
]
},
{
"name": "dcf",
"value": "Inactive"
}
]
}
],
"supportingResource": [
{
"id": "313790999200000",
"name": "IMSI"
}
]
}
]
}
},
{
"service": {
"category": "callerId",
"state": "inactive",
"supportingService": [
{
"feature": [
{
"name": "MTAS",
"featureCharacteristic": [
{
"name": "service-profile-identity",
"value": "sip:PRVOLTE@ims.mnc790.mcc313.3gppnetwork.org"
}
]
}
]
}
]
}
}
]
}Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | Unique identifier of the service. In this case MSISDN number | N |
| description | string | Description of the service. | N |
| serviceRelationship | array | A list of service relationships | N |
| serviceRelationship.service | object | A service ref or value | N |
| serviceRelationship.service.category | string | Resource facing service. | N |
| serviceRelationship.service.state | string | Status of service | N |
| serviceRelationship.service.supportingService | array | A list of supporting services | N |
| serviceRelationship.service.supportingService.feature | array | A list of feature associated with this service. | N |
| serviceRelationship.service.supportingService.feature.name | string | Name of the Network Element | N |
| serviceRelationship.service.supportingService.feature.featureCharacteristic | array | This is a list of Characteristics for a particular feature. | N |
| serviceRelationship.service.supportingService.feature.featureCharacteristic.name | string | Attribute name of Network Element | N |
| serviceRelationship.service.supportingService.feature.featureCharacteristic.value | string | Attribute value of Network Element | N |
| serviceRelationship.service.supportingService.supportingResource | array | A list of supporting resources | N |
| serviceRelationship.service.supportingService.supportingResource.id | string | Unique identifier of Resource | N |
| serviceRelationship.service.supportingService.supportingResource.name | string | Name of the resource | N |
| serviceRelationship.service.supportingService.serviceCharacteristic | array | A list of characteristics that characterize this service | N |
| serviceRelationship.service.supportingService.serviceCharacteristic.name | string | Name of the characteristic. | N |
| serviceRelationship.service.supportingService.serviceCharacteristic.value | string | he value of the characteristic. | N |