Documentation New Spark Media Platform Developer Documentation Portal

API Reference

Getting Started
Methods +

Use channels like folders to organize media. These methods allow you create and display New Spark Media Platform channels in your app.

Channels.deleteChannel

Use this method to delete a channel from your vhost.

Channels.getChannelInfo

Returns information about a specific channel.

The ID argument can be specified by the channel ID or the channel shortname. If the channel shortname is used the vhost argument is required.

Channels.getChannels

Returns the list of channels for the specified vhost.

Channels.newChannel

This method creates a new channel. On success the new channel ID will be returned to you.

The shortname will show up in many places, such as the email address for incoming media, and in some cases, URLs. It is highly recommended to pick a shortname that is lowercase and alphanumeric .