Sinal Dinâmico (Pré-visualização)
A Dynamic Signal é uma Plataforma de Comunicação e Engajamento de Funcionários, na qual as organizações confiam para conectar, alinhar e engajar os funcionários. Conecte-se ao Dynamic Signal para criar e gerenciar suas postagens e usuários.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Metadados do conector | |
|---|---|
| Editora | Sinal dinâmico |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Token de Portador | securestring | O token do portador para esta api | Verdade |
| URL do sinal dinâmico | cadeia (de caracteres) | O URL onde acede ao Sinal Dinâmico. | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar uma imagem a uma publicação através do upload |
Define a imagem de postagem via upload binário. |
| Adicionar uma imagem a uma publicação através do URL |
Define a imagem da publicação através de um URL. |
| Atualizar uma publicação |
Edita uma postagem existente. |
| Carregar imagem |
Carrega uma imagem através de upload binário |
| Carregar um documento para uma publicação |
Carrega um documento para uma publicação através de carregamento binário |
| Criar uma publicação |
Cria uma publicação. |
| Gerir publicações |
Permite que chamadas autenticadas pelo servidor atualizem propriedades de várias postagens em uma única solicitação |
| Obter alvos |
Obtém uma lista de alvos da comunidade e definições de destino |
| Obter categorias |
Obtém uma lista de categorias visíveis para o usuário autenticado |
| Obter divisões |
Obtém a lista de divisões |
| Obter tags de publicação |
Obtém as tags de postagem definidas no sistema |
| Obter tags de usuário |
Obtém uma lista de tags de usuário definidas no sistema |
| Obter um usuário por e-mail |
Recupera um usuário por seu endereço de e-mail |
| Pré-registrar um usuário |
Cria um novo usuário no estado pré-registrado |
| Receba uma publicação |
Obtém uma publicação específica por ID |
Adicionar uma imagem a uma publicação através do upload
Define a imagem de postagem via upload binário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
O ID do post |
|
Ficheiro
|
File | True | binary |
Ficheiro a carregar |
|
Tipo de conteúdo, como image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Tipo de conteúdo do ficheiro carregado |
Devoluções
Uma resposta simples indicando que a ação foi executada com sucesso
- response
- successResponse
Adicionar uma imagem a uma publicação através do URL
Define a imagem da publicação através de um URL.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
O ID do post, obrigatório: true |
|
Endereço URL
|
url | True | string |
O URL HTTP ou HTTPS |
Devoluções
Uma resposta simples indicando que a ação foi executada com sucesso
- response
- successResponse
Atualizar uma publicação
Edita uma postagem existente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
O ID do post |
|
Title
|
title | string |
O título do post |
|
|
Description
|
description | string |
A breve descrição do post |
|
|
Linha de etiqueta
|
tagLine | string |
O slogan do post |
|
|
Content
|
content | string |
O corpo do post |
|
|
Comentários do criador
|
creatorComments | string |
Uma mensagem associada à publicação |
|
|
Perma Link
|
permaLink | string |
O URL externo referenciado pela publicação |
|
|
Discussões internas ativadas
|
internalDiscussionsEnabled | boolean |
Se os membros têm permissão para executar ações semelhantes e adicionar comentários em publicações internamente |
Devoluções
Um post
- response
- postResponse
Carregar imagem
Carrega uma imagem através de upload binário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Ficheiro
|
File | True | binary |
Ficheiro a carregar |
|
Tipo de conteúdo, como image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Tipo de conteúdo do ficheiro carregado |
Devoluções
- response
- uploadImageResponse
Carregar um documento para uma publicação
Carrega um documento para uma publicação através de carregamento binário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do arquivo
|
fileName | True | string |
Nome do ficheiro preferido do documento (com extensão) |
|
ID
|
id | True | uuid |
O ID do post |
|
Ficheiro
|
File | True | binary |
Ficheiro a carregar |
|
Tipo de conteúdo, como image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Tipo de conteúdo do ficheiro carregado |
Devoluções
Informações relevantes para um documento anexado
- response
- documentInfoResponse
Criar uma publicação
Cria uma publicação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Description
|
description | string |
A breve descrição do post |
|
|
Linha de etiqueta
|
tagLine | string |
O slogan do post |
|
|
Content
|
content | string |
O corpo do post |
|
|
Comentários do criador
|
creatorComments | string |
Uma mensagem associada à publicação |
|
|
Perma Link
|
permaLink | string |
O URL externo referenciado pela publicação |
|
|
Discussões internas ativadas
|
internalDiscussionsEnabled | boolean |
Se os membros têm permissão para executar ações semelhantes e adicionar comentários em publicações internamente |
|
|
Title
|
title | True | string |
O título do post |
|
URL do vídeo do membro
|
memberVideoUrl | string |
O URL do vídeo referenciado pela publicação |
|
|
Tipo de Post
|
postType | string |
O tipo básico do posto |
|
|
Estado de aprovação
|
approvalState | string |
O estado de aprovação do post. O padrão é a configuração Status da revisão do autor. |
|
|
Modo de Visualização
|
displayMode | string |
Indica o redirecionamento de uma postagem para um local interno ou externo |
|
|
Partilhável
|
sharable | boolean |
Se a plataforma e os widgets do VoiceStorm permitirão que a publicação seja compartilhada |
|
|
Data de início
|
startDate | date-time |
A data após a qual a postagem está disponível para visualização |
|
|
Data de fim
|
endDate | date-time |
A data após a qual a postagem não estará mais disponível para visualização |
|
|
Texto de Partilha Sugerido
|
suggestedShareText | string |
O texto de partilha sugerido para a publicação |
|
|
Breve Sugestão de Texto de Partilha
|
shortSuggestedShareText | string |
O texto de compartilhamento sugerido para a postagem para provedores de mensagens curtas |
|
|
Partilhar Pontos
|
sharePoints | integer |
O número de pontos atribuídos quando um utilizador partilha a publicação |
|
|
Clique em Pontos
|
clickPoints | integer |
O número de pontos atribuídos quando alguém clica num link partilhado para a publicação |
|
|
Partilhar com imagens
|
shareWithImages | boolean |
Controla se as publicações partilhadas em serviços de mensagens curtas (como o Twitter) têm imagens partilhadas |
|
|
Partilhar apenas imagens
|
shareImagesOnly | boolean |
Controla se as publicações partilhadas em determinados serviços são tratadas como atualizações apenas de imagens/fotografias |
|
|
Nome
|
name | string |
O nome da tag |
|
|
Linguagem
|
language | string |
O idioma do conteúdo da publicação |
|
|
Documents
|
documents | array of uuid |
Uma lista de documentos IDs para anexar a este post |
|
|
ID do criador
|
creatorId | integer |
O usuário que está criando a postagem; Esta propriedade só está disponível para solicitações autenticadas pelo servidor no momento. Todas as outras postagens são definidas automaticamente para o usuário autenticado. |
|
|
Criador da Rede de Display
|
displayCreator | boolean |
Controla se as informações do criador devem ser exibidas com a postagem ou não; Esta propriedade só está disponível para solicitações autenticadas pelo servidor no momento. |
|
|
IDs de categoria
|
categoryIds | array of integer |
Uma lista de IDs de categoria que foram atribuídos à postagem |
|
|
IDs de destino
|
targetIds | array of integer |
Uma lista de IDs de destino que foram atribuídos à postagem |
Devoluções
Um post
- response
- postResponse
Gerir publicações
Permite que chamadas autenticadas pelo servidor atualizem propriedades de várias postagens em uma única solicitação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
IDs de publicação
|
postIds | True | array of uuid |
Os lugares que estão a ser modificados |
|
Etiquetas
|
tags | array of string |
Uma coleção de nomes de tags que podem ser aplicados a postagens |
|
|
IDs de divisão
|
divisionIds | array of integer |
Os IDs de divisão a que pertencem os lugares |
|
|
IDs de categoria
|
categoryIds | array of integer |
Os ID da categoria a que pertencem os lugares |
|
|
IDs de destino
|
targetIds | array of integer |
Os IDs de destino aos quais as postagens pertencem |
|
|
Estado de aprovação
|
approvalState | string |
O estado de aprovação para as postagens (isso não é afetado pelas solicitações DELETE) |
Devoluções
Uma resposta simples indicando que a ação foi executada com sucesso
- response
- successResponse
Obter alvos
Obtém uma lista de alvos da comunidade e definições de destino
Devoluções
Uma lista de definições de alvos e metas associadas para a comunidade.
- response
- targetDefinitionsInfoResponse
Obter categorias
Obtém uma lista de categorias visíveis para o usuário autenticado
Devoluções
Informações pormenorizadas relacionadas com as categorias
- response
- categoriesResponse
Obter divisões
Obter tags de publicação
Obtém as tags de postagem definidas no sistema
Devoluções
Uma lista de tags de postagem definidas no sistema
- response
- managePostTagsResponse
Obter tags de usuário
Obtém uma lista de tags de usuário definidas no sistema
Devoluções
Uma lista de tags de usuário definidas no sistema
- response
- manageUserTagsResponse
Obter um usuário por e-mail
Recupera um usuário por seu endereço de e-mail
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Email
|
True | string |
O e-mail do usuário |
|
|
Incluir
|
include | array of string |
Especifica dados opcionais a serem retornados com o usuário. |
Devoluções
- response
- userRequestResponse
Pré-registrar um usuário
Cria um novo usuário no estado pré-registrado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Email
|
string |
O endereço de e-mail do usuário |
||
|
ID de usuário do Sso externo
|
externalSsoUserId | string |
O ID do usuário no sistema externo gerenciado pelo SSO Identity Provider |
|
|
Pega
|
handle | string |
O identificador do usuário |
|
|
Nome Próprio
|
firstName | string |
O primeiro nome do usuário. |
|
|
Apelido
|
lastName | string |
O sobrenome do usuário. |
|
|
IDs de divisão
|
divisionIds | array of integer |
Uma lista de divisões às quais o usuário será atribuído. |
|
|
IDs de destino
|
targetIds | array of integer |
Uma lista de destinos a atribuir ao utilizador. |
|
|
Nome
|
name | string |
O nome da tag ou atributo |
|
|
Valor
|
value | string |
O valor opcional |
|
|
Enviar e-mail de convite
|
sendInvitationEmail | boolean |
Determina se um email de convite deve ser enviado ao usuário. |
|
|
Mensagem de convite
|
invitationMessage | string |
Uma mensagem de texto simples opcional para incluir no e-mail de convite. |
|
|
Notificações padrão
|
notificationsDefault | string |
Configuração que controla quando os usuários começarão a receber notificações por e-mail. |
|
|
Pode compartilhar postagens
|
canSharePosts | boolean |
Indica se o usuário tem a capacidade de compartilhar postagens |
|
|
Pode comentar posts
|
canCommentPosts | boolean |
Indica se o usuário tem a capacidade de comentar e curtir postagens |
|
|
Pode Enviar Posts
|
canSubmitPosts | boolean |
Indica se o usuário tem a capacidade de enviar postagens |
|
|
Pode gerenciar a organização
|
canManageOrganization | boolean |
Indica se o usuário tem a capacidade de se comunicar com reportes diretos e indiretos dentro da comunidade |
Devoluções
- response
- userRequestResponse
Receba uma publicação
Obtém uma publicação específica por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
O post ID.; Este é o identificador exclusivo para a postagem. |
|
ID de utilizador
|
userId | integer |
O usuário que está visualizando a postagem. O usuário conectado será usado se nenhum ID for especificado |
Devoluções
Um post
- response
- postResponse
Definições
successResponse
Uma resposta simples indicando que a ação foi executada com sucesso
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código
|
code | string |
Um valor de "sucesso" indica uma operação bem-sucedida |
targetDefinitionsInfoResponse
Uma lista de definições de alvos e metas associadas para a comunidade.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
definitions
|
definitions | array of targetDefinitionInfoResponse |
targetDefinitionInfoResponse
Informações pormenorizadas para a definição de um alvo específico e os alvos associados
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O Id da definição de destino |
|
Nome
|
name | string |
O nome da definição de destino |
|
Obter confirmação do usuário
|
getUserConfirmation | boolean |
Determina se um usuário é solicitado a confirmar/selecionar sua preferência |
|
Permitir várias seleções
|
allowMultipleSelections | boolean |
Determina se vários destinos podem ser selecionados |
|
Seleção Obrigatória
|
selectionRequired | boolean |
Determina se uma seleção nesta definição é necessária |
|
Prompt de seleção de destino
|
targetSelectionPrompt | string |
Um rótulo personalizado para solicitar que os usuários selecionem suas preferências |
|
criançaAlvos
|
childTargets | array of targetInfoResponse |
targetInfoResponse
Informações detalhadas para um alvo específico.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID de destino |
|
Nome
|
name | string |
O nome do destino |
|
Description
|
description | string |
A descrição das metas |
|
ID da definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
|
ID do pai
|
parentId | integer |
A ID do pai de destinos, se tiver um |
|
Está subscrito
|
isSubscribed | boolean |
Se o usuário está inscrito em um destino específico |
|
criançaAlvos
|
childTargets | array of targetInfoResponse1 |
managePostTagsResposta
Uma lista de tags de postagem definidas no sistema
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of managePostTagResponse |
managePostTagResponse
Informações detalhadas para uma tag de postagem específica
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID da tag |
|
Nome
|
name | string |
O nome da tag |
|
Está disponível para membros
|
isAvailableToMembers | boolean |
Determina se a tag pode ser usada em páginas de envio de postagem voltadas para membros (se habilitada) |
manageUserTagsResponse
Uma lista de tags de usuário definidas no sistema
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tags
|
tags | array of manageUserTagResponse |
manageUserTagResponse
Informações detalhadas para uma tag de usuário específica
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID da tag |
|
Nome
|
name | string |
O nome da tag |
|
tipo
|
type | string | |
|
acceptedValores
|
acceptedValues | array of string |
categoriasResposta
Informações pormenorizadas relacionadas com as categorias
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
categories
|
categories | array of categoryResponse | |
|
Prompt de assinatura
|
subscriptionPrompt | string |
O rótulo para solicitar que os membros selecionem assinaturas de categoria |
|
Ativar Subscrição de Categoria
|
enableCategorySubscription | boolean |
Se os membros têm permissão para modificar suas assinaturas de categoria |
|
Exigir seleção de assinatura
|
requireSubscriptionSelection | boolean |
Se os membros são obrigados a selecionar assinaturas de categoria durante a integração |
|
Categoria padrão da página de destino
|
landingPageDefaultCategory | integer |
O conteúdo padrão a ser exibido ao carregar informações do feed de notícias |
categoryResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID da categoria |
|
Nome
|
name | string |
O nome da categoria |
|
Description
|
description | string |
A descrição da categoria |
|
Ordem de exibição
|
displayOrder | integer |
A ordem de exibição da categoria |
|
Está fixado
|
isPinned | boolean |
Se a categoria foi fixada por um administrador |
|
É forçado
|
isForced | boolean |
Se o usuário autenticado é forçado a se inscrever na categoria determinada |
|
Está subscrito
|
isSubscribed | boolean |
Onde o usuário autenticado está inscrito na categoria dada |
|
Está escondido
|
isHidden | boolean |
Se a categoria está oculta por um administrador |
|
É selecionável pelo usuário
|
isUserSelectable | boolean |
Se os usuários têm permissão para selecionar categorias para postagens enviadas |
|
ID da categoria pai
|
parentCategoryId | integer |
O ID da categoria pai |
|
childCategorias
|
childCategories | array of categoryResponse1 |
pós-resposta
Um post
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da publicação
|
postId | uuid |
O ID do post |
|
ID de origem do post
|
postSourceId | integer |
O ID de origem |
|
Title
|
title | string |
O título do post |
|
Description
|
description | string |
A breve descrição do post |
|
Linha de etiqueta
|
tagLine | string |
O slogan do post |
|
Content
|
content | string |
O corpo do post |
|
Conteúdo bruto
|
rawContent | string |
O corpo da postagem, incluindo todo o HTML (quando o Conteúdo e o RawContent estão incluídos) |
|
Comentários do criador
|
creatorComments | string |
Uma mensagem associada à publicação |
|
|
creatorInfo | userOverviewResponse |
Informações resumidas sobre um utilizador |
|
Localização
|
location | string |
Localização geográfica relacionada com o posto |
|
Propriedades
|
properties | object |
Propriedades diversas do post. Não disponível com todos os tipos de post |
|
Perma Link
|
permaLink | string |
O URL externo referenciado pela publicação |
|
Limpar link Perma
|
cleanPermaLink | string |
O link permanente (excluindo espaços problemáticos e novas linhas) |
|
postType
|
postType | string | |
|
postSourceType
|
postSourceType | string | |
|
postBylineType
|
postBylineType | string | |
|
Provider
|
provider | string |
O provedor social do qual a postagem se originou (por exemplo, Facebook, Twitter). |
|
aprovaçãoEstado
|
approvalState | string | |
|
displayMode
|
displayMode | string | |
|
estado
|
status | string | |
|
Editável pelo usuário
|
userEditable | boolean | |
|
Usuário compartilhável
|
userShareable | boolean |
Indica se o usuário atual pode compartilhar a postagem. Se nenhum usuário atual, o padrão será true. |
|
Comentário do usuário
|
userCommentable | boolean |
Indica se o usuário atual pode participar de difusões na postagem. Se nenhum usuário atual, o padrão será false. |
|
Partilhável
|
sharable | boolean |
Se a plataforma e os widgets permitirão que a publicação seja compartilhada |
|
Transmitido
|
broadcasted | boolean |
Se a publicação foi transmitida aos utilizadores para partilha |
|
Afixado
|
pinned | boolean |
Se a postagem foi definida para exibição prioritária em streams |
|
Data de publicação
|
publishDate | date-time |
Para o conteúdo enviado pelo usuário, a data de envio da postagem; para conteúdos importados de uma fonte externa, a data de publicação de acordo com a fonte |
|
Data de início
|
startDate | date-time |
A data após a qual a postagem está disponível para visualização |
|
Data de fim
|
endDate | date-time |
A data após a qual a postagem não estará mais disponível para visualização |
|
Data de início do evento
|
eventStartDate | date-time |
A data de início do evento (para postagens do tipo evento) |
|
Data de Fim do Evento
|
eventEndDate | date-time |
A data de término do evento (para postagens do tipo evento) |
|
Carimbo de data/hora do provedor
|
providerTimeStamp | date-time |
A data da postagem do ponto de vista dos provedores, ou seja, quando ela foi originalmente postada no provedor social |
|
Pontos de publicação recebidos
|
receivedPublishPoints | boolean |
Se o usuário que enviou a postagem recebeu pontos quando a postagem foi publicada |
|
Texto de Partilha Sugerido
|
suggestedShareText | string |
O texto de partilha sugerido para a publicação |
|
Breve Sugestão de Texto de Partilha
|
shortSuggestedShareText | string |
O texto de compartilhamento sugerido para a postagem para provedores de mensagens curtas |
|
sugeridoShareTextList
|
suggestedShareTextList | array of string | |
|
shortSuggestedShareTextList
|
shortSuggestedShareTextList | array of string | |
|
Partilhar Pontos
|
sharePoints | integer |
O número de pontos atribuídos quando um utilizador partilha a publicação |
|
Clique em Pontos
|
clickPoints | integer |
O número de pontos atribuídos quando alguém clica num link partilhado para a publicação |
|
ID de publicação do provedor
|
providerPostId | string |
O ID original da postagem na rede de provedores |
|
Url Lesma
|
urlSlug | string |
O texto SEO para colocar em links públicos para o post |
|
Classification
|
classification | string |
O tipo de postagem na rede de provedores. |
|
Partilhar com imagens
|
shareWithImages | boolean |
Controla se as publicações partilhadas em serviços de mensagens curtas (como o Twitter) têm imagens partilhadas |
|
Partilhar apenas imagens
|
shareImagesOnly | boolean |
Controla se as publicações partilhadas em determinados serviços são tratadas como atualizações apenas de imagens/fotografias |
|
Ações
|
actions | string |
Um blob JSON contendo uma lista de itens de ação para a postagem e URLs |
|
Menções
|
mentions | string |
As menções (usuários, hashtags, etc.) armazenadas como um blob JSON. |
|
|
statistics | postStatisticsResponse | |
|
|
userShareInfo | postUserShareInfoResponse | |
|
|
author | postAuthorRequestResponse | |
|
links
|
links | array of postLinkRequestResponse | |
|
tags
|
tags | array of postTagRequestResponse | |
|
suporte de dados
|
media | array of postMediaRequestResponse | |
|
images
|
images | object | |
|
candidatoImagens
|
candidateImages | array of postCandidateImageResponse | |
|
Visível
|
visible | boolean |
Se a publicação está visível no momento |
|
shareDivulgações
|
shareDisclosures | array of postShareDisclosureResponse | |
|
shareCommentRules
|
shareCommentRules | array of postShareCommentRulesResponse | |
|
Linguagem
|
language | string |
O idioma do conteúdo da publicação |
|
Usuário oculto
|
userHidden | boolean |
Se o usuário ocultou a postagem de um ou mais fluxos |
|
É visualizado pelo usuário
|
isViewedByUser | boolean |
Se a publicação foi visualizada pelo utilizador atual. |
|
A discussão é visualizada pelo usuário
|
isDiscussionViewedByUser | boolean |
Se o tópico de discussão de postagens foi visualizado pelo usuário atual |
|
É apreciado pelo usuário
|
isLikedByUser | boolean |
Se a publicação foi curtida internamente pelo usuário atual. |
|
É comentado pelo usuário
|
isCommentedByUser | boolean |
Se o post foi comentado pelo usuário atual. |
|
É compartilhado pelo usuário
|
isSharedByUser | boolean |
Se a publicação foi compartilhada anteriormente pelo usuário atual |
|
targets
|
targets | array of targetOverviewResponse | |
|
categories
|
categories | array of categoryOverviewResponse | |
|
Hora Atual
|
currentTime | date-time |
A hora atual no servidor. |
categoryVisão geralResposta
Informações básicas sobre a categoria
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID da categoria |
|
Nome
|
name | string |
O nome da categoria |
|
ID da categoria pai
|
parentCategoryId | integer |
O ID da categoria pai |
targetOverviewResponse
Uma resposta de destino leve que consiste no nome dos destinos, ID e ID da definição de destino a que pertence
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome dos destinos |
|
ID
|
id | integer |
O ID de destino |
|
ID da definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
postCompartilharComentarRegrasResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
fornecedor
|
provider | string | |
|
Limite máximo de caracteres de compartilhamento
|
shareMaxCharacterLimit | integer |
O comprimento máximo de um comentário de usuários em um compartilhamento neste provedor. |
postShareDisclosureResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
fornecedor
|
provider | string | |
|
Nome de exibição do provedor
|
providerDisplayName | string |
O nome de exibição dos provedores |
|
Compartilhar texto de divulgação
|
shareDisclosureText | string |
O texto de divulgação anexado a cada ação |
postCandidateImageResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Endereço URL
|
url | string |
O URL das imagens |
|
Largura
|
width | integer |
A largura das imagens |
|
Altura
|
height | integer |
A altura das imagens |
|
Tipo de mímica
|
mimeType | string |
O tipo MIME de imagens |
|
Ssl Url
|
sslUrl | string |
URL seguro das imagens |
postMediaRequestResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome do objeto de mídia |
|
Largura
|
width | integer |
A largura do objeto de mídia em pixels |
|
Altura
|
height | integer |
A altura do objeto de mídia em pixels |
|
Tipo de mímica
|
mimeType | string |
O tipo MIME do objeto de mídia |
|
Html
|
html | string |
HTML que pode ser usado para renderizar o objeto de mídia |
|
Endereço URL
|
url | string |
A URL para o objeto de mídia |
|
Origem
|
origin | string |
Se disponível, especifica o local original do objeto de mídia |
|
Provider
|
provider | string |
O nome do provedor social |
|
Funções
|
role | string |
O tipo de mídia (se determinado) |
|
Duração
|
duration | integer |
A duração do vídeo em milissegundos |
|
Description
|
description | string |
A descrição do formato de vídeo |
|
Tem url de vídeo
|
hasVideoUrl | boolean |
Indica que essa mídia tem uma URL de vídeo que deve ser assinada usando o "WatchVideo" incluir |
postTagRequestResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome da tag |
postLinkRequestResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Endereço URL
|
url | string |
O URL das publicações |
|
URL expandido
|
expandedUrl | string |
O URL expandido (se existir) |
|
Title
|
title | string |
O título dos posts |
|
Domínio
|
domain | string |
O domínio de links |
|
Favicon Url
|
faviconUrl | string |
O URL favicon do link |
|
Nome
|
name | string |
O nome do link atribuído pelo provedor social |
|
Legenda
|
caption | string |
A legenda curta do link (ou seja, o texto sob o link) |
|
Description
|
description | string |
A descrição do link (ou seja, o texto mais longo sob a legenda) |
|
Data de Modificação
|
modifiedDate | date-time | |
|
Data de criação
|
createdDate | date-time |
postAuthorRequestResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Author
|
author | string |
O texto armazenado para exibir como autor. |
|
URL da imagem de perfil
|
profileImageUrl | string |
A foto de perfil dos autores na rede social |
|
ID de usuário do provedor
|
providerUserId | string |
O ID dos autores na rede social |
|
Nome de usuário do provedor
|
providerUserName | string |
O nome dos autores na rede social |
|
URL do perfil
|
profileUrl | string |
URL do perfil dos autores na rede social |
|
Nome da fonte do post
|
postSourceName | string |
O nome da fonte da postagem. |
|
Site de Origem Postal
|
postSourceSite | string |
O site em que o post se originou |
postUserShareInfoResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Pontos ganhos
|
pointsEarned | integer |
O número de pontos ganhos pelo usuário pelo compartilhamento |
|
Contagem de Ações
|
shareCount | integer |
O número de vezes que o usuário compartilhou |
|
Data de Partilha Mais Recente
|
mostRecentShareDate | date-time |
Data da partilha mais recente dos utilizadores deste post |
postEstatísticasResposta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Total na contagem de compartilhamento de aplicativos
|
totalInAppShareCount | integer |
Sinónimo de ShareCount |
|
ID de rastreamento
|
trackingId | string | |
|
Contagem de Ações
|
shareCount | integer |
A contagem de compartilhamentos iniciados no aplicativo que foram verificados como compartilhados com êxito |
|
Contagem de reações
|
reactionCount | integer |
A contagem de reações (curtidas, retuítes, etc.) a compartilhamentos |
|
Contagem de impressões
|
impressionCount | integer |
As potenciais visualizações de uma publicação por parte de partilhadores, amigos e seguidores |
|
Contagem de visualizações
|
viewedCount | integer |
O número de vezes que a publicação foi visitada por utilizadores com sessão iniciada |
|
Clique em Contar
|
clickCount | integer |
A contagem de cliques para o link de postagens de compartilhamentos |
|
Como Count
|
likeCount | integer |
A contagem de curtidas internas na postagem |
|
Contagem de comentários
|
commentCount | integer |
A contagem de comentários internos na publicação |
|
Comentar como contagem
|
commentLikeCount | integer |
A soma de todas as curtidas em todos os comentários internos no post |
userOverviewResponse
Informações resumidas sobre um utilizador
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de utilizador
|
userId | integer |
ID do utilizador |
|
Nome de exibição
|
displayName | string |
Nome para exibição do usuário |
|
profilePictureImages
|
profilePictureImages | object | |
|
Está ativo
|
isActive | boolean |
Se o usuário ainda é um membro ativo da comunidade |
uploadImageResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Identificador de imagem
|
imageIdentifier | string |
O identificador da imagem carregada |
userRequestResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID interno do usuário |
|
Email
|
string |
O endereço de e-mail dos usuários |
|
|
Pega
|
handle | string |
Os usuários manipulam (o "nome de usuário") |
|
Nome de exibição
|
displayName | string |
O nome de exibição preferido dos usuários |
|
Nome Completo
|
fullName | string |
O nome e o sobrenome do usuário |
|
Nome Próprio
|
firstName | string |
O nome do usuário |
|
Apelido
|
lastName | string |
O sobrenome dos usuários |
|
displayNameFormat
|
displayNameFormat | string | |
|
estado
|
status | string | |
|
Perfil Concluído
|
profileCompleted | boolean |
Se o perfil dos usuários foi concluído durante a integração |
|
Data da Última Atividade
|
lastActivityDate | date-time |
A última vez que o usuário interagiu com o sistema. |
|
Title
|
title | string |
O título dos usuários |
|
Localização
|
location | string |
A localização auto-descrita dos usuários (pode não ser uma localização geográfica real) |
|
ID de usuário da api externa
|
externalApiUserId | string |
O ID dos usuários no sistema externo gerenciado pelo chamador desta API |
|
ID de utilizador do gestor
|
managerUserId | integer |
A ID do gerenciador de usuários (para recursos de hierarquia organizacional) |
|
Fuso Horário
|
timeZone | string |
Fuso horário do usuário representado como um nome de fuso horário do banco de dados tz, conforme definido pela IANA. Exemplo: "América/Los_Angeles". |
|
Fuso horário selecionado
|
selectedTimeZone | string |
Os usuários selecionaram o fuso horário representado como um nome de fuso horário do banco de dados tz, conforme definido pela IANA. Exemplo: "América/Los_Angeles". |
|
Equilíbrio de pontos
|
pointBalance | integer |
O total de pontos ganhos até à data |
|
Pontos não resgatados
|
unredeemedPoints | integer |
Os pontos atualmente disponíveis para resgate |
|
Pontos resgatados
|
redeemedPoints | integer |
O número de pontos resgatados ao longo da vida útil dos usuários |
|
Informações sobre a api
|
apiInfo | string |
Saco de propriedades específico da API |
|
Tem palavra-passe
|
hasPassword | boolean |
Se o usuário tem uma senha associada à conta. |
|
Deve alterar a palavra-passe
|
mustChangePassword | boolean |
Se o usuário deve alterar sua senha com base nas configurações da comunidade |
|
A conta é verificada
|
isAccountVerified | boolean |
Indica se o usuário verificou seu endereço de e-mail |
|
|
statistics | postStatisticsResponse | |
|
tags
|
tags | object | |
|
crachás
|
badges | object | |
|
Afiliações
|
affiliations | array of userAffiliationResponse | |
|
Divisões
|
divisions | array of divisionResponse | |
|
channels
|
channels | array of userChannelResponse | |
|
profilePictureImages
|
profilePictureImages | object | |
|
Idiomas
|
languages | array of string | |
|
Língua primária
|
primaryLanguage | string |
O idioma da interface principal dos usuários |
|
|
scheduleSettings | userScheduleSettingsResponse |
Preferências de compartilhamento agendado por usuários |
|
É Sso
|
isSso | boolean |
Se o usuário está configurado para autenticar usando SSO |
|
|
permissions | userPermissionsResponse |
Permissões de um gerente |
|
|
privileges | userPrivilegesResponse |
Privilégios de um usuário |
|
identificadores
|
identifiers | array of allowlistIdentifiersResponse | |
|
targets
|
targets | array of targetOverviewResponse | |
|
|
defaults | userDefaultsRequestResponse |
Uma coleção de padrões de usuários |
|
Banner de boas-vindas descartado
|
welcomeBannerDismissed | boolean |
Se o usuário descartou o banner de boas-vindas |
userDefaultsRequestResponse
Uma coleção de padrões de usuários
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
defaultPostState
|
defaultPostState | string | |
|
defaultPostApprovalState
|
defaultPostApprovalState | string | |
|
Padrão Post Show Discussões Internas
|
defaultPostShowInternalDiscussions | boolean |
O estado padrão de postagem de discussões internas dos usuários ao criar uma postagem |
|
Publicação padrão Mostrar informações do criador
|
defaultPostShowCreatorInfo | boolean |
O estado padrão dos usuários ao criar uma postagem em relação à exibição do nome e da foto do criador |
allowlistIdentifiersResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID de definição da lista de permissões |
|
Valor
|
value | string |
A resposta dos usuários para a definição de lista de permissão dada |
userPrivilegesResponse
Privilégios de um usuário
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Pode Enviar Posts
|
canSubmitPosts | boolean |
Indica se o usuário tem a capacidade de enviar postagens, com base em seus privilégios e nas configurações da comunidade |
|
Pode compartilhar postagens
|
canSharePosts | boolean |
Indica se o usuário tem a capacidade de compartilhar postagens, com base em seus privilégios e nas configurações da comunidade |
|
Pode comentar posts
|
canCommentPosts | boolean |
Indica se o usuário tem a capacidade de comentar e curtir postagens, com base em seus privilégios e nas configurações da comunidade |
|
Pode gerenciar a comunidade
|
canManageCommunity | boolean |
Indica se o usuário é um gerente dentro da comunidade, com base em seus privilégios e nas configurações da comunidade |
|
Pode gerenciar a organização
|
canManageOrganization | boolean |
Indica se o usuário tem a capacidade de se comunicar com relatórios diretos e indiretos dentro da comunidade, com base em seus privilégios e nas configurações da comunidade |
|
Pode definir Post compartilhável
|
canSetPostShareable | boolean |
Se o usuário pode definir o status compartilhável ao enviar uma postagem |
userPermissionsResponse
Permissões de um gerente
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Ver Transmissão
|
viewBroadcast | boolean |
Permite ao gestor visualizar transmissões |
|
Lista de Transmissão
|
listBroadcast | boolean |
Permite ao gestor visualizar listas de transmissões |
|
Editar transmissão
|
editBroadcast | boolean |
Permite ao gestor criar e editar transmissões |
|
Ver estatísticas de transmissão
|
viewBroadcastStats | boolean |
Permite que o gerente visualize as estatísticas de transmissão |
|
Ver publicação
|
viewPost | boolean |
Permite que o gestor visualize as publicações |
|
Listar Post
|
listPost | boolean |
Permite ao gestor visualizar listas de posts |
|
Editar publicação
|
editPost | boolean |
Permite ao gestor criar e editar publicações |
|
Ver Post Stats
|
viewPostStats | boolean |
Permite que o gerente visualize as estatísticas do post |
|
Ver Inquérito
|
viewSurvey | boolean |
Permite que o gestor visualize inquéritos |
|
Inquérito de lista
|
listSurvey | boolean |
Permite ao gestor visualizar listas de inquéritos |
|
Editar pesquisa
|
editSurvey | boolean |
Permite ao gestor criar e editar inquéritos |
|
Configurações da comunidade
|
communitySettings | boolean |
Permite que o gestor visualize e edite as definições da comunidade |
userScheduleSettingsResponse
Preferências de compartilhamento agendado por usuários
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Dias
|
days | string | |
|
vezes
|
times | array of string |
userChannelResponse
Um canal de usuário.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do canal do usuário
|
userChannelId | integer |
O ID do canal de usuário interno |
|
ID de utilizador
|
userId | integer |
O ID de usuário interno |
|
fornecedor
|
provider | string | |
|
Nome
|
name | string |
O nome dos usuários no provedor social |
|
Nome de exibição
|
displayName | string |
O nome de exibição dos usuários no provedor social |
|
ID de usuário do provedor
|
providerUserId | string |
O ID de utilizador dos fornecedores |
|
estado
|
status | string | |
|
Endereço URL
|
url | string |
O URL do canal |
|
Amigos
|
friends | integer |
O número de amigos que o usuário tem no canal |
|
Followers
|
followers | integer |
O número de seguidores que o usuário tem no canal |
|
Following
|
following | integer |
O número de pessoas que o usuário está seguindo no canal |
|
Postagens
|
posts | integer |
O número de publicações que o usuário fez no canal. |
|
Views
|
views | integer |
O número de visualizações que o usuário tem no canal |
|
Equilíbrio de pontos
|
pointBalance | integer |
O equilíbrio de pontos do usuário no canal |
|
Nome de exibição de origem
|
sourceDisplayName | string |
O nome de exibição do canal do usuário quando usado como fonte de conteúdo |
|
Alcance
|
reach | integer |
Os usuários alcançam no canal |
|
Partilhável
|
sharable | boolean |
Se o canal suporta compartilhamento |
|
Padrão de compartilhamento
|
sharingDefault | boolean |
Se o canal está pré-selecionado para compartilhamento |
|
Autenticação necessária
|
authRequired | boolean |
Se as credenciais dos canais precisam ser renovadas |
|
|
statistics | postStatisticsResponse | |
|
profilePictureImages
|
profilePictureImages | object |
divisãoResposta
Uma definição de divisão
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Divisão
|
divisionId | integer |
O ID da divisão |
|
Nome
|
name | string |
O nome da divisão |
|
ID da Divisão Principal
|
parentDivisionId | integer |
O ID deste pai de divisões |
userAffiliationResponse
Uma afiliação de usuário
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
question | affiliationQuestionResponse |
Uma pergunta de afiliação |
|
|
answer | affiliationAnswerResponse |
Uma resposta de afiliação |
afiliaçãoRespostaResposta
Uma resposta de afiliação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da resposta
|
answerId | integer |
O ID da resposta |
|
Resposta
|
answer | string |
A resposta |
|
Score
|
score | double |
A pontuação, se fornecida |
|
Texto Livre
|
freeText | string |
Texto para perguntas com tipo de pergunta FreeText |
|
Recusar-se a responder
|
declineToAnswer | boolean |
Se definido, esta é a resposta que significa que um usuário se recusou a responder à pergunta. |
|
Position
|
position | integer |
A posição de classificação das respostas |
afiliaçãoPerguntaResposta
Uma pergunta de afiliação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Pergunta
|
questionId | integer |
O ID da pergunta |
|
Nome
|
name | string |
A questão |
|
Posição de pontuação
|
scorePosition | integer |
A posição de classificação das perguntas |
|
Description
|
description | string |
Descrição das perguntas |
|
perguntaTipo de pergunta
|
questionType | string | |
|
Obrigatório
|
required | boolean |
Se a pergunta tem de ser respondida para se registar |
|
É publicamente visível
|
isPubliclyVisible | boolean |
documentInfoResponse
Informações relevantes para um documento anexado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | uuid |
O ID dos documentos |
|
Nome do arquivo
|
fileName | string |
O nome do ficheiro dos documentos (com extensão) |
|
Extension
|
extension | string |
A extensão do arquivo de documentos |
|
Tipo de mímica
|
mimeType | string |
O tipo MIME de documentos |
divisõesResposta
As divisões definidas no sistema
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Divisões
|
divisions | array of divisionResponse | |
|
Pronta
|
prompt | string |
O rótulo para solicitar que os membros selecionem uma divisão |
|
Mostrar seleção de divisão de usuário
|
showUserDivisionSelection | boolean |
Se os membros registados podem alterar a sua própria divisão |
|
Mostrar a seleção da divisão do usuário durante a integração
|
showUserDivisionSelectionDuringOnboarding | boolean |
Se os novos membros devem escolher a sua própria divisão durante o registo |
|
Exigir seleção de divisão de usuários
|
requireUserDivisionSelection | boolean |
Se os membros devem escolher a sua própria divisão. |
|
Permitir várias divisões
|
allowMultipleDivisions | boolean |
Se os membros podem selecionar várias ou apenas uma divisão |
categoryResposta1
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID da categoria |
|
Nome
|
name | string |
O nome da categoria |
|
Description
|
description | string |
A descrição da categoria |
|
Ordem de exibição
|
displayOrder | integer |
A ordem de exibição da categoria |
|
Está fixado
|
isPinned | boolean |
Se a categoria foi fixada por um administrador |
|
É forçado
|
isForced | boolean |
Se o usuário autenticado é forçado a se inscrever na categoria determinada |
|
Está subscrito
|
isSubscribed | boolean |
Onde o usuário autenticado está inscrito na categoria dada |
|
Está escondido
|
isHidden | boolean |
Se a categoria está oculta por um administrador |
|
É selecionável pelo usuário
|
isUserSelectable | boolean |
Se os usuários têm permissão para selecionar categorias para postagens enviadas |
|
ID da categoria pai
|
parentCategoryId | integer |
O ID da categoria pai |
targetInfoResponse1
Informações detalhadas para um alvo específico.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID de destino |
|
Nome
|
name | string |
O nome do destino |
|
Description
|
description | string |
A descrição das metas |
|
ID da definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
|
ID do pai
|
parentId | integer |
A ID do pai de destinos, se tiver um |
|
Está subscrito
|
isSubscribed | boolean |
Se o usuário está inscrito em um destino específico |
|
criançaAlvos
|
childTargets | array of targetInfoResponse2 |
targetInfoResponse2
Informações detalhadas para um alvo específico.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID de destino |
|
Nome
|
name | string |
O nome do destino |
|
Description
|
description | string |
A descrição das metas |
|
ID da definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
|
ID do pai
|
parentId | integer |
A ID do pai de destinos, se tiver um |
|
Está subscrito
|
isSubscribed | boolean |
Se o usuário está inscrito em um destino específico |
|
criançaAlvos
|
childTargets | array of targetInfoResponse3 |
targetInfoResponse3
Informações detalhadas para um alvo específico.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O ID de destino |
|
Nome
|
name | string |
O nome do destino |
|
Description
|
description | string |
A descrição das metas |
|
ID da definição
|
definitionId | integer |
A ID da definição de destino à qual o destino pertence |
|
ID do pai
|
parentId | integer |
A ID do pai de destinos, se tiver um |
|
Está subscrito
|
isSubscribed | boolean |
Se o usuário está inscrito em um destino específico |