GoToStateRequest
Changes the provisioning state of one or more devices to a specified customer-defined service and state.
GoToStateRequest
Changes the provisioning state of one or more devices to a specified customer-defined service and state.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
serviceName | string | Yes | The name of a customer-defined service to push the devices to. |
stateName | string | Yes | The name of a customer-defined stage state to push the devices to. |
servicePlan | string | Yes | The service plan code that you want to assign to all specified devices in the new state. |
mdnZipCode | string | Yes | The Zip code of the location where the line of service will primarily be used, or a Zip code that you have been told to use with these devices. For accounts that are configured for geographic numbering, this is the ZIP code from which the MDN will be derived. |
devices | array | No | Up to 10,000 devices that you want to push to a different state, specified by device identifier. |
filter | object | No | Specify the kind of the device identifier, the type of match, and the string that you want to match. |
carrierIpPoolName | string | No | The pool from which your device IP addresses will be derived if the service or state change requires new IP addresses.If you do not include this element, the default pool will be used. |
publicIpRestriction | string | No | For devices with static IP addresses on the public network, this specifies whether the devices have general access to the Internet. Valid values are “restricted” or “unrestricted”. |
skuNumber | string | No | The Stock Keeping Unit (SKU) number of a 4G device type with an embedded SIM. Can be used with ICCID or EID device identifiers in lieu of an IMEI when activating 4G devices. The SkuNumber will be used with all devices in the request, so all devices must be of the same type. |
customFields | array | No | The names and values of any custom fields that you want to set for the devices. |
devicesWithServiceAddress | array | No | This is an array that associates an IP address with a device identifier. This variable is only relevant for Business Internet/Fixed Wireless Access |
ipAddress | string | No | The IP address of the device. |
groupName | string | No | The name of a device group that the devices should be added to. |
primaryPlaceOfUse | object | No | The customer name and the address of the device's primary place of use. Leave these fields empty to use the account profile address as the primary place of use. These values will be applied to all devices in the request.If the account is enabled for non-geographic MDNs and the device supports it, the primaryPlaceOfUse address will also be used to derive the MDN for the device. |