ExternalProvisioningChange Callback

The ExternalProvisioningChanges callback service sends messages to your registered URL when provisioning changes are made outside of the Wireless Network Services APIs (such as when a 4G SIM completes OTA activation) or when a user performs one of the following provisioning actions from an interactive Verizon system:

Callback Parameters

Parameter Type Description
CallbackRequest CallbackRequest Wrapper element for all callback elements.
Username string The username defined when a URL was registered for the callback service, or an empty element if no username was defined.
Password string The password defined when a registered for the callback service, or an empty element if no password was defined.
Device DeviceIdentifier The device that was changed, specified by device identifier. This parameter is not included for device activations.
Kind string

The type of the device identifier. Valid types of identifiers are:

  • ESN (decimal)
  • ICCID (up to 20 digits)
  • IMEI (up to 15 digits)
  • MDN
  • MEID (hexadecimal)
  • MIN
  • MSISDN
Identifier string The value of the device identifier.
Data CallbackData The data elements for this callback.
ExternalProvisioningChange ExternalProvisioningChange Details about the change that was made to the device, and the resulting device status and information.
Source string The tool that was used to make the change.
Change string

A description of the change that was made to the device. The most common values are:

  • Activate
  • Suspend
  • Restore
  • Deactivate
  • ChangeEsn
  • changeDevice3gTo4g
  • changeDevice4gTo3g
  • changeIMEI
  • changeICCID
  • changeiMEIiCCID
  • Device Detection
DeviceInfo DeviceInformation The current information about the device, after the external change was applied.
AccountName string The account that the device is associated with.
CarrierInformation CarrierInformation The carrier information associated with the device.
CarrierName string The name of the carrier.
ServicePlan string The service plan that is assigned to the device.
State string

The current state of the device, which will be one of these values:

  • Pre-active
  • active
  • deactive
  • suspend
  • pending resume
  • pending MDN change
  • pending PRL Update
  • pending preactive
  • pending activation
  • pending deactivation
  • pending suspend
  • pending service plan change
  • pending ESN / MEID change
  • pending account update
DeviceGroupName string The device groups that the device belongs to.
DeviceIdentifiers DeviceIdentifier One or more identifiers for the device.
Kind string

The type of the device identifier. Valid types of identifiers are:

  • ESN (decimal)
  • ICCID (up to 20 digits)
  • IMEI (up to 15 digits)
  • MDN
  • MEID (hexadecimal)
  • MIN
  • MSISDN
Identifier string The value of the device identifier.
CreatedAt dateTime The date and time that the device was added to the system.
IPAddress string The IP address of the device.
LastActivationDate dateTime The date and time that the device was last activated.
LastActivationBy string
BillingCycleEndDate dateTime The last day of the device's current billing cycle.
Connected boolean True if the device is connected; false if it is not.
LastConnectionDate dateTime If the device is not connected, this indicates the last known connection date.
CustomFields CustomFieldObj The names and values of all custom fields for the device.
Name string The names and values of all custom fields for the device.
Value string The value of the custom field.
FeatureCodes FeatureCode The feature codes for the device. Feature codes are only available with the Verizon Wholesale network.
Code string
Description string
PreIMEI string The IMEI of the device prior to the most recent SIM OTA activation.
PreSKU string The SKU of the device prior to the most recent SIM OTA activation.
SIMOTADate string The date and time of the most recent SIM OTA activation.
StateName string The customer-defined state of the device.
ServiceName string The name of the customer-defined service for the device.
ServiceAccount string The service account that the device is associated with.

Sample SOAP Callback Message

Activate

The following is an example message that the ExternalProvisioningChanges callback service sends when a system other than the Wireless Network Services ChangeDeviceState API activates a line of service for a device.

<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>0aafcb4a-91fe-46b0-9154-f84f410f0f49</RequestId>
      <Data>
        <Data>
          <CarrierService xsi:nil="true"/>
          <ExternalProvisioningChange>
            <Source xsi:nil="true" />
            <Change>Activate</Change>
            <DeviceInfo>
              <AccountName>Verizon Test 1</AccountName>
              <CarrierInformation>
                <CarrierName>Verizon Wireless</CarrierName>
                <ServicePlan>M2M</ServicePlan>
                <State>active</State>
              </CarrierInformation>
              <DeviceGroupName>AditiTest3</DeviceGroupName>
              <DeviceIdentifiers>
                <Kind>mdn</Kind>
                <Identifier>2300329133</Identifier>
              </DeviceIdentifiers>
              <DeviceIdentifiers>
                <Kind>meid</Kind>
                <Identifier>C1000000115253</Identifier>
              </DeviceIdentifiers>
              <DeviceIdentifiers>
                <Kind>min</Kind>
                <Identifier>8586925945</Identifier>
              </DeviceIdentifiers>
              <CreatedAt>2014-03-26T15:31:56.0000000Z</CreatedAt>
              <IPAddress>1.1.29.169</IPAddress>
              <LastActivationDate>2014-03-25T18:33:37.0000000Z</LastActivationDate>
              <LastActivationBy>User Verizon</LastActivationBy>
              <BillingCycleEndDate>2014-04-02T00:00:00.0000000Z</BillingCycleEndDate>
              <Connected>false</Connected>
              <LastConnectionDate xsi:nil="true"/>
            </DeviceInfo>
          </ExternalProvisioningChange>
          <PromoChange xsi:nil="true"/>
          <Usage xsi:nil="true"/>
          <SMSDelivery xsi:nil="true"/>
          <PRLInformation xsi:nil="true"/>
          <DeviceSuspendStatus xsi:nil="true"/>
          <Fault xsi:nil="true"/>
          <Comment xsi:nil="true"/>
        </Data>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>

