Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SendDataToMulticastGroup

Sends the specified data to a multicast group.

Request Syntax


POST /multicast-groups/Id/data HTTP/1.1
Content-type: application/json

{
   "PayloadData": "string",
   "WirelessMetadata": { 
      "LoRaWAN": { 
         "FPort": number
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

Id

The ID of the multicast group.

Length Constraints: Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

PayloadData

The binary to be sent to the end device, encoded in base64.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Required: Yes

WirelessMetadata

Wireless metadata that is to be sent to multicast group.

Type: MulticastWirelessMetadata object

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "MessageId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

MessageId

ID of a multicast group message.

Type: String

Length Constraints: Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

ConflictException

Adding, updating, or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400