Quick Task to API Lookup

What do you want to do?

Add devices to your account
To... Use this API
Add new devices to your account and activate service for them ChangeDeviceState - Activate
Add new (never activated) devices to your ThingSpace Platform account without activating service AddDevices
Change service provisioning
To... Use this API
Activate service for deactive devices

ChangeDeviceState - Activate

See also: M2M Service Provisioning Rules.

Suspend service

ChangeDeviceState - Suspend

See also: M2M Service Provisioning Rules.

Restore service on suspended devices

ChangeDeviceState - Restore

See also: M2M Service Provisioning Rules.

Deactivate devices

ChangeDeviceState - Deactivate

See also: M2M Service Provisioning Rules.

Put devices into a customer-defined staging state GoToState
Get confirmation of state changes RegisterCallback
Monitor provisioning changes
To... Use this API
Get the current provisioning state (Active, Deactive, Suspend)

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the date-time a device was activated

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the provisioning history for a device GetDeviceProvisioningHistory
Get confirmation of state changes you requested using an API RegisterCallback
Track provisioning changes made from outside the API, for example using a Verizon online business portal

RegisterCallback

See ExternalProvisioningChanges Callback.

Update Custom Field Values
To... Use this API
Change the values of custom fields for devices ChangeDeviceCustomFields
Change or Remove Cost Center Codes
To... Use this API
Change the cost center code for devices ChangeDeviceCostCenter
Change the service plan
To... Use this API
Change the service plan for devices

ChangeDeviceServicePlan

See also: M2M Service Provisioning Rules.

Move devices between accounts
To... Use this API
Remove devices from an account
  1. Deactivate the devices using ChangeDeviceState - Deactivate.
  2. Call Customer Service to remove the devices from the account.
See also: M2M Service Provisioning Rules.

Move devices from one account to another within the same Verizon Customer Profile

Use MoveDevice to move active devices.

If your account is not enabled for moving devices, you can:

  1. Deactivate the devices in the current account using ChangeDeviceState - Deactivate.
  2. After the deactivation is complete, activate the devices in another account using ChangeDeviceState - Activate.

See also: M2M Service Provisioning Rules.

Move devices from a trial account to a production account
  1. Deactivate the devices in the trial account using ChangeDeviceState - Deactivate.
  2. After the deactivations are complete, call Customer Service to remove the deactive devices from the trial account.
  3. Activate the devices on your production account using ChangeDeviceState - Activate.

See also: M2M Service Provisioning Rules.

Swap hardware
To... Use this API
Swap a 3G device
  1. Turn off the device.
  2. Turn on the replacement device. Note that the new device cannot already be in the Active or Suspend State. If it is in the Deactive state, call Customer Service to have it deleted from your account before initiating the swap.
  3. Use ChangeDeviceIdentifier to change the ESN or MEID.
Move an Active SIM into a new 4G M2M device Move the SIM to the new hardware and connect the device on the network. The ThingSpace Platform will recognize the hardware change when the device connects. See also: M2M Service Provisioning Rules.

Install a new SIM into an existing 4G device Follow the steps to put a new SIM in an existing 4G device , and use the Change4GDeviceIdentifier API to set the new ICCID.
Use an existing SIM in a new 4G device Follow steps to replace a 4G Device and use the current SIM, and use the Change4GDeviceIdentifier API to set the new IMEI.
Replace a 4G device and SIM Follow the steps to replace a 4G Device and SIM , and use the Change4GDeviceIdentifier API to set the new ICCID and IMEI.
Replace a 3G device with a 4G device Follow the steps to replace a 3G device with a 4G device , and use the Change4GDeviceIdentifier API to change the device identifiers and service plan.
Replace a 4G device with a 3G device Follow the steps to replace a 4G device with a 3G device , and use the Change4GDeviceIdentifier API to change the device identifiers and service plan.

Other hardware or SIM swaps

See M2M Service Provisioning Rules.

Change the "phone number"
To... Use this API
Change the Mobile Directory Number (MDN) of a 3G device ChangeDeviceIdentifier
Change the Mobile Station International Subscriber Directory Number (MSISDN) of a 4G device

Call Customer Service at 800-922-0204.

See also: M2M Service Provisioning Rules.

Get device information
To... Use this API
Get a list of my devices GetDeviceList
Get the service plan

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the IP address

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the custom field values

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the current provisioning state (Active, Deactive, Suspend)

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the status of suspended devices (such as how long they can stay suspended) GetDeviceSuspensionStatus
Get the provisioning history for a device GetDeviceProvisioningHistory
Get the current connectivity status (connected or not connected)

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the date-time a device last connected

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the connection history for a device GetDeviceConnectionHistory
Get the date-time a device was added to the ThingSpace Platform database

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the date-time a device was activated

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the billing cycle end date

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the rated usage for the current billing cycle GetRatedDeviceUsage
Get the usage history for a device GetDeviceUsageHistory
Get the AAA attributes

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the Preferred Roaming List (PRL) for a device GetDevicePRLInformation
Get device diagnostic information
To... Use this API
Get basic diagnostic information for a device GetDeviceDiagnosticsInformation
Track devices by group or properties
To... Use this API
Assign custom tracking properties, such as name, department, purpose, SKU, etc. ChangeDeviceCustomFields
Get a list of devices with specific custom properties GetDeviceList Note: You can use custom fields as filters in any API method that operates on device lists.
Create device groups CreateDeviceGroup
Delete device groups DeleteDeviceGroup
Assign devices to a group UpdateDeviceGroup
Remove devices from a group UpdateDeviceGroup
Get a list of devices in a group

GetDeviceGroupInformation for a list of devices in a group you have created.

GetDefaultDeviceGroupInformation for a list of devices in the default group.

Get a list of device groups in an account GetDeviceGroupList
Monitor connectivity and usage
To... Use this API
Get the current connectivity status (connected or not connected)

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the date-time a device last connected

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the connection history for a single device GetDeviceConnectionHistory
Get the billing cycle end date

GetDeviceInformation for a single device.

GetDeviceList for multiple devices.

Get the rated usage for the current billing cycle GetRatedDeviceUsage
Get the usage history for a device GetDeviceUsageHistory
Send and receive SMS messages
To... Use this API
Send SMS messages to devices SendSmsMessage
Retrieve SMS messages

GetSmsMessages

StartSmsCallback

Start and stop web service sessions
To... Use this API
Start a session LogIn
End a session LogOut
Manage web service responses
Something else?
To... Use this API
Upgrade your application from Generation 1 to Generation 2 API See [[FAQ:Wireless_Network_Services_Generation_2_FAQ.html">Generation 2 FAQ and Migrating from Generation 1 to Generation 2 APIs.

Couldn't find the task you were looking for? Please consult the M2M Developer Community [[Forum. Also feel free to [mailto:m2mdeveloper@verizon.com email us] your suggestions!