Delete multicast group

Deletes a multicast group. The group is looked up by multicast_eui, by multicast_addr or by both fields at once — then both must match. After deletion the group EUI and address are free: they can be given to a new group or device.

Request and response: delete_multicast_req → delete_multicast_resp.
Access: high access level token only; groups of all applications of the token owner are available. With a low access level token the server responds with error 1.

Warning

Always specify multicast_eui or multicast_addr. The server does not check that an identifier is given: a request with neither field deletes all multicast groups of the token owner.

Request

Fields not marked as required may be omitted.

Field	Type	Description
cmd	string	delete_multicast_req
operation_id	string	Any string; the server returns it in the response to match the request and the response
multicast_eui	string	multicast_eui or multicast_addr is required. Group EUI, 16 hex characters
multicast_addr	string	multicast_eui or multicast_addr is required. Group address, 8 hex characters

{
    "cmd": "delete_multicast_req",
    "operation_id": "xyw",
    "multicast_eui": "7DA50BE8C74CE6DC"
}

Response

Field	Type	Description
cmd	string	delete_multicast_resp
operation_id	string	Value from the request. Absent in responses with errors 1 and 3
status	uint8	1 — the group is deleted, 2 — error
multicast_eui, multicast_addr	string	EUI and address of the deleted group
error_code, error_text	uint8, string	Only on error, see below

{
    "cmd": "delete_multicast_resp",
    "operation_id": "xyw",
    "status": 1,
    "multicast_eui": "7DA50BE8C74CE6DC",
    "multicast_addr": "C74CE6DC"
}

Errors

error_code	error_text	What happened
1	Unauthorized access	The request came with a low access level token
3	—	multicast_eui is not 16 hex characters or multicast_addr is not 8
9	Multicast does not exists	The token owner has no group with such multicast_eui and multicast_addr
0	Unexpected error	Internal server error — retry later

Good to know

• A group cannot be restored. There is no restore command. A group with the same EUI and address can be created again, but its frame counter starts from zero: devices that remember the previous counter may drop the frames of the new group.
• Devices do not learn about the deletion. The server sends them nothing: the group address and keys stay in the devices until you remove them yourself.

See also

• Multicast groups — what a group is and in which order to call the commands.
• create_multicast_req — create a group.