PHP Sigfox Client

DevicesIdMessages

Table of Contents

list()  : PaginateResponse<DeviceMessage, DevicesIdMessagesListResponse>
Retrieve a list of messages for a given device according to request filters. 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.
metric()  : DevicesIdMessagesMetricResponse
Return the number of messages for a given device, for the last day, last week and last month.

Methods

list()

Retrieve a list of messages for a given device according to request filters. 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 list([DevicesIdMessagesList|array<string|int, mixed>|null $request = null ]) : PaginateResponse<DeviceMessage, DevicesIdMessagesListResponse>
Parameters
$request : DevicesIdMessagesList|array<string|int, mixed>|null = null

The query and body parameters to pass

Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
NotFoundException

If server returned a HTTP 404 error.

throws
PreconditionFailedException

If server returned a HTTP 412 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
PaginateResponse<DeviceMessage, DevicesIdMessagesListResponse>

First generic parameter is the item type and the second type is the original response type.

metric()

Return the number of messages for a given device, for the last day, last week and last month.

public metric() : DevicesIdMessagesMetricResponse
Tags
throws
SerializeException

If request object failed to serialize to a JSON serializable type.

throws
UnexpectedResponseException

If server returned an unexpected status code.

throws
ResponseException

If server returned any expected HTTP error

throws
ValidationException

If request could not be validated according to pre validation rules.

throws
BadRequestException

If server returned a HTTP 400 error.

throws
UnauthorizedException

If server returned a HTTP 401 error.

throws
ForbiddenException

If server returned a HTTP 403 error.

throws
NotFoundException

If server returned a HTTP 404 error.

throws
InternalServerException

If server returned a HTTP 500 error.

throws
DeserializeException

If failed to deserialize response body as a response object.

Return values
DevicesIdMessagesMetricResponse

Search results