V1::ChannelsController

Channels

index

View list of all channels

URL

GET /channels/ or /users/:user_id/channels/

Response Fields

Nome Tipo Descrição
channels Array<Channel>

List of channels

create

Create channel

URL

POST /channels

Parâmetros obrigatórios

Nome Tipo Descrição
channel Hash

The channel to create

channel[subject] String

Subject of the channel

channel[permission_key] String

PermissionKey of the channel

channel[user_ids] Array<Integer>

Ids of users members of the channel

Parâmetros opcionais

Nome Tipo Descrição
channel[created_at] DateTime

Creation date. Passing this attribute implies to not run object's callbacks

show

View a channel

URL

GET /channel/:id

Parâmetros obrigatórios

Nome Tipo Descrição
id Integer

Identifier the channel

Objeto resposta

Channel

The requested channel