PromoChange Callback

The M2M Platform sends messages when there are changes to the promotional codes for a line of service, such as when a promotional code expires. The Platform will send a PromoChange callback message shortly after the end of a device's billing cycle if a promotional package was removed during the billing cycle.

NOTE: You can use the GetDeviceInformation API to see all active promotional codes for a device and the scheduled end date for each one.

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 affected by the promotional code change.
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.
PromoChange PromoChange Information about the promotion that was removed.
Change string The promotional code that was removed.
ChangeDate string The date that the promotional code was removed.

Sample SOAP Callback Message

<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/>
      <Device>
        <Kind>Mdn</Kind>
        <Identifier>3124705797</Identifier>
      </Device>
      <Data>
        <CarrierService xsi:nil="true"/>
        <ExternalProvisioningChange xsi:nil="true"/>
        <PromoChange xmlns="">
          <Change xmlns="http://nphase.com/unifiedwebservice/v2">PromoCode Dropped.</Change>
          <ChangeDate xmlns="http://nphase.com/unifiedwebservice/v2">4/1/2017 12:00:00 AM</ChangeDate>
        </PromoChange>
        <Usage xsi:nil="true"/>
        <SMSDelivery xsi:nil="true"/>
        <PRLInformation xsi:nil="true"/>
        <DeviceSuspendStatus xsi:nil="true"/>
        <Fault xsi:nil="true"/>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>