DevicesId
Table of Contents
- callbacksNotDelivered() : PaginateResponse<DeviceErrorMessages, DevicesIdCallbacksNotDeliveredResponse>
- Retrieve a list of undelivered callbacks and errors for a given device, in reverse chronological order (most recent message first). SNR will be deprecated (see [Newsletter](https://backend.sigfox.com/welcome/news) for details). To monitor radio link quality, please use the [Link Quality Indicator (LQI)](https://support.sigfox.com/docs/link-quality:-general-knowledge) which is more relevant than SNR in Sigfox network.
- certificate() : DevicesIdCertificate
- consumption() : DevicesIdConsumption
- delete() : void
- Delete a given device.
- disengage() : void
- Disable sequence number check for the next message.
- get() : Device
- Retrieve information about a given device.
- locations() : PaginateResponse<DeviceLocation_2, DevicesIdLocationsResponse>
- Retrieve a list of location data of a device according to request filters.
- messages() : DevicesIdMessages
- productCertificate() : ProductCertificateWithPacResponse
- Retrieve the product certificate associated with a given device ID and PAC, when the device has not already been created on the portal, only in CRA
- unsubscribe() : void
- Set an unsubscription date for the device's token.
- update() : void
- Update a given device.
Methods
callbacksNotDelivered()
Retrieve a list of undelivered callbacks and errors for a given device, in reverse chronological order (most recent message first). SNR will be deprecated (see [Newsletter](https://backend.sigfox.com/welcome/news) for details). To monitor radio link quality, please use the [Link Quality Indicator (LQI)](https://support.sigfox.com/docs/link-quality:-general-knowledge) which is more relevant than SNR in Sigfox network.
public
callbacksNotDelivered([DevicesIdCallbacksNotDelivered|array<string|int, mixed>|null $request = null ]) : PaginateResponse<DeviceErrorMessages, DevicesIdCallbacksNotDeliveredResponse>
Parameters
- $request : DevicesIdCallbacksNotDelivered|array<string|int, mixed>|null = null
-
The query and body parameters to pass
Tags
Return values
PaginateResponse<DeviceErrorMessages, DevicesIdCallbacksNotDeliveredResponse> —First generic parameter is the item type and the second type is the original response type.
certificate()
public
certificate() : DevicesIdCertificate
Return values
DevicesIdCertificate —consumption()
public
consumption() : DevicesIdConsumption
Return values
DevicesIdConsumption —delete()
Delete a given device.
public
delete() : void
Tags
Return values
void —disengage()
Disable sequence number check for the next message.
public
disengage() : void
Tags
Return values
void —get()
Retrieve information about a given device.
public
get([DevicesIdGet|array<string|int, mixed>|null $request = null ]) : Device
Parameters
- $request : DevicesIdGet|array<string|int, mixed>|null = null
-
The query and body parameters to pass
Tags
Return values
Device —locations()
Retrieve a list of location data of a device according to request filters.
public
locations([DevicesIdLocations|array<string|int, mixed>|null $request = null ]) : PaginateResponse<DeviceLocation_2, DevicesIdLocationsResponse>
Parameters
- $request : DevicesIdLocations|array<string|int, mixed>|null = null
-
The query and body parameters to pass
Tags
Return values
PaginateResponse<DeviceLocation_2, DevicesIdLocationsResponse> —First generic parameter is the item type and the second type is the original response type.
messages()
public
messages() : DevicesIdMessages
Return values
DevicesIdMessages —productCertificate()
Retrieve the product certificate associated with a given device ID and PAC, when the device has not already been created on the portal, only in CRA
public
productCertificate(string|null $pac) : ProductCertificateWithPacResponse
Parameters
- $pac : string|null
-
The device's PAC (hexadecimal format)
Tags
Return values
ProductCertificateWithPacResponse —unsubscribe()
Set an unsubscription date for the device's token.
public
unsubscribe(TokenUnsubscribe|array<string|int, mixed>|null $unsubscriptionTime) : void
Parameters
- $unsubscriptionTime : TokenUnsubscribe|array<string|int, mixed>|null
-
the unsubscription time (in milliseconds since the Unix Epoch)
Tags
Return values
void —update()
Update a given device.
public
update(DeviceUpdateJob|array<string|int, mixed>|null $device) : void
Parameters
- $device : DeviceUpdateJob|array<string|int, mixed>|null
-
The device to update