vértice
Produto Preços Painel
Canais

Canais

Canais (newsletters): criação, metadados, seguir, mutar, mensagens, seguidores e administração.

Referência

18 endpoints

GET /instances/:id/newsletters →

Listar canais

Listagem de todos os canais não é exposta pelo protocolo.

API key · Escopo read
GET /instances/:id/newsletters/search →

Buscar canais

Buscar canais (não suportado).

API key · Escopo read
GET /instances/:id/newsletters/invite/:code →

Metadados de canal por convite

Metadados de canal por convite.

API key · Escopo read
POST /instances/:id/newsletters →

Criar canal

Cria um canal (newsletter).

API key · Escopo write
GET /instances/:id/newsletters/:jid →

Metadados do canal

Retorna metadados do canal por JID.

API key · Escopo read
PATCH /instances/:id/newsletters/:jid →

Atualizar nome/descrição do canal

Atualiza nome e descrição do canal.

API key · Escopo write
PUT /instances/:id/newsletters/:jid/picture →

Atualizar foto do canal

Atualiza a foto do canal.

API key · Escopo write
DELETE /instances/:id/newsletters/:jid/picture →

Remover foto do canal

Remove foto do canal.

API key · Escopo write
POST /instances/:id/newsletters/:jid/follow →

Segue canal

Segue o canal.

API key · Escopo write
POST /instances/:id/newsletters/:jid/unfollow →

Deixa de seguir canal

Deixa de seguir o canal.

API key · Escopo write
POST /instances/:id/newsletters/:jid/mute →

Muta canal

Muta notificações do canal.

API key · Escopo write
POST /instances/:id/newsletters/:jid/unmute →

Desmuta canal

Desmuta canal.

API key · Escopo write
GET /instances/:id/newsletters/:jid/subscribers →

Contagem de seguidores/admins

Retorna contagem de seguidores e administradores.

API key · Escopo read
GET /instances/:id/newsletters/:jid/messages →

Mensagens do canal

Lista mensagens recentes do canal.

API key · Escopo read
POST /instances/:id/newsletters/:jid/react →

Reagir a mensagem do canal

Reage a uma mensagem do canal.

API key · Escopo write
POST /instances/:id/newsletters/:jid/transfer →

Transfere propriedade do canal

Transfere a propriedade do canal.

API key · Escopo write
POST /instances/:id/newsletters/:jid/admins/:userJid/demote →

Remover admin do canal

Remove admin do canal.

API key · Escopo write
DELETE /instances/:id/newsletters/:jid →

Deleta canal

Deleta o canal.

API key · Escopo write