Deactivate

The following is an example message that the ExternalProvisioningChanges callback service sends when a system other than the Wireless Network Services ChangeDeviceState API deactivates a line of service for a device.

<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>0aafcb4a-91fe-46b0-9154-f84f410f0f49</RequestId>
      <Device>
        <Kind>meid</Kind>
        <Identifier>A2000009D6BFE1</Identifier>
      </Device>
      <Data>
        <Data>
          <CarrierService xsi:nil="true"/>
          <ExternalProvisioningChange>
            <Source/>
            <Change>Deactivate</Change>
            <DeviceInfo>
              <AccountName>Verizon Test 1</AccountName>
              <CarrierInformation>
                <CarrierName>Verizon Wireless</CarrierName>
                <ServicePlan>M2M</ServicePlan>
                <State>deactive</State>
              </CarrierInformation>
              <DeviceGroupName>Default: Verizon Test 1</DeviceGroupName>
              <DeviceIdentifiers>
                <Kind>meid</Kind>
                <Identifier>A2000009D6BFE1</Identifier>
              </DeviceIdentifiers>
              <CreatedAt>2013-05-20T21:06:35.0000000Z</CreatedAt>
              <IPAddress xsi:nil="true"/>
              <LastActivationDate>2013-05-20T21:15:00.0000000Z</LastActivationDate>
              <LastActivationBy>rajupreprov rajupreprov</LastActivationBy>
              <BillingCycleEndDate>2013-07-01T00:00:00.0000000Z</BillingCycleEndDate>
              <Connected>false</Connected>
              <LastConnectionDate xsi:nil="true"/>
            </DeviceInfo>
          </ExternalProvisioningChange>
          <PromoChange xsi:nil="true"/>
          <Usage xsi:nil="true"/>
          <SMSDelivery xsi:nil="true"/>
          <PRLInformation xsi:nil="true"/>
          <DeviceSuspendStatus xsi:nil="true"/>
          <Fault xsi:nil="true"/>
          <Comment>SUCCESS</Comment>
        </Data>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>

Suspend

The following is an example message that the ExternalProvisioningChanges callback service sends when a system other than the Wireless Network Services ChangeDeviceState API suspends a line of service for a device.

<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>0aafcb4a-91fe-46b0-9154-f84f410f0f49</RequestId>
      <Device>
        <Kind>meid</Kind>
        <Identifier>A2000009D6BFE1</Identifier>
      </Device>
      <Data>
        <Data>
          <CarrierService xsi:nil="true"/>
          <ExternalProvisioningChange>
            <Source/>
            <Change>SUSPEND</Change>
            <DeviceInfo>
              <AccountName>Verizon Test 1</AccountName>
              <CarrierInformation>
                <CarrierName>Verizon Wireless</CarrierName>
                <ServicePlan>M2M</ServicePlan>
                <State>suspend</State>
              </CarrierInformation>
              <DeviceGroupName>Default: Verizon Test 1</DeviceGroupName>
              <DeviceIdentifiers>
                <Kind>mdn</Kind>
                <Identifier>3701882174</Identifier>
              </DeviceIdentifiers>
              <DeviceIdentifiers>
                <Kind>meid</Kind>
                <Identifier>A2000009D6BFE1</Identifier>
              </DeviceIdentifiers>
              <CreatedAt>2013-05-20T21:06:35.0000000Z</CreatedAt>
              <IPAddress xsi:nil="true"/>
              <LastActivationDate>2013-05-20T21:15:00.0000000Z</LastActivationDate>
              <LastActivationBy>rajupreprov rajupreprov</LastActivationBy>
              <BillingCycleEndDate>2013-07-01T00:00:00.0000000Z</BillingCycleEndDate>
              <Connected>false</Connected>
              <LastConnectionDate xsi:nil="true"/>
            </DeviceInfo>
          </ExternalProvisioningChange>
          <PromoChange xsi:nil="true"/>
          <Usage xsi:nil="true"/>
          <SMSDelivery xsi:nil="true"/>
          <PRLInformation xsi:nil="true"/>
          <DeviceSuspendStatus xsi:nil="true"/>
          <Fault xsi:nil="true"/>
          <Comment>SUCCESS</Comment>
        </Data>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>

