Change4GDeviceIdentifier

Changes the identifier of a 4G device to match hardware changes made for a line of service. Use this API to transfer the line of service and the MSISDN to new hardware, or to change the MSISDN.

Uses and Requirements

Which Option to Use

Getting Device History after Changing Identifiers

• After changing a device identifier, the old identifier cannot be used to get any device history, such as with GetAggrregateDeviceUsage or GetDeviceProvisioningHistory.
• You can use a device identifier that did not change to get any type of device history that spans the change date. For example, you can use the MSISDN if you only changed the ICCID.

Required Device States

NOTE: Both of these conditions must be true for this call to succeed:

• The existing device must be in the Active state with an MSISDN assigned.
• The new hardware (IMEI or ICCID) cannot already be in the ThingSpace Platform database. To reuse a deactivated device, you must first send a DeleteDevices request to remove it from the database.

Callback Messages

The ThingSpace Platform sends a CarrierService callback message when the device identifier has been changed, or if there was a problem and the change could not be completed.

Request Parameters

Response Parameters

Callback Response Parameters

Example SOAP Request

Put a new SIM in a 4G device

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
 xmlns:v2="http://nphase.com/unifiedwebservice/v2" 
 xmlns:nph="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.CarrierService" 
 xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
  <soapenv:Header>
    <v2:token>e1b27a04-d67a-4b16-be49-6227172fcb54</v2:token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:Change4GDeviceIdentifier>
      <v2:Input>
        <nph:Device>
          <nph1:Kind>iccid</nph1:Kind>
          <nph1:Identifier>61898914800000113481</nph1:Identifier>
        </nph:Device>
        <nph:Change4GOption>ChangeICCID</nph:Change4GOption>
        <nph:ChangeDeviceIdentifierTo>
          <nph1:Kind>iccid</nph1:Kind>
          <nph1:Identifier>89148000000842590078</nph1:Identifier>
        </nph:ChangeDeviceIdentifierTo>
        <nph:ServicePlan>M2M_4G</nph:ServicePlan>
      </v2:Input>
    </v2:Change4GDeviceIdentifier>
  </soapenv:Body>
</soapenv:Envelope>

Request a new phone number

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:v2="http://nphase.com/unifiedwebservice/v2" 
xmlns:nph="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.CarrierService" 
xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
<soapenv:Header>
  <v2:token>e1b27a04-d67a-4b16-be49-6227172fcb54</v2:token>
</soapenv:Header>
<soapenv:Body>
  <v2:Change4GDeviceIdentifier>
    <v2:Input>
      <nph:Device>
        <nph1:Kind>iccid</nph1:Kind>
        <nph1:Identifier>61898914800000113481</nph1:Identifier>
      </nph:Device>
      <nph:Change4GOption>ChangeMSISDN</nph:Change4GOption>
      <nph:AssignNonGeoMdn>false</nph:AssignNonGeoMdn>
      <nph:NpaNxx>509393</nph:NpaNxx>
      <nph:ServicePlan>M2M_4G</nph:ServicePlan>
    </v2:Input>
  </v2:Change4GDeviceIdentifier>
</soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Change4GDeviceIdentifierResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.CarrierService">
        <a:RequestId>d747ec03-312e-4a20-bcee-c0686d48afb4</a:RequestId>
      </Output>
    </Change4GDeviceIdentifierResponse>
  </s:Body>
</s:Envelope>

Example SOAP Callback

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <CallbackRequest xmlns="http://nphase.com/unifiedwebservice/v2">
      <Username/>
      <Password/>
      <RequestId>a28892ea-6503-4aa7-bfa2-4cd45d42f61b</RequestId>
      <Device>
        <Kind>ESN</Kind>
        <Identifier>22211315718</Identifier>
      </Device>
      <Data>
        <Data>
          <CarrierService>
            <ChangeDeviceState xsi:nil="true"/>
            <ChangeDeviceFeatureCodes xsi:nil="true"/>
            <ChangeDeviceServicePlan xsi:nil="true"/>
            <ChangeDeviceCostCenter xsi:nil="true"/>
            <ChangeDeviceCustomFields xsi:nil="true"/>
            <ChangeDeviceIdentifier xsi:nil="true"/>
            <Change4GDeviceIdentifier>
              <DeviceIdentifierChanged>
                <Kind>iccid</Kind>
                <Identifier>89148000000842590078</Identifier>
              </DeviceIdentifierChanged>
              <ServicePlan>M2M_4G</ServicePlan>
              <SmsrOid>1.3.6.1.4.1.31746.1.500.200.101.5</SmsrOid>
              <ProfileStatus />
            </Change4GDeviceIdentifier>
            <MoveDevice xsi:nil="true"/>
            <ChangeDeviceContactInfo xsi:nil="true"/>
          </CarrierService>
          <ExternalProvisioningChange xsi:nil="true"/>
          <PromoChange xsi:nil="true"/>
          <Usage xsi:nil="true"/>
          <SMSDelivery xsi:nil="true"/>
          <PRLInformation xsi:nil="true"/>
          <DeviceSuspendStatus xsi:nil="true"/>
          <GoToState xsi:nil="true"/>
          <Fault xsi:nil="true"/>
          <Comment xsi:nil="true"/>
          <Summary xsi:nil="true"/>
          <Status>Success</Status> 
          <CallbackCount>1</CallbackCount>
          <MaxCallbackThreshold>4</MaxCallbackThreshold/>
        </Data>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>

Request Schema Diagram

Response Schema Diagram