切换深色模式
组播 API
本页列出当前版本的完整方法及字段。方法通过 gRPC / gRPC-Web 调用；REST 注解不表示已部署 REST Gateway。
“必填：按业务校验”表示 proto3 未声明 required，不代表留空一定可用。UUID、EUI、权限、资源存在性与字段组合由服务端校验。嵌套结构详见页末消息结构。
MulticastGroupService
Create
接口名称： api.MulticastGroupService/Create
功能： 创建 对应资源。Create the given multicast group.
请求： api.CreateMulticastGroupRequest；返回： api.CreateMulticastGroupResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group | api.MulticastGroup | 按业务校验 | 组播组对象。 Multicast group to create. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID of created multicast group (UUID). |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
Get
接口名称： api.MulticastGroupService/Get
功能： 查询 对应资源。Get returns the multicast group for the given ID.
请求： api.GetMulticastGroupRequest；返回： api.GetMulticastGroupResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 Multicast group ID. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group | api.MulticastGroup | 按业务校验 | 组播组对象。 Multicast group object. |
created_at | google.protobuf.Timestamp | 按业务校验 | 创建时间。 Created at timestamp. |
updated_at | google.protobuf.Timestamp | 按业务校验 | 最后更新时间。 Last update timestamp. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
Update
接口名称： api.MulticastGroupService/Update
功能： 更新 对应资源。Update the given multicast group.
请求： api.UpdateMulticastGroupRequest；返回： google.protobuf.Empty（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group | api.MulticastGroup | 按业务校验 | 组播组对象。 Multicast group object to update. |
返回值
无字段。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
Delete
接口名称： api.MulticastGroupService/Delete
功能： 删除 对应资源。Delete the multicast-group with the given ID.
请求： api.DeleteMulticastGroupRequest；返回： google.protobuf.Empty（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 Multicast group iD. |
返回值
无字段。
操作影响
此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
List
接口名称： api.MulticastGroupService/List
功能： 列出 对应资源。List the available multicast groups.
请求： api.ListMulticastGroupsRequest；返回： api.ListMulticastGroupsResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 Max number of multicast groups to return in the result-set. If not set, it will be treated as 0, and the response will only return the total_count. |
offset | uint32 | 按业务校验 | 分页起始偏移。 Offset in the result-set (for pagination). |
search | string | 按业务校验 | 搜索关键字。 If set, the given string will be used to search on name. |
application_id | string | 按业务校验 | 应用 UUID。 Application ID to list the multicast groups for. This is mandatory unless tenant_id is set. |
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (optional, HEX encoded EUI64). |
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID to list the multicast groups for. This is mandatory unless application_id is set. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
total_count | uint32 | 按业务校验 | 符合条件的总条数。 Total number of multicast groups. |
result | repeated api.MulticastGroupListItem | 按业务校验 | 结果列表或结果内容。 Result-test. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
AddDevice
接口名称： api.MulticastGroupService/AddDevice
功能： 添加组播终端成员。Add a device to the multicast group.
请求： api.AddDeviceToMulticastGroupRequest；返回： google.protobuf.Empty（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (HEX encoded). |
返回值
无字段。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
RemoveDevice
接口名称： api.MulticastGroupService/RemoveDevice
功能： 移除组播终端成员。Remove a device from the multicast group.
请求： api.RemoveDeviceFromMulticastGroupRequest；返回： google.protobuf.Empty（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (HEX encoded). |
返回值
无字段。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
AddGateway
接口名称： api.MulticastGroupService/AddGateway
功能： 添加组播发射网关。Add a gateway to the multicast group.
请求： api.AddGatewayToMulticastGroupRequest；返回： google.protobuf.Empty（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
gateway_id | string | 按业务校验 | 网关 EUI。 Gateway ID (HEX encoded). |
返回值
无字段。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
RemoveGateway
接口名称： api.MulticastGroupService/RemoveGateway
功能： 移除组播发射网关。Remove a gateway from the multicast group.
请求： api.RemoveGatewayFromMulticastGroupRequest；返回： google.protobuf.Empty（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
gateway_id | string | 按业务校验 | 网关 EUI。 Gateway ID (HEX encoded). |
返回值
无字段。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
Enqueue
接口名称： api.MulticastGroupService/Enqueue
功能： 将下行加入队列。Add the given item to the multicast group queue.
请求： api.EnqueueMulticastGroupQueueItemRequest；返回： api.EnqueueMulticastGroupQueueItemResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
queue_item | api.MulticastGroupQueueItem | 按业务校验 | 待加入的下行条目。 Multicast queue-item to enqueue. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
f_cnt | uint32 | 按业务校验 | 帧计数。 Frame-counter of the enqueued payload. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
FlushQueue
接口名称： api.MulticastGroupService/FlushQueue
功能： 清空待发队列。Flush the queue for the given multicast group.
请求： api.FlushMulticastGroupQueueRequest；返回： google.protobuf.Empty（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
返回值
无字段。
操作影响
此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ListQueue
接口名称： api.MulticastGroupService/ListQueue
功能： 列出组播下行队列。List the items in the multicast group queue.
请求： api.ListMulticastGroupQueueRequest；返回： api.ListMulticastGroupQueueResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
items | repeated api.MulticastGroupQueueItem | 按业务校验 | 消息定义未补充字段说明。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
嵌套消息结构
api.AddDeviceToMulticastGroupRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (HEX encoded). |
api.AddGatewayToMulticastGroupRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
gateway_id | string | 按业务校验 | 网关 EUI。 Gateway ID (HEX encoded). |
api.CreateMulticastGroupRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group | api.MulticastGroup | 按业务校验 | 组播组对象。 Multicast group to create. |
api.CreateMulticastGroupResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID of created multicast group (UUID). |
api.DeleteMulticastGroupRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 Multicast group iD. |
api.EnqueueMulticastGroupQueueItemRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
queue_item | api.MulticastGroupQueueItem | 按业务校验 | 待加入的下行条目。 Multicast queue-item to enqueue. |
api.EnqueueMulticastGroupQueueItemResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
f_cnt | uint32 | 按业务校验 | 帧计数。 Frame-counter of the enqueued payload. |
api.FlushMulticastGroupQueueRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
api.GetMulticastGroupRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 Multicast group ID. |
api.GetMulticastGroupResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group | api.MulticastGroup | 按业务校验 | 组播组对象。 Multicast group object. |
created_at | google.protobuf.Timestamp | 按业务校验 | 创建时间。 Created at timestamp. |
updated_at | google.protobuf.Timestamp | 按业务校验 | 最后更新时间。 Last update timestamp. |
api.ListMulticastGroupQueueRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
api.ListMulticastGroupQueueResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
items | repeated api.MulticastGroupQueueItem | 按业务校验 | 消息定义未补充字段说明。 |
api.ListMulticastGroupsRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 Max number of multicast groups to return in the result-set. If not set, it will be treated as 0, and the response will only return the total_count. |
offset | uint32 | 按业务校验 | 分页起始偏移。 Offset in the result-set (for pagination). |
search | string | 按业务校验 | 搜索关键字。 If set, the given string will be used to search on name. |
application_id | string | 按业务校验 | 应用 UUID。 Application ID to list the multicast groups for. This is mandatory unless tenant_id is set. |
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (optional, HEX encoded EUI64). |
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID to list the multicast groups for. This is mandatory unless application_id is set. |
api.ListMulticastGroupsResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
total_count | uint32 | 按业务校验 | 符合条件的总条数。 Total number of multicast groups. |
result | repeated api.MulticastGroupListItem | 按业务校验 | 结果列表或结果内容。 Result-test. |
api.MulticastGroup
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID (UUID). This will be generated automatically on create. |
name | string | 按业务校验 | 名称。 Name. |
application_id | string | 按业务校验 | 应用 UUID。 Application ID. After creation, this can not be updated. |
region | common.Region {EU868=0, US915=2, CN779=3, EU433=4, AU915=5, CN470=6, AS923=7, AS923_2=12, AS923_3=13, AS923_4=14, KR920=8, IN865=9, RU864=10, ISM2400=11} | 按业务校验 | 区域枚举。 Region. |
mc_addr | string | 按业务校验 | 组播地址。 Multicast address (HEX encoded DevAddr). |
mc_nwk_s_key | string | 按业务校验 | 组播网络会话密钥。 Multicast network session key (HEX encoded AES128 key). |
mc_app_s_key | string | 按业务校验 | 组播应用会话密钥。 Multicast application session key (HEX encoded AES128 key). |
f_cnt | uint32 | 按业务校验 | 帧计数。 Frame-counter. |
group_type | api.MulticastGroupType {CLASS_C=0, CLASS_B=1} | 按业务校验 | 组播类型。 Multicast group type. |
dr | uint32 | 按业务校验 | 数据率索引。 Data-rate. |
frequency | uint32 | 按业务校验 | 频率。 Frequency (Hz). |
class_b_ping_slot_periodicity | uint32 | 按业务校验 | Class-B ping-slot periodicity (only for Class-B). Valid options are: 0 - 7. Number of ping-slots per beacon-period: pingNb = 2^(7-periodicity) Periodicity: 0 = 128 ping-slots per beacon period = ~ every 1 sec Periodicity: 7 = 1 ping-slot per beacon period = ~ every 128 sec |
class_c_scheduling_type | api.MulticastGroupSchedulingType {DELAY=0, GPS_TIME=1} | 按业务校验 | Class C 调度类型。 Scheduling type (only for Class-C). |
api.MulticastGroupListItem
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 按业务校验 | 资源 ID。 ID. |
created_at | google.protobuf.Timestamp | 按业务校验 | 创建时间。 Created at timestamp. |
updated_at | google.protobuf.Timestamp | 按业务校验 | 最后更新时间。 Last update timestamp. |
name | string | 按业务校验 | 名称。 Name. |
region | common.Region {EU868=0, US915=2, CN779=3, EU433=4, AU915=5, CN470=6, AS923=7, AS923_2=12, AS923_3=13, AS923_4=14, KR920=8, IN865=9, RU864=10, ISM2400=11} | 按业务校验 | 区域枚举。 Region. |
group_type | api.MulticastGroupType {CLASS_C=0, CLASS_B=1} | 按业务校验 | 组播类型。 Multicast group type. |
application_id | string | 按业务校验 | 应用 UUID。 Application ID. |
application_name | string | 按业务校验 | Application name. |
api.MulticastGroupQueueItem
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
f_cnt | uint32 | 按业务校验 | 帧计数。 Downlink frame-counter. This will be automatically set on enqueue. |
f_port | uint32 | 按业务校验 | 应用端口。 FPort (must be > 0). |
data | bytes | 按业务校验 | 原始负载字节，JSON 中为 Base64。 Payload. |
expires_at | google.protobuf.Timestamp | 按业务校验 | 过期时间。 Expires at (optional). Expired queue-items will be automatically removed from the queue. |
api.RemoveDeviceFromMulticastGroupRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (HEX encoded). |
api.RemoveGatewayFromMulticastGroupRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group_id | string | 按业务校验 | 组播组 UUID。 Multicast group ID. |
gateway_id | string | 按业务校验 | 网关 EUI。 Gateway ID (HEX encoded). |
api.UpdateMulticastGroupRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
multicast_group | api.MulticastGroup | 按业务校验 | 组播组对象。 Multicast group object to update. |