Restore

The following is an example message that the ExternalProvisioningChanges callback service sends when a system other than the Wireless Network Services ChangeDeviceState API restores a line of service for a device whose service was suspended.

<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>0aafcb4a-91fe-46b0-9154-f84f410f0f49</RequestId>
      <Device>
        <Kind>meid</Kind>
        <Identifier>A2000009D6BFE1</Identifier>
      </Device>
      <Data>
        <Data>
          <CarrierService xsi:nil="true"/>
          <ExternalProvisioningChange>
            <Source/>
            <Change>RESTORE</Change>
            <DeviceInfo>
              <AccountName>Verizon Test 1</AccountName>
              <CarrierInformation>
                <CarrierName>Verizon Wireless</CarrierName>
                <ServicePlan>M2M</ServicePlan>
                <State>active</State>
              </CarrierInformation>
              <DeviceGroupName>Default: Verizon Test 1</DeviceGroupName>
              <DeviceIdentifiers>
                <Kind>mdn</Kind>
                <Identifier>3701882174</Identifier>
              </DeviceIdentifiers>
              <DeviceIdentifiers>
                <Kind>meid</Kind>
                <Identifier>A2000009D6BFE1</Identifier>
              </DeviceIdentifiers>
              <CreatedAt>2013-05-20T21:06:35.0000000Z</CreatedAt>
              <IPAddress xsi:nil="true"/>
              <LastActivationDate>2013-05-20T21:15:00.0000000Z</LastActivationDate>
              <LastActivationBy>rajupreprov rajupreprov</LastActivationBy>
              <BillingCycleEndDate>2013-07-01T00:00:00.0000000Z</BillingCycleEndDate>
              <Connected>false</Connected>
              <LastConnectionDate xsi:nil="true"/>
            </DeviceInfo>
          </ExternalProvisioningChange>
          <PromoChange xsi:nil="true"/>
          <Usage xsi:nil="true"/>
          <SMSDelivery xsi:nil="true"/>
          <PRLInformation xsi:nil="true"/>
          <DeviceSuspendStatus xsi:nil="true"/>
          <Fault xsi:nil="true"/>
          <Comment>SUCCESS</Comment>
        </Data>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>

Change MDN

The following is an example message that the ExternalProvisioningChanges callback service sends when a system other than the Wireless Network Services ChangeDeviceIdentifer API changes a mobile device number for an M2M device.

<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>0aafcb4a-91fe-46b0-9154-f84f410f0f49</RequestId>
      <Device>
        <Kind>mdn</Kind>
        <Identifier>8594891547</Identifier>
      </Device>
      <Data>
        <Data>
          <CarrierService xsi:nil="true"/>
          <ExternalProvisioningChange>
            <Source/>
            <Change>ChangeMDN</Change>
            <DeviceInfo>
              <AccountName>Verizon Test 1</AccountName>
              <CarrierInformation>
                <CarrierName>Verizon Wireless</CarrierName>
                <ServicePlan>74200</ServicePlan>
                <State>active</State>
              </CarrierInformation>
              <DeviceGroupName>Default: Verizon Test 1</DeviceGroupName>
              <DeviceIdentifiers>
                <Kind>esn</Kind>
                <Identifier>09400122453</Identifier>
              </DeviceIdentifiers>
              <DeviceIdentifiers>
                <Kind>mdn</Kind>
                <Identifier>8594891547</Identifier>
              </DeviceIdentifiers>
              <CreatedAt>2011-02-28T16:23:47.0000000Z</CreatedAt>
              <IPAddress>1.1.30.118</IPAddress>
              <LastActivationDate>2013-05-17T02:53:01.0000000Z</LastActivationDate>
              <LastActivationBy>rajupreprov rajupreprov</LastActivationBy>
              <BillingCycleEndDate>2013-07-01T00:00:00.0000000Z</BillingCycleEndDate>
              <Connected>false</Connected>
              <LastConnectionDate xsi:nil="true"/>
              <CustomFields>
                <Name>CustomField1</Name>
                <Value/>
              </CustomFields>
              <CustomFields>
                <Name>CustomField2</Name>
                <Value/>
              </CustomFields>
              <CustomFields>
                <Name>CustomField3</Name>
                <Value/>
              </CustomFields>
              <CustomFields>
                <Name>CustomField4</Name>
                <Value/>
              </CustomFields>
              <CustomFields>
                <Name>CustomField5</Name>
                <Value/>
              </CustomFields>
            </DeviceInfo>
          </ExternalProvisioningChange>
          <PromoChange xsi:nil="true"/>
          <Usage xsi:nil="true"/>
          <SMSDelivery xsi:nil="true"/>
          <PRLInformation xsi:nil="true"/>
          <DeviceSuspendStatus xsi:nil="true"/>
          <Fault xsi:nil="true"/>
          <Comment>SUCCESS</Comment>
        </Data>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>