GroupsId
Table of Contents
- callbacksNotDelivered() : PaginateResponse<GroupErrorMessages, GroupsIdCallbacksNotDeliveredResponse>
- Retrieve a list of undelivered callbacks and errors for a given group, 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.
- delete() : void
- Delete a given group.
- geolocationPayloads() : PaginateResponse<BaseGeolocation, GroupsIdGeolocationPayloadsResponse>
- Retrieve a list of geolocation payload according to request filters.
- get() : Group
- Retrieve information about a given group.
- update() : void
- Update a given group.
Methods
callbacksNotDelivered()
Retrieve a list of undelivered callbacks and errors for a given group, 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([GroupsIdCallbacksNotDelivered|array<string|int, mixed>|null $request = null ]) : PaginateResponse<GroupErrorMessages, GroupsIdCallbacksNotDeliveredResponse>
Parameters
- $request : GroupsIdCallbacksNotDelivered|array<string|int, mixed>|null = null
-
The query and body parameters to pass
Tags
Return values
PaginateResponse<GroupErrorMessages, GroupsIdCallbacksNotDeliveredResponse> —First generic parameter is the item type and the second type is the original response type.
delete()
Delete a given group.
public
delete() : void
Tags
Return values
void —geolocationPayloads()
Retrieve a list of geolocation payload according to request filters.
public
geolocationPayloads([GroupsIdGeolocationPayloads|array<string|int, mixed>|null $request = null ]) : PaginateResponse<BaseGeolocation, GroupsIdGeolocationPayloadsResponse>
Parameters
- $request : GroupsIdGeolocationPayloads|array<string|int, mixed>|null = null
-
The query and body parameters to pass
Tags
Return values
PaginateResponse<BaseGeolocation, GroupsIdGeolocationPayloadsResponse> —First generic parameter is the item type and the second type is the original response type.
get()
Retrieve information about a given group.
public
get([GroupsIdGet|array<string|int, mixed>|null $request = null ]) : Group
Parameters
- $request : GroupsIdGet|array<string|int, mixed>|null = null
-
The query and body parameters to pass
Tags
Return values
Group —update()
Update a given group.
public
update(CommonGroupUpdate|array<string|int, mixed>|null $group) : void
Parameters
- $group : CommonGroupUpdate|array<string|int, mixed>|null
-
The group to update