Get metadata of a channel
643 matches
19 actions
Platform
19 actions
- Enumerate all active channels of the applicationGETv1.0.0
- Get a device registrationGETv1.0.0
- Get message history for a channelGETv1.0.0
- Get metadata of a channelGETv1.0.0
- Get presence history of a channelGETv1.0.0
- Get presence of a channelGETv1.0.0
- Get the service timeGETv1.0.0
- List all channels with at least one subscribed deviceGETv1.0.0
- List channel subscriptionsGETv1.0.0
- List devices registered for receiving push notificationsGETv1.0.0
- Publish a message to a channelPOSTv1.0.0
- Publish a push notification to device(s)POSTv1.0.0
- Register a device for receiving push notificationsPOSTv1.0.0
- Retrieve usage statistics for an applicationGETv1.0.0
- Subscribe a device to a channelPOSTv1.0.0
- Unregister a single device for push notificationsDELETEv1.0.0
- Unregister matching devices for push notificationsDELETEv1.0.0
- Update a device registrationPATCHv1.0.0
- Update a device registrationPUTv1.0.0
Infrastructure/Platform
Get metadata of a channel
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
{
"type": "object",
"properties": {
"channel_id": {
"type": "string"
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
{
"type": "object",
"required": [
"channelId"
],
"properties": {
"channelId": {
"type": "string",
"description": "The required name of the channel including any qualifier, if any."
},
"isGlobalMaster": {
"type": "boolean",
"description": "In events relating to the activity of a channel in a specific region, this optionally identifies whether or not that region is responsible for global coordination of the channel."
},
"region": {
"type": "string",
"description": "In events relating to the activity of a channel in a specific region, this optionally identifies the region."
},
"status": {
"type": "object",
"description": "A ChannelStatus instance.",
"required": [
"isActive"
],
"properties": {
"isActive": {
"type": "boolean",
"description": "A required boolean value indicating whether the channel that is the subject of the event is active. For events indicating regional activity of a channel this indicates activity in that region, not global activity."
},
"occupancy": {
"type": "object",
"description": "An Occupancy instance indicating the occupancy of a channel. For events indicating regional activity of a channel this indicates activity in that region, not global activity.",
"properties": {
"presenceConnections": {
"type": "integer",
"description": "The number of connections that are authorised to enter members into the presence channel."
},
"presenceMembers": {
"type": "integer",
"description": "The number of members currently entered into the presence channel."
},
"presenceSubscribers": {
"type": "integer",
"description": "The number of connections that are authorised to subscribe to presence messages."
},
"publishers": {
"type": "integer",
"description": "The number of connections attached to the channel that are authorised to publish."
},
"subscribers": {
"type": "integer",
"description": "The number of connections attached that are authorised to subscribe to messages."
}
}
}
}
}
}
}