SIGNL4 – Alertas móveis
SIGNL4 oferece alertas móveis críticos, resposta a incidentes e expedição de serviço para infraestrutura crítica operacional. Ele alerta você persistentemente por push do aplicativo, texto SMS e chamadas de voz, incluindo acompanhamento, escalonamento, colaboração e planejamento de dever.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Derdack GmbH |
| URL | https://www.signl4.com/feedback-we-love-hear-from-you/ |
| success@signl4.com |
| Metadados do conector | |
|---|---|
| Publicador | Derdack |
| Site | https://www.signl4.com |
| Política de privacidade | https://www.signl4.com/privacy-policy/ |
| Categorias | Operações de TI; Comunicação |
SIGNL4 oferece alertas críticos, resposta a incidentes e expedição de serviço para infraestrutura crítica operacional. Ele alerta você persistentemente por push do aplicativo, texto SMS e chamadas de voz, incluindo acompanhamento, escalonamento, colaboração e planejamento de dever.
Você pode integrar SIGNL4 ao seu fluxo para enviar alertas confiáveis da equipe sempre que necessário.
Pré-requisitos
Você precisa de uma conta SIGNL4. Se você ainda não tem um, você pode obter um https://connect.signl4.com/em . Você também pode baixar diretamente o aplicativo móvel na Google Play Store ou na Apple App Store.
Como obter credenciais
Para usar o conector, você precisa da chave de API SIGNL4. No portal da Web SIGNL4, você obtém sua chave de API em Integrações –> Chave de API. Em seguida, você pode usar sua chave de API para autenticar seu conector SIGNL4 no Power Automate.
Introdução ao conector
Você pode encontrar uma descrição detalhada das funções da API SIGNL4 aqui. Depois de adicionar o conector SIGNL4 ao fluxo do Power Automate, você precisará obter a chave de API SIGNL4. Em seguida, você pode usar as funções de API adequadamente. Se você tiver mais perguntas, não hesite em entrar em contato com a equipe SIGNL4.
A maneira mais fácil de iniciar é usar a ação EventsSend para enviar um alerta:
- Primeiro obtenha o segredo da equipe SIGNL4/segredo de integração do portal da Web SIGNL4.
- Quando você tem o segredo da equipe/segredo de integração, pode usar este na função EventsSend para disparar um evento que pode gerar um alerta para sua equipe. Você só precisa inserir qualquer Título e Mensagem. Você pode encontrar uma descrição dos outros parâmetros na página de documentação do webhook de entrada.
- É isso e agora você dispara um evento e recebe um alerta em SIGNL4.
Problemas e limitações conhecidos
O conector SIGNL4 para Power Automate encapsula toda a API REST SIGNL4 2.0. Algumas funcionalidades dependem do plano SIGNL4.
Erros e soluções comuns
N/A
perguntas frequentes
Você pode encontrar as perguntas frequentes do SIGNL4 e a ajuda online aqui. Além disso, há uma biblioteca de vídeos abrangente disponível.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Acknowlegde vários alertas |
Esse método confirma todos os alertas fornecidos. |
| Adicionar usuário a uma equipe |
Adicionar usuário a uma equipe. |
| Agendamento de tarefas fornecida pelo Creat ou Update |
Criar/atualizar o agendamento de dever determinado. |
| Alerta de gatilho |
Dispara um novo alerta para sua equipe. Todos os membros da equipe de plantão receberão notificações de alerta. |
| Anotar alerta |
Anota um alerta por meio de informações de anotação fornecidas. |
| Atualiza a senha de um usuário |
Atualiza a senha de um usuário. |
| Atualiza dados personalizados de uma determinada instância de script que inclui seu nome de exibição |
Atualiza a instância de script especificada. |
| Atualiza o perfil de equipe de uma equipe |
Atualiza o perfil de equipe de uma equipe. |
| Atualiza o perfil de usuário de um usuário |
Atualiza o perfil de usuário de um usuário. |
| Atualiza um perfil de assinaturas |
Atualiza um perfil de assinaturas. |
| Atualiza uma ação remota |
Exemplo de solicitação:
|
| Atualiza uma determinada instância de script |
Atualiza a instância de script especificada, normalmente usada para atualizar a configuração de um script. |
| Atualizar a associação da equipe do usuário |
Atualiza a associação da equipe do usuário. Você pode mover o usuário para outra equipe dentro da assinatura e/ou alterar a função do usuário. |
| Atualizar as configurações de privacidade de uma equipe |
Atualize as configurações de privacidade de uma equipe. |
| Atualizar as configurações pré-pagas atuais da sua assinatura |
Atualize as configurações pré-pagas atuais da sua assinatura. |
| Atualizar as configurações pré-pagas atuais de uma assinatura |
Atualize as configurações pré-pagas atuais de uma assinatura. |
| Atualizar informações de localidade (por exemplo, idioma, fuso horário) para o usuário |
Atualize as informações de localidade (por exemplo, idioma, fuso horário) para o usuário. |
| Atualizar o modelo de texto explicativo existente para sua assinatura |
Atualize o modelo de texto explicativo existente para sua assinatura. |
| Atualizar um padrão de alerta existente |
Atualize um padrão de alerta existente. |
| Atualizar uma categoria existente |
Exemplo de solicitação:
|
| Atualizar uma fonte de evento |
Atualize uma fonte de evento. |
| Atualizar Webhook por Id |
Atualiza o webhook especificado. |
| Baixar o relatório de dever com um nome de arquivo específico |
Baixe o relatório de dever com um nome de arquivo específico. |
|
Capacidade de desabilitar um web |
Capacidade de desabilitar um webHook. |
|
Capacidade de habilitar um web |
Capacidade de habilitar um webHook. |
| Carregar uma imagem de perfil para um usuário especificado |
Carregou uma imagem de perfil para um usuário especificado. |
| Carregar uma imagem de perfil para uma equipe especificada |
Carregou uma imagem de perfil para uma equipe especificada. |
| Confirma todos os alertas visíveis |
Esse método confirma todos os alertas sem tratamento que sua equipe tem atualmente por um usuário específico. |
| Convidar usuários para uma equipe |
Convide usuários para uma equipe. |
| Copiar feriados de uma equipe para outra |
Copie feriados de uma equipe para outra. |
| Cria uma nova instância de script na equipe SIGNL4 |
Cria uma nova instância de script do script especificado no corpo da solicitação. |
| Criar novos modelos de texto explicativo para sua assinatura |
Crie novos modelos de texto explicativo para sua assinatura. |
| Criar origem do evento |
Criar origem do evento. |
| Criar um novo padrão de alerta |
Crie um novo padrão de alerta. |
| Criar um novo trabalho remoto |
Exemplo de solicitação:
|
| Criar uma categoria |
Exemplo de solicitação:
|
| Criar uma nova ação remota |
Exemplo de solicitação:
|
| Criar Webhook |
Cria um novo webhook de saída que será notificado quando determinados eventos ocorrerem. |
| Define as configurações de alerta de uma equipe específica |
Define as configurações de alerta de uma equipe específica. |
| Definir assinaturas de categoria |
Exemplo de solicitação:
|
| Definir o local de um usuário |
Defina o local de um usuário. |
| Definir o número de telefone de um usuário |
Defina o número de telefone de um usuário. Se outro número de telefone for salvo, ele será substituído. |
| Definir perfis de notificação para o usuário |
Defina perfis de notificação para o usuário. |
| Desabilita uma determinada instância de script |
Desabilita uma determinada instância de script. |
| Desfazer a confirmação de um alerta |
Esse método tenta desfazer uma confirmação de alerta. |
| Desfazer fila de várias confirmações |
Esse método tenta desfazer a confirmação de vários alertas por meio de uma fila. A operação é tratada em segundo plano. |
| Desfazer o fechamento de um alerta |
Esse método tenta desfazer um fechamento de alerta. |
| Envia email de convite novamente se houver um convite |
Envia email de convite novamente se houver um convite. |
| Envia um email para um usuário especificado |
Envia um email para um usuário especificado que contém informações de todas as fontes de eventos da equipe do usuário. |
| Escalonar um alerta manualmente para uma equipe |
Escalone um alerta manualmente para uma equipe. |
| Evento Responder |
Enviar evento. |
| Exclui a conta de usuário |
Exclui a conta de usuário. |
| Exclui a imagem da equipe atual |
Exclui a imagem da equipe atual. |
| Exclui uma ação remota |
Exemplo de solicitação:
|
| Exclui uma instância de script |
Obtém a instância de script especificada pela ID da instância passada. |
| Excluir agendas de dever no intervalo |
Excluir agendas de dever no intervalo. |
| Excluir feriados |
Excluir feriados. |
| Excluir imagem de usuário pessoal |
Excluir imagem de usuário pessoal. |
| Excluir o modelo de texto explicativo existente de sua assinatura |
Exclua o modelo de texto explicativo existente de sua assinatura. |
| Excluir o número de telefone de um usuário |
Exclua o número de telefone de um usuário. |
| Excluir um dever específico |
Exclua um dever específico. |
| Excluir um endereço de contato de um usuário |
Exclua um endereço de contato de um usuário. |
| Excluir um padrão de alerta específico |
Exclua um padrão de alerta específico. |
| Excluir uma categoria existente |
Exemplo de solicitação:
|
| Excluir uma distribuição de eventos |
Excluir uma distribuição de eventos. |
| Excluir uma fonte de evento |
Excluir uma fonte de evento. |
| Excluir Webhook por ID |
Exclui o webhook especificado para que ele não seja mais notificado. |
| Fechar todos os alertas reconhecidos |
Esse método fecha todos os alertas reconhecidos que sua equipe tem no momento. |
| Fechar um alerta |
Feche um alerta. |
| Fechar vários alertas |
Esse método fecha todos os alertas fornecidos. |
| Habilita uma instância de script |
Habilita uma instância de script. |
| Obtendo todos os usuários das equipes especificadas |
Obtendo todos os usuários das equipes especificadas. |
| Obter a origem do evento por id |
Obter a origem do evento por ID. |
| Obter as configurações pré-pagas atuais da sua assinatura |
Obtenha as configurações pré-pagas atuais da sua assinatura. |
| Obter as configurações pré-pagas atuais de uma assinatura |
Obtenha as configurações pré-pagas atuais de uma assinatura. |
| Obter assinaturas de categoria |
Exemplo de solicitação:
|
| Obter associações de equipe de um usuário |
Obtenha associações de equipe de um usuário. |
| Obter associações de equipe por equipe |
Obtenha associações de equipe por equipe. |
| Obter configurações de dever de equipe para várias equipes |
Obtenha as configurações de dever de equipe para várias equipes. |
| Obter configurações de privacidade da equipe para uma equipe |
Obtenha as configurações de privacidade da equipe para uma equipe. |
| Obter detalhes de um evento |
Obtenha detalhes de um evento. |
| Obter detalhes sobre um alerta |
Obtenha detalhes sobre um alerta. |
| Obter entradas da linha do tempo do alerta |
Obtenha entradas de linha do tempo de alerta de um alerta por ID. |
| Obter evento de visão geral |
Obter evento de visão geral por ID. |
| Obter feriados para a equipe |
Obtenha feriados para a equipe. |
| Obter fontes de eventos de uma ou mais equipes |
Obtenha fontes de eventos de uma ou mais equipes. |
| Obter imagem de usuário pessoal |
Obtenha uma imagem de usuário pessoal. |
| Obter informações de anexo de um alerta |
Obtenha anexos de um alerta por ID. |
| Obter informações de todas as assinaturas gerenciadas e disponíveis |
Obtenha informações de todas as assinaturas disponíveis/gerenciadas. |
| Obter informações de todas as equipes |
Obtenha informações de todas as equipes. |
| Obter informações de uma assinatura específica |
Obtenha informações de uma assinatura específica. |
| Obter informações do assistente de serviço para as equipes |
Obtenha informações do assistente de serviço para as equipes. |
| Obter informações para todas as equipes da assinatura |
Obtenha informações para todas as equipes da assinatura. |
| Obter informações públicas sobre todas as equipes em uma assinatura |
Obtenha informações públicas sobre todas as equipes em uma assinatura. |
| Obter informações sobre relatórios de alertas para download |
Obtenha informações sobre relatórios de alertas para download. |
| Obter métricas para todas as categorias |
Exemplo de solicitação:
|
| Obter métricas para uma categoria específica |
Exemplo de solicitação:
|
| Obter notificações de alerta |
Obtenha notificações de todos os usuários por ID de alerta. |
| Obter o evento de visão geral paginado |
Obter um evento de visão geral paginado. Se houver mais resultados, você também obterá um token de continuação que poderá ser adicionado ao filtro de eventos. |
| Obter o saldo pré-pago atual da sua assinatura |
Obtenha o saldo pré-pago atual da sua assinatura. |
| Obter o saldo pré-pago atual de uma assinatura |
Obtenha o saldo pré-pago atual de uma assinatura. |
| Obter o status do dever por ID do usuário |
Retorna um objeto com informações de dever. |
| Obter parâmetros de evento |
Obter parâmetros de um evento por id. |
| Obter perfis de notificação para o usuário |
Obtenha perfis de notificação para o usuário. |
| Obter relatório de alerta |
Retorna informações sobre o volume de alerta ocorrido em períodos de tempo diferentes, bem como informações sobre o comportamento da resposta (quantidade de alertas confirmados e sem tratamento) dos membros da equipe. |
| Obter todas as categorias |
Obtenha todas as categorias. |
| Obter todas as categorias |
Exemplo de solicitação:
|
| Obter todas as equipes das quais o usuário é membro |
Retorna uma lista de objetos de equipe com detalhes como seu nome. Somente as equipes das quais o usuário é membro serão retornadas. |
| Obter todos os modelos de texto explicativo para sua assinatura |
Obtenha todos os modelos de texto explicativo para sua assinatura. |
| Obter todos os padrões de alerta da equipe |
Obtenha todos os padrões de alerta da equipe. |
| Obter todos os usuários |
Retorna uma lista de objetos de usuário com detalhes, como seu endereço de email e informações de dever. Somente os usuários aos quais você tem acesso serão retornados. |
| Obter transações pré-pagas da sua assinatura |
Obtenha as transações pré-pagas da sua assinatura. |
| Obter transações pré-pagas de uma assinatura |
Obtenha transações pré-pagas de uma assinatura. |
| Obter uma categoria específica |
Exemplo de solicitação:
|
| Obter Usuário por ID |
Retorna um objeto de usuário com detalhes como seu endereço de email e informações de dever. |
| Obter Webhook por ID |
Retorna informações do webhook especificado pela ID passada. |
| Obter Webhooks |
Retorna uma coleção de webhooks de saída definidos no sistema. |
| Obtém a imagem de uma equipe especificada |
Obtém a imagem de uma equipe especificada. |
| Obtém alertas paginado |
Obtém alertas paginado. |
| Obtém as configurações de alerta de uma equipe específica |
Obtém as configurações de alerta de uma equipe específica. |
| Obtém as configurações de alerta de uma equipe específica |
Obtém as configurações de alerta de uma equipe específica. |
| Obtém as licenças de número de voz de uma assinatura |
Obtém as licenças de número de voz de uma assinatura. |
| Obtém as licenças de usuário de uma assinatura |
Obtém as licenças de usuário de uma assinatura. |
| Obtém fontes de eventos de uma equipe específica |
Obtém fontes de eventos de uma equipe específica. |
| Obtém informações de uma equipe específica |
Obtém informações de uma equipe específica. |
| Obtém o progresso da instalação de um usuário específico |
Obtém o progresso da instalação de um usuário específico. |
| Obtém o progresso da instalação de uma equipe específica |
Obtém o progresso da instalação de uma equipe específica. |
| Obtém os nomes de todas as imagens de categoria de alerta |
Obtém os nomes de todas as imagens de categoria de alerta. Você pode obter a imagem acessando account.signl4.com/images/alerts/categoryImageName.svg. |
| Obtém um anexo especificado de um alerta especificado |
Obtém um anexo especificado de um alerta especificado. |
| Receba um alerta |
Obtém um alerta por ID. |
| Reconhecer um alerta |
Confirme um alerta. |
| Recuperar todas as definições disponíveis |
Recupere todas as definições disponíveis. |
| Recuperar uma definição |
Recupere uma definição. |
| Remove um usuário ou convite de uma equipe |
Remove um usuário ou convite de uma equipe. |
| Retirar o fechamento de vários alertas |
Esse método tenta desfazer vários fechamentos de alerta. A operação é tratada em segundo plano. |
| Retorna as informações de preço do canal da assinatura |
Retorna as informações de preço do canal da assinatura. |
| Retorna ações remotas |
Exemplo de solicitação:
|
| Retorna informações do agendamento do dever com a ID especificada |
Retorna informações do agendamento do dever com a ID especificada. |
| Retorna informações sobre todos os agendamentos planejados |
Retorna informações sobre todos os agendamentos planejados. |
| Retorna o Relatório de Alertas |
Retorna o Relatório de Alertas. |
| Retorna os recursos de uma assinatura especificada |
Retorna os recursos de uma assinatura especificada. |
| Retorna todas as informações sobre uma determinada instância de script |
Obtém a instância de script especificada pela ID da instância passada. |
| Retorna todas as instâncias de script da equipe SIGNL4 |
Retorna todas as instâncias de script na assinatura. |
| Retorna todos os scripts de inventário |
Retorna todos os scripts de inventário. |
| Retorna todos os scripts de inventário disponíveis |
Retorna todos os scripts de inventário disponíveis que podem ser adicionados a uma assinatura SIGNL4. |
| Retorna trabalhos remotos paginado do Diário |
Exemplo de solicitação:
|
| Retorna um script de inventário por sua ID |
Obtém o script especificado pela ID de script passada. |
| Retorna um trabalho remoto do Diário |
Exemplo de solicitação:
|
| Retorna uma ação remota |
Exemplo de solicitação:
|
| Salvar feriados para uma equipe |
Salve feriados para uma equipe. |
| Salvar feriados repetidos para uma equipe |
Salve feriados repetidos para uma equipe. |
| Salvar vários agendamentos |
Salve vários agendamentos. Se desejar, é possível substituir os agendamentos existentes. |
| Socar o usuário |
O usuário especificado será socado para o dever. |
| Socar o usuário como Gerente |
O usuário especificado será socado como um gerente. |
| Socar o usuário para fora |
O usuário especificado será retirado do serviço. |
| Valida um número de telefone criado anteriormente para um usuário |
Valida um número de telefone criado anteriormente para um usuário. |
| Validar um intervalo de tempo de um padrão |
Valide um intervalo de tempo de um padrão em relação a todos os slots de tempo existentes de outros padrões. |
| Verifica se um usuário tem a permissão fornecida |
Verifica se um usuário tem a permissão fornecida. |
Acknowlegde vários alertas
Esse método confirma todos os alertas fornecidos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Adicionar usuário a uma equipe
Adicionar usuário a uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
Id da equipe para a qual o usuário deve ser convidado. |
|
ID do Usuário
|
userId | True | string |
Id do usuário que você deseja adicionar a uma equipe. |
|
roleId
|
roleId | string | ||
|
setUserOnDuty
|
setUserOnDuty | boolean |
Retornos
- Corpo
- V2.TeamMembershipDetails
Agendamento de tarefas fornecida pelo Creat ou Update
Criar/atualizar o agendamento de dever determinado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
Id da equipe à qual o dever deve ser atribuído. |
|
término
|
end | date-time | ||
|
id
|
id | string | ||
|
opções
|
options | integer | ||
|
start
|
start | date-time | ||
|
userId
|
userId | string |
Retornos
- Corpo
- ScheduleInfo
Alerta de gatilho
Dispara um novo alerta para sua equipe. Todos os membros da equipe de plantão receberão notificações de alerta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | string | ||
|
ordem
|
order | integer | ||
|
tipo
|
type | integer |
|
|
|
value
|
value | string | ||
|
conteúdo
|
content | string | ||
|
tipo de conteúdo
|
contentType | string | ||
|
codificação
|
encoding | integer |
|
|
|
id
|
id | string | ||
|
nome
|
name | string | ||
|
categoria
|
category | string | ||
|
ID externo
|
externalId | string | ||
|
Sinalizadores
|
flags | integer |
|
|
|
severidade
|
severity | integer |
|
|
|
teamId
|
teamId | True | string | |
|
enviar SMS
|
text | True | string | |
|
title
|
title | True | string |
Retornos
- Corpo
- V2.AlertDetails
Anotar alerta
Anota um alerta por meio de informações de anotação fornecidas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
ID do alerta a ser anotado. |
|
enviar SMS
|
text | string | ||
|
tipo
|
type | integer |
|
|
|
userId
|
userId | string |
Retornos
Atualiza a senha de um usuário
Atualiza a senha de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário cuja senha deve ser alterada. |
|
currentPassword
|
currentPassword | string | ||
|
newPassword
|
newPassword | string |
Atualiza dados personalizados de uma determinada instância de script que inclui seu nome de exibição
Atualiza a instância de script especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da instância de script
|
instanceId | True | string |
ID da instância do script a ser atualizado. |
|
customScriptDescription
|
customScriptDescription | string | ||
|
customScriptName
|
customScriptName | string | ||
|
instanceId
|
instanceId | string | ||
|
scriptName
|
scriptName | string |
Retornos
- Corpo
- ScriptInstanceDetails
Atualiza o perfil de equipe de uma equipe
Atualiza o perfil de equipe de uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe que deve ser atualizada. |
|
nome
|
name | string |
Retornos
- Corpo
- TeamInfo
Atualiza o perfil de usuário de um usuário
Atualiza o perfil de usuário de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário a ser atualizado. |
|
nome
|
name | string | ||
|
Fuso horário
|
timeZone | string |
Retornos
- Corpo
- UserInfo
Atualiza um perfil de assinaturas
Atualiza um perfil de assinaturas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura a ser atualizada |
|
nome
|
name | string |
Retornos
- Corpo
- SubscriptionInfo
Atualiza uma ação remota
Exemplo de solicitação:
PUT /remoteActions/{actionId}
{
"teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
"name": "MyAction",
"enabled": true,
}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da ação
|
actionId | True | string |
ID da ação remota a ser atualizada |
|
ID da ação
|
language | integer |
|
|
|
nome
|
name | True | string | |
|
value
|
value | string | ||
|
canEdit
|
canEdit | boolean | ||
|
canExecute
|
canExecute | boolean | ||
|
teamId
|
teamId | string | ||
|
definitionId
|
definitionId | string | ||
|
descrição
|
description | string | ||
|
enabled
|
enabled | boolean | ||
|
nome
|
name | string | ||
|
teamId
|
teamId | string |
Retornos
- Corpo
- V2.RemoteActionDetails
Atualiza uma determinada instância de script
Atualiza a instância de script especificada, normalmente usada para atualizar a configuração de um script.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da instância de script
|
instanceId | True | string |
ID da instância do script a ser atualizado. |
|
config
|
config | |||
|
customScriptDescription
|
customScriptDescription | string | ||
|
customScriptName
|
customScriptName | string | ||
|
enabled
|
enabled | boolean | ||
|
teamId
|
teamId | string |
Retornos
- Corpo
- ScriptInstanceDetails
Atualizar a associação da equipe do usuário
Atualiza a associação da equipe do usuário. Você pode mover o usuário para outra equipe dentro da assinatura e/ou alterar a função do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
A equipe do usuário ao qual você deseja atualizar pertence no momento. |
|
ID do Usuário
|
userId | True | string |
ID do usuário que você deseja atualizar. |
|
ID do Usuário
|
requesterUserId | string |
ID de usuário com a qual você deseja alterar a função. Isso deve ser fornecido ao usar uma chave de api. Esse usuário deve ter o administrador de funções (para definir a função de administrador) ou o administrador da equipe (para definir direitos. |
|
|
Definir Usuário de Plantão
|
setUserOnDuty | boolean |
Define o novo status de dever para o usuário se o usuário for movido para uma equipe diferente. O usuário está de plantão como padrão. |
|
|
isValid
|
isValid | boolean | ||
|
roleId
|
roleId | string | ||
|
teamId
|
teamId | string |
Retornos
- Corpo
- UserInfo
Atualizar as configurações de privacidade de uma equipe
Atualize as configurações de privacidade de uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe |
|
hideContactAddresses
|
hideContactAddresses | boolean | ||
|
hideDutyData
|
hideDutyData | boolean | ||
|
hideForEscalation
|
hideForEscalation | boolean |
Retornos
Atualizar as configurações pré-pagas atuais da sua assinatura
Atualize as configurações pré-pagas atuais da sua assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
topUpAmount
|
topUpAmount | integer | ||
|
topUpEnabled
|
topUpEnabled | boolean | ||
|
topUpLimit
|
topUpLimit | integer |
Retornos
- Corpo
- PrepaidSettingsInfo
Atualizar as configurações pré-pagas atuais de uma assinatura
Atualize as configurações pré-pagas atuais de uma assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura |
|
topUpAmount
|
topUpAmount | integer | ||
|
topUpEnabled
|
topUpEnabled | boolean | ||
|
topUpLimit
|
topUpLimit | integer |
Retornos
- Corpo
- PrepaidSettingsInfo
Atualizar informações de localidade (por exemplo, idioma, fuso horário) para o usuário
Atualize as informações de localidade (por exemplo, idioma, fuso horário) para o usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário, email ou "eu" para o usuário que você deseja atualizar |
|
linguagem
|
language | string | ||
|
Fuso horário
|
timeZone | string |
Retornos
Atualizar o modelo de texto explicativo existente para sua assinatura
Atualize o modelo de texto explicativo existente para sua assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Modelo
|
templateId | True | string |
ID do modelo que você deseja atualizar |
|
categoryId
|
categoryId | string | ||
|
ID externo
|
externalId | string | ||
|
id
|
id | string | ||
|
local
|
location | string | ||
|
nome
|
name | string | ||
|
assunto
|
subject | string | ||
|
targetAllTeams
|
targetAllTeams | boolean | ||
|
targetTeamId
|
targetTeamId | string | ||
|
enviar SMS
|
text | string | ||
|
workflowType
|
workflowType | integer |
|
Retornos
- response
- array of V2.CalloutTemplateDetails
Atualizar um padrão de alerta existente
Atualize um padrão de alerta existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe para a qual você deseja criar o padrão |
|
ID do padrão
|
patternId | True | string |
ID padrão do padrão a ser atualizado |
|
categories
|
categories | array of string | ||
|
enabled
|
enabled | boolean | ||
|
mode
|
mode | integer |
|
|
|
referenceId
|
referenceId | string | ||
|
id
|
id | string | ||
|
nome
|
name | string | ||
|
canal
|
channel | integer |
|
|
|
atrasoemminutos
|
delayInMinutes | integer | ||
|
enabled
|
enabled | boolean | ||
|
overrideEscalationSettings
|
overrideEscalationSettings | boolean | ||
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | ||
|
overrideResponseSettings
|
overrideResponseSettings | boolean | ||
|
responseMode
|
responseMode | integer |
|
|
|
responseTime
|
responseTime | integer | ||
|
suppressSignl
|
suppressSignl | boolean | ||
|
hora
|
hour | integer | ||
|
minutes
|
minutes | integer | ||
|
Semana
|
weekday | integer |
|
|
|
id
|
id | string |
Retornos
Atualizar uma categoria existente
Exemplo de solicitação:
PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
"name": "Water-Updated",
"imageName": "water.svg",
"color": "#0000cc",
"keywordMatching": "All",
"keywords": [
{
"value": "H2O"
},
{
"value": "Water"
},
{
"value": "Wet"
}
]
}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual a categoria pertence |
|
ID da categoria
|
categoryId | True | string |
ID da categoria |
|
enabled
|
enabled | boolean | ||
|
id
|
id | string | ||
|
nome
|
name | string | ||
|
tipo
|
type | True | integer |
|
|
value
|
value | string | ||
|
color
|
color | True | string | |
|
id
|
id | string | ||
|
nome
|
name | string | ||
|
tipo
|
type | True | integer |
|
|
value
|
value | string | ||
|
id
|
id | string | ||
|
nome_da_imagem
|
imageName | True | string | |
|
isDefault
|
isDefault | boolean | ||
|
keywordMatching
|
keywordMatching | True | integer |
|
|
Palavras-chave
|
keywords | True | array of string | |
|
palavras-chaveExcluded
|
keywordsExcluded | array of string | ||
|
nome
|
name | True | string | |
|
opções
|
options | integer |
|
|
|
ordem
|
order | integer | ||
|
teamId
|
teamId | string |
Retornos
- Corpo
- CategoryInfo
Atualizar uma fonte de evento
Atualize uma fonte de evento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da origem do evento
|
eventSourceId | True | string |
ID da origem do evento |
|
descrição
|
description | string | ||
|
desabilitado
|
disabled | boolean | ||
|
nome
|
name | string | ||
|
teamId
|
teamId | string |
Retornos
- Corpo
- EventSourceEndpointInfo
Atualizar Webhook por Id
Atualiza o webhook especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Webhook de saída
|
webhookId | True | string |
ID do webhook de saída a ser atualizado. |
|
descrição
|
description | string | ||
|
extUrl
|
extUrl | True | string | |
|
nome
|
name | True | string | |
|
teamId
|
teamId | string |
Retornos
- Corpo
- WebhookInfo
Baixar o relatório de dever com um nome de arquivo específico
Baixe o relatório de dever com um nome de arquivo específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe para a qual você deseja baixar o relatório de dever. |
|
Nome do Arquivo
|
fileName | True | string |
Nome do arquivo do csv a ser baixado. |
Retornos
- response
- binary
Capacidade de desabilitar um webHook
Capacidade de desabilitar um webHook.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | string |
ID do webhook para webhook que deve ser habilitada. |
Retornos
- Corpo
- WebhookInfo
Capacidade de habilitar um webHook
Capacidade de habilitar um webHook.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | string |
ID do webhook para webhook que deve ser desabilitada. |
Retornos
- Corpo
- WebhookInfo
Carregar uma imagem de perfil para um usuário especificado
Carregou uma imagem de perfil para um usuário especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário. |
Carregar uma imagem de perfil para uma equipe especificada
Carregou uma imagem de perfil para uma equipe especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe onde definir a imagem da equipe. |
Confirma todos os alertas visíveis
Esse método confirma todos os alertas sem tratamento que sua equipe tem atualmente por um usuário específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
ID de usuário do usuário a ser usado para reconhecer os alarmes. |
|
|
categoryIds
|
categoryIds | array of string | ||
|
maxDate
|
maxDate | date-time | ||
|
minDate
|
minDate | date-time | ||
|
escopo
|
scope | integer |
|
|
|
teamIds
|
teamIds | array of string |
Convidar usuários para uma equipe
Convide usuários para uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
inviterId
|
inviterId | string | ||
|
email
|
string | |||
|
roleId
|
roleId | string | ||
|
teamId
|
teamId | True | string |
Retornos
- response
- array of V2.InvitationResult
Copiar feriados de uma equipe para outra
Copie feriados de uma equipe para outra.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe para a qual você deseja copiar feriados |
|
Ano
|
year | True | integer |
Ano do qual você deseja copiar |
|
ID da equipe
|
sourceTeamId | True | string |
ID da equipe da qual você deseja copiar feriados |
Retornos
- Corpo
- V2.TeamHolidayDetails
Cria uma nova instância de script na equipe SIGNL4
Cria uma nova instância de script do script especificado no corpo da solicitação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
config
|
config | |||
|
customScriptDescription
|
customScriptDescription | string | ||
|
customScriptName
|
customScriptName | string | ||
|
enabled
|
enabled | boolean | ||
|
instanceId
|
instanceId | string | ||
|
scriptId
|
scriptId | string | ||
|
scriptName
|
scriptName | string | ||
|
sharedTeams
|
sharedTeams | array of string | ||
|
teamId
|
teamId | string |
Retornos
- Corpo
- ScriptInstanceDetails
Criar novos modelos de texto explicativo para sua assinatura
Crie novos modelos de texto explicativo para sua assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
categoryId
|
categoryId | string | ||
|
ID externo
|
externalId | string | ||
|
id
|
id | string | ||
|
local
|
location | string | ||
|
nome
|
name | string | ||
|
assunto
|
subject | string | ||
|
targetAllTeams
|
targetAllTeams | boolean | ||
|
targetTeamId
|
targetTeamId | string | ||
|
enviar SMS
|
text | string | ||
|
workflowType
|
workflowType | integer |
|
Retornos
- response
- array of V2.CalloutTemplateDetails
Criar origem do evento
Criar origem do evento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
descrição
|
description | string | ||
|
desabilitado
|
disabled | boolean | ||
|
linguagem
|
language | integer |
|
|
|
nome
|
name | string | ||
|
sharedTeams
|
sharedTeams | array of string | ||
|
teamId
|
teamId | string | ||
|
tipo
|
type | integer |
|
Retornos
- Corpo
- EventSourceEndpointInfo
Criar um novo padrão de alerta
Crie um novo padrão de alerta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe para a qual você deseja criar o padrão |
|
categories
|
categories | array of string | ||
|
enabled
|
enabled | boolean | ||
|
mode
|
mode | integer |
|
|
|
referenceId
|
referenceId | string | ||
|
id
|
id | string | ||
|
nome
|
name | string | ||
|
canal
|
channel | integer |
|
|
|
atrasoemminutos
|
delayInMinutes | integer | ||
|
enabled
|
enabled | boolean | ||
|
overrideEscalationSettings
|
overrideEscalationSettings | boolean | ||
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | ||
|
overrideResponseSettings
|
overrideResponseSettings | boolean | ||
|
responseMode
|
responseMode | integer |
|
|
|
responseTime
|
responseTime | integer | ||
|
suppressSignl
|
suppressSignl | boolean | ||
|
hora
|
hour | integer | ||
|
minutes
|
minutes | integer | ||
|
Semana
|
weekday | integer |
|
|
|
id
|
id | string |
Retornos
Criar um novo trabalho remoto
Exemplo de solicitação:
POST /remoteActions/{actionId}/jobs
{
"remoteActionPin" : "1234",
"parameters": [
{
"name": "Param1",
"value": "Value 1"
}
]
}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da ação
|
actionId | True | string |
ID da ação |
|
nome
|
name | True | string | |
|
value
|
value | string | ||
|
alertId
|
alertId | string | ||
|
opções
|
options | integer |
|
|
|
remoteActionPin
|
remoteActionPin | string |
Retornos
- Corpo
- V2.RemoteJob
Criar uma categoria
Exemplo de solicitação:
POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
"name": "Water",
"imageName": "water.svg",
"color": "#0000cc",
"keywordMatching": "Any",
"keywords": [
{
"value": "H2O"
},
{
"value": "Water"
}
]
}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual a categoria pertence |
|
enabled
|
enabled | boolean | ||
|
id
|
id | string | ||
|
nome
|
name | string | ||
|
tipo
|
type | True | integer |
|
|
value
|
value | string | ||
|
color
|
color | True | string | |
|
id
|
id | string | ||
|
nome
|
name | string | ||
|
tipo
|
type | True | integer |
|
|
value
|
value | string | ||
|
id
|
id | string | ||
|
nome_da_imagem
|
imageName | True | string | |
|
isDefault
|
isDefault | boolean | ||
|
keywordMatching
|
keywordMatching | True | integer |
|
|
Palavras-chave
|
keywords | True | array of string | |
|
palavras-chaveExcluded
|
keywordsExcluded | array of string | ||
|
nome
|
name | True | string | |
|
opções
|
options | integer |
|
|
|
ordem
|
order | integer | ||
|
teamId
|
teamId | string |
Retornos
- Corpo
- CategoryInfo
Criar uma nova ação remota
Exemplo de solicitação:
POST /remoteActions
{
"teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
"name": "MyAction",
"enabled": true,
}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Linguagem
|
language | integer |
|
|
|
nome
|
name | True | string | |
|
value
|
value | string | ||
|
canEdit
|
canEdit | boolean | ||
|
canExecute
|
canExecute | boolean | ||
|
teamId
|
teamId | string | ||
|
definitionId
|
definitionId | string | ||
|
descrição
|
description | string | ||
|
enabled
|
enabled | boolean | ||
|
nome
|
name | string | ||
|
teamId
|
teamId | string |
Retornos
- Corpo
- V2.RemoteActionDetails
Criar Webhook
Cria um novo webhook de saída que será notificado quando determinados eventos ocorrerem.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
descrição
|
description | string | ||
|
extUrl
|
extUrl | True | string | |
|
nome
|
name | True | string | |
|
teamId
|
teamId | string |
Retornos
- response
- string
Define as configurações de alerta de uma equipe específica
Define as configurações de alerta de uma equipe específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe para a qual as configurações devem ser definidas. |
|
escEnabled
|
escEnabled | boolean | ||
|
escMode
|
escMode | integer |
|
|
|
escRefId
|
escRefId | string | ||
|
filterAction
|
filterAction | integer |
|
|
|
filterMode
|
filterMode | integer |
|
|
|
canal
|
channel | integer |
|
|
|
atraso
|
delay | integer | ||
|
enabled
|
enabled | boolean | ||
|
optOut
|
optOut | integer |
|
|
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | ||
|
persNotInterval
|
persNotInterval | integer | ||
|
persNotMode
|
persNotMode | integer |
|
|
|
responseMode
|
responseMode | integer |
|
|
|
responseTime
|
responseTime | integer |
Retornos
- Corpo
- AlertSettings
Definir assinaturas de categoria
Exemplo de solicitação:
POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual a categoria pertence |
|
ID da categoria
|
categoryId | True | string |
Categoria a ser atualizada |
|
status
|
status | True | integer |
|
|
userId
|
userId | True | string |
Retornos
- response
- array of CategorySubscriptionInfo
Definir o local de um usuário
Defina o local de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário. |
|
latitude
|
latitude | double | ||
|
longitude
|
longitude | double | ||
|
carimbo de data/hora
|
timestamp | date-time |
Retornos
- Corpo
- LocationInfo
Definir o número de telefone de um usuário
Defina o número de telefone de um usuário. Se outro número de telefone for salvo, ele será substituído.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário ao qual você deseja adicionar um número de telefone |
|
código do país
|
countryCode | string | ||
|
número de telefone
|
phoneNumber | string | ||
|
sendValidationCode
|
sendValidationCode | boolean | ||
|
sendValidationCodeVia
|
sendValidationCodeVia | integer |
|
Retornos
Definir perfis de notificação para o usuário
Defina perfis de notificação para o usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
Id do usuário do qual você deseja obter os perfis de notificação. |
|
canal
|
channel | integer |
|
|
|
atrasoemminutos
|
delayInMinutes | integer | ||
|
enabled
|
enabled | boolean | ||
|
opções
|
options | integer | ||
|
persistente
|
persistent | boolean |
Retornos
Desabilita uma determinada instância de script
Desabilita uma determinada instância de script.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da instância de script
|
instanceId | True | string |
ID da instância a ser desabilitada. |
Retornos
- Corpo
- ScriptInstanceDetails
Desfazer a confirmação de um alerta
Esse método tenta desfazer uma confirmação de alerta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
ID do alerta. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retornos
- Corpo
- V2.AlertInfo
Desfazer fila de várias confirmações
Esse método tenta desfazer a confirmação de vários alertas por meio de uma fila. A operação é tratada em segundo plano.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Desfazer o fechamento de um alerta
Esse método tenta desfazer um fechamento de alerta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
ID do alerta. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retornos
- Corpo
- V2.AlertInfo
Envia email de convite novamente se houver um convite
Envia email de convite novamente se houver um convite.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe com o usuário convidado. |
|
inviterId
|
inviterId | string | ||
|
userMail
|
userMail | True | string |
Retornos
- response
- string
Envia um email para um usuário especificado
Envia um email para um usuário especificado que contém informações de todas as fontes de eventos da equipe do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
A ID do usuário. |
|
ID da equipe
|
teamId | string |
A ID da equipe da qual o usuário deve obter as informações do ponto de extremidade. |
Escalonar um alerta manualmente para uma equipe
Escalone um alerta manualmente para uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
ID de alerta para alerta que você deseja escalonar. |
|
targetTeamId
|
targetTeamId | string | ||
|
userId
|
userId | string |
Retornos
- response
- string
Evento Responder
Enviar evento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Segredo da equipe
|
teamSecret | True | string |
Segredo da Equipe. |
|
Title
|
Title | True | string | |
|
Message
|
Message | True | string | |
|
X-S4-Service
|
X-S4-Service | string |
X-S4-Service: atribui o Signl à categoria de serviço/sistema com o nome especificado. |
|
|
X-S4-Location
|
X-S4-Location | string |
X-S4-Location: transmitir informações de localização (latitude, longitude) com seu evento e exibir um mapa no aplicativo móvel. |
|
|
X-S4-AlertingScenario
|
X-S4-AlertingScenario | string |
X-S4-AlertingScenario: se esse evento disparar um Signl, permitirá controlar como SIGNL4 notifica a equipe. Os valores com suporte são: single_ack, multi_ack, emergência. |
|
|
X-S4-ExternalID
|
X-S4-ExternalID | string |
X-S4-ExternalID: se o evento se originar de um registro em um sistema de terceiros, use esse parâmetro para passar a ID exclusiva desse registro. Essa ID será comunicada em notificações de webhook de saída do SIGNL4, o que é ótimo para correlação/sincronização desse registro com o Signl. |
|
|
X-S4-Status
|
X-S4-Status | string |
X-S4-Status: se você quiser resolver um Signl existente por uma ID externa (X-S4-ExternalID), poderá adicionar esse parâmetro de status. Ele tem três valores possíveis: novo, reconhecido, resolvido. |
|
|
X-S4-Filtering
|
X-S4-Filtering | boolean |
Filtragem X-S4: especifique um valor booliano de true ou false para aplicar a filtragem de eventos para esse evento ou não. Se definido como true, o evento disparará apenas uma notificação para a equipe, se contiver pelo menos uma palavra-chave de um de seus serviços e categorias do sistema (ou seja, ele está na lista de permissões). |
|
|
Parâmetro de ID externa
|
ExtIdParam | string |
Parâmetro de ID externa. |
|
|
Parâmetro de status externo
|
ExtStatusParam | string |
Parâmetro de status externo. |
|
|
Novo Status
|
NewStatus | string |
Novo Status. |
|
|
Parâmetro de status resolvido
|
ResolvedStatus | string |
Parâmetro de status resolvido. |
|
|
Ack Status
|
AckStatus | string |
Status do Ack. |
Retornos
- Corpo
- OverviewEvent
Exclui a conta de usuário
Exclui a conta de usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário a ser excluído. |
Exclui a imagem da equipe atual
Exclui a imagem da equipe atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe da qual você deseja excluir a imagem da equipe. |
Exclui uma ação remota
Exemplo de solicitação:
DELETE /eaRemoteActions/{actionId}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da ação
|
actionId | True | string |
A ID da ação a ser excluída |
Exclui uma instância de script
Obtém a instância de script especificada pela ID da instância passada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da instância de script
|
instanceId | True | string |
ID da instância de script a ser retornada. |
Excluir agendas de dever no intervalo
Excluir agendas de dever no intervalo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe que você deseja excluir |
|
from
|
from | date-time | ||
|
para
|
to | date-time |
Retornos
- response
- array of ScheduleInfo
Excluir feriados
Excluir feriados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe da qual você deseja excluir feriados |
|
dia
|
day | integer | ||
|
month
|
month | integer |
|
|
|
ano
|
year | integer |
Excluir imagem de usuário pessoal
Excluir imagem de usuário pessoal.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário ou eu |
Excluir o modelo de texto explicativo existente de sua assinatura
Exclua o modelo de texto explicativo existente de sua assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Modelo
|
templateId | True | string |
ID do modelo. |
Excluir o número de telefone de um usuário
Exclua o número de telefone de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário |
Excluir um dever específico
Exclua um dever específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual o dever pertence. |
|
ID de Agendamento do Dever
|
dutyId | True | string |
ID do dever a ser excluído. |
Excluir um endereço de contato de um usuário
Exclua um endereço de contato de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID de usuário do qual excluir endereço |
|
ID do endereço
|
addressId | True | string |
ID do endereço de contato |
Excluir um padrão de alerta específico
Exclua um padrão de alerta específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID de equipe da equipe que você deseja acessar |
|
ID do padrão
|
patternId | True | string |
ID de padrão para o padrão que você deseja acessar |
Excluir uma categoria existente
Exemplo de solicitação:
DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual a categoria pertence |
|
ID da categoria
|
categoryId | True | string |
ID da categoria a ser excluída |
Excluir uma distribuição de eventos
Excluir uma distribuição de eventos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da origem do evento
|
distributionId | True | string |
ID da origem do evento |
Excluir uma fonte de evento
Excluir uma fonte de evento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da origem do evento
|
eventSourceId | True | string |
ID da origem do evento |
Excluir Webhook por ID
Exclui o webhook especificado para que ele não seja mais notificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Webhook de saída
|
webhookId | True | string |
Id do webhook de saída que será excluído. |
Fechar todos os alertas reconhecidos
Esse método fecha todos os alertas reconhecidos que sua equipe tem no momento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
ID de usuário do usuário a ser usado para fechar os alarmes. |
|
|
categoryIds
|
categoryIds | array of string | ||
|
maxDate
|
maxDate | date-time | ||
|
minDate
|
minDate | date-time | ||
|
escopo
|
scope | integer |
|
|
|
teamIds
|
teamIds | array of string |
Fechar um alerta
Feche um alerta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
Id para reconhecer um alerta. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retornos
- Corpo
- V2.AlertInfo
Fechar vários alertas
Esse método fecha todos os alertas fornecidos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Habilita uma instância de script
Habilita uma instância de script.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da instância de script
|
instanceId | True | string |
ID da instância a ser habilitada. |
Retornos
- Corpo
- ScriptInstanceDetails
Obtendo todos os usuários das equipes especificadas
Obtendo todos os usuários das equipes especificadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de equipe
|
teamId | array |
IDs de equipe a serem solicitadas. Se estiver vazio, você obterá todos os usuários de todas as equipes às quais você tem acesso. |
Retornos
Obter a origem do evento por id
Obter a origem do evento por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da origem do evento
|
eventSourceId | True | string |
ID da origem do evento. |
|
Linguagem
|
language | integer |
|
Retornos
- Corpo
- EventSourceEndpointInfo
Obter as configurações pré-pagas atuais da sua assinatura
Obter as configurações pré-pagas atuais de uma assinatura
Obtenha as configurações pré-pagas atuais de uma assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura |
Retornos
- Corpo
- PrepaidSettingsInfo
Obter assinaturas de categoria
Exemplo de solicitação:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual a categoria pertence |
|
ID da categoria
|
categoryId | True | string |
Categoria para obter assinaturas para |
Retornos
- response
- array of CategorySubscriptionInfo
Obter associações de equipe de um usuário
Obtenha associações de equipe de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário que você deseja acessar. |
Retornos
- response
- array of V2.TeamMembershipDetails
Obter associações de equipe por equipe
Obtenha associações de equipe por equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe que você deseja acessar. |
Retornos
- response
- array of V2.TeamMembershipDetails
Obter configurações de dever de equipe para várias equipes
Obtenha as configurações de dever de equipe para várias equipes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de equipe
|
teamId | array |
IDs de equipe. |
Retornos
Obter configurações de privacidade da equipe para uma equipe
Obtenha as configurações de privacidade da equipe para uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe |
Retornos
Obter detalhes de um evento
Obtenha detalhes de um evento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do evento
|
eventId | True | string |
ID do evento que você deseja obter |
Retornos
- Corpo
- V2.EventDetails
Obter detalhes sobre um alerta
Obtenha detalhes sobre um alerta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
Alerta que você deseja receber. |
|
ID do Usuário
|
userId | string |
ID do usuário no qual a api se comporta é chamada. Ele é usado para fins de filtragem em relação ao alerta. |
Retornos
- Corpo
- V2.AlertDetails
Obter entradas da linha do tempo do alerta
Obtenha entradas de linha do tempo de alerta de um alerta por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
ID do alerta solicitado. |
|
ID do Usuário
|
userId | string |
ID de usuário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of |
Obter evento de visão geral
Obter evento de visão geral por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do evento
|
eventId | True | string |
Id do evento a ser obtido. |
Retornos
- Corpo
- OverviewEvent
Obter feriados para a equipe
Obtenha feriados para a equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe da qual você deseja obter feriados |
Retornos
- Corpo
- V2.TeamHolidayDetails
Obter fontes de eventos de uma ou mais equipes
Obtenha fontes de eventos de uma ou mais equipes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de equipe
|
teamId | array |
IDs de equipe para obter as fontes do evento. Se você não adicionar nenhuma ID de equipe, obterá fontes de evento às quais tem acesso de sua assinatura. |
|
|
Incluir Interno
|
includeInternal | boolean |
Se o verdadeiro tipo de Fontes de Eventos internas (Sistema, Manual, API) for incluído no resultado. |
|
|
Linguagem
|
language | integer |
|
Retornos
Obter imagem de usuário pessoal
Obtenha uma imagem de usuário pessoal.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário." |
|
Altura da imagem
|
height | integer |
Altura da imagem." |
|
|
Largura da imagem
|
width | integer |
Largura da imagem." |
Retornos
- Corpo
- UserImage
Obter informações de anexo de um alerta
Obtenha anexos de um alerta por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
ID do alerta solicitado. |
Retornos
- response
- array of V2.AlertAttachmentInfo
Obter informações de todas as assinaturas gerenciadas e disponíveis
Obtenha informações de todas as assinaturas disponíveis/gerenciadas.
Retornos
- response
- array of SubscriptionInfo
Obter informações de todas as equipes
Obtenha informações de todas as equipes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de equipe
|
teamId | array |
IDs de equipe |
Retornos
- response
- array of TeamInfo
Obter informações de uma assinatura específica
Obtenha informações de uma assinatura específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura que deve ser recuperada. |
Retornos
- Corpo
- SubscriptionInfo
Obter informações do assistente de serviço para as equipes
Obtenha informações do assistente de serviço para as equipes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de equipe
|
teamId | array |
IDs das equipes para as qual obter os resumos. |
|
|
Últimos Dois Deveres
|
lastTwoDuties | boolean |
Decida se deseja todos os deveres ou apenas os dois últimos. |
Retornos
Obter informações para todas as equipes da assinatura
Obtenha informações para todas as equipes da assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura a ser atualizada |
Retornos
- response
- array of TeamInfo
Obter informações públicas sobre todas as equipes em uma assinatura
Obtenha informações públicas sobre todas as equipes em uma assinatura.
Retornos
- response
- array of V2.TeamPublicDetails
Obter informações sobre relatórios de alertas para download
Obtenha informações sobre relatórios de alertas para download.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe da qual você deseja baixar relatórios. |
Retornos
- response
- array of AlertAuditReportFileInfo
Obter métricas para todas as categorias
Exemplo de solicitação:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual as categorias pertencem |
Retornos
- response
- array of CategoryMetrics
Obter métricas para uma categoria específica
Exemplo de solicitação:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual a categoria pertence |
|
ID da categoria
|
categoryId | True | string |
ID da categoria a ser obtida |
Retornos
- Corpo
- CategoryMetrics
Obter notificações de alerta
Obtenha notificações de todos os usuários por ID de alerta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
ID do alerta solicitado. |
Retornos
- response
- array of AlertNotificationInfo
Obter o evento de visão geral paginado
Obter um evento de visão geral paginado. Se houver mais resultados, você também obterá um token de continuação que poderá ser adicionado ao filtro de eventos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
maxResults | integer |
Define o limite de detalhes de alerta recuperados por solicitação. 1 a 100 são permitidos por solicitação. O número de alertas pode ser menor se filtrado, mas pelo menos 1. |
|
|
nextPartitionKey
|
nextPartitionKey | string | ||
|
nextRowKey
|
nextRowKey | string | ||
|
nextTableName
|
nextTableName | string | ||
|
eventSourceId
|
eventSourceId | string | ||
|
eventStatusCode
|
eventStatusCode | integer |
|
|
|
maxCreationDate
|
maxCreationDate | date-time | ||
|
minCreationDate
|
minCreationDate | date-time | ||
|
modifiedSince
|
modifiedSince | date-time | ||
|
teamid
|
teamid | string | ||
|
textToSearch
|
textToSearch | string |
Retornos
Obter o saldo pré-pago atual da sua assinatura
Obter o saldo pré-pago atual de uma assinatura
Obtenha o saldo pré-pago atual de uma assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura |
Retornos
- Corpo
- PrepaidBalanceInfo
Obter o status do dever por ID do usuário
Retorna um objeto com informações de dever.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
Identificador do usuário a ser obtido. Use 'Me' para obter informações sobre o usuário conectado no momento. Isso não é possível com uma chave de api. Também pode ser um endereço de email de um usuário na equipe ou a ID exclusiva de um objeto de usuário de acordo." |
|
ID da equipe
|
teamId | array |
ID da equipe." |
Retornos
Obter parâmetros de evento
Obter parâmetros de um evento por id.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do evento
|
eventId | True | string |
ID do evento do alerta solicitado. |
Retornos
- response
- array of EventParameterInfo
Obter perfis de notificação para o usuário
Obtenha perfis de notificação para o usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
Id do usuário do qual você deseja obter os perfis de notificação. |
Retornos
Obter relatório de alerta
Retorna informações sobre o volume de alerta ocorrido em períodos de tempo diferentes, bem como informações sobre o comportamento da resposta (quantidade de alertas confirmados e sem tratamento) dos membros da equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
ID de usuário do usuário para quem você deseja um relatório. |
|
|
IDs de equipe
|
teamId | array |
IDs de equipe das equipes para as quais você deseja um relatório. Se você não definir uma ID de equipe, obterá todas as fontes de todas as equipes às quais você tem acesso. |
Retornos
Obter todas as categorias
Obtenha todas as categorias.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | array |
ID da equipe. |
Retornos
Obter todas as categorias
Exemplo de solicitação:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual as categorias pertencem |
Retornos
- response
- array of CategoryInfo
Obter todas as equipes das quais o usuário é membro
Retorna uma lista de objetos de equipe com detalhes como seu nome. Somente as equipes das quais o usuário é membro serão retornadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
userId | True | string |
ID da equipe. |
Retornos
- response
- array of TeamInfo
Obter todos os modelos de texto explicativo para sua assinatura
Obtenha todos os modelos de texto explicativo para sua assinatura.
Retornos
- response
- array of V2.CalloutTemplateDetails
Obter todos os padrões de alerta da equipe
Obtenha todos os padrões de alerta da equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID de equipe da equipe que você deseja acessar |
Retornos
- response
- array of V2.AlertingPatternDetails
Obter todos os usuários
Retorna uma lista de objetos de usuário com detalhes, como seu endereço de email e informações de dever. Somente os usuários aos quais você tem acesso serão retornados.
Retornos
- response
- array of V2.UserDetails
Obter transações pré-pagas da sua assinatura
Obtenha as transações pré-pagas da sua assinatura.
Retornos
- response
- array of PrepaidTransactionInfo
Obter transações pré-pagas de uma assinatura
Obtenha transações pré-pagas de uma assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura para obter transações para |
Retornos
- response
- array of PrepaidTransactionInfo
Obter uma categoria específica
Exemplo de solicitação:
GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe à qual a categoria pertence |
|
ID da categoria
|
categoryId | True | string |
ID da categoria a ser obtida |
Retornos
- Corpo
- CategoryInfo
Obter Usuário por ID
Retorna um objeto de usuário com detalhes como seu endereço de email e informações de dever.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
Identificador do usuário a ser obtido. Use 'Me' para obter informações sobre o usuário conectado no momento. Isso não é possível com uma chave de api. Também pode ser um endereço de email de um usuário na equipe ou a ID exclusiva de um objeto de usuário de acordo." |
Retornos
- Corpo
- V2.UserDetails
Obter Webhook por ID
Retorna informações do webhook especificado pela ID passada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Webhook de saída
|
webhookId | True | string |
ID do webhook de saída a ser recuperado. |
Retornos
- Corpo
- WebhookInfo
Obter Webhooks
Retorna uma coleção de webhooks de saída definidos no sistema.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | string |
ID da equipe. |
Retornos
- response
- array of WebhookInfo
Obtém a imagem de uma equipe especificada
Obtém a imagem de uma equipe especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
A ID da equipe da qual você deseja obter a imagem. |
|
Altura da imagem
|
height | integer |
Parâmetro opcional que define a altura desejada da imagem recuperada. |
|
|
Largura da imagem
|
width | integer |
Parâmetro opcional que define a largura desejada da imagem recuperada. |
Retornos
- Corpo
- V2.TeamImageDetails
Obtém alertas paginado
Obtém alertas paginado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
ID do usuário para o qual você deseja receber alertas. |
|
|
Limite de alerta
|
maxResults | integer |
Define o limite de detalhes de alerta recuperados por solicitação. 1 a 100 são permitidos por solicitação. O número de alertas pode ser menor se filtrado, mas pelo menos 1. |
|
|
afterId
|
afterId | string | ||
|
alertIds
|
alertIds | array of string | ||
|
alertStatusCodes
|
alertStatusCodes | integer |
|
|
|
categoryIds
|
categoryIds | array of string | ||
|
nextPartitionKey
|
nextPartitionKey | string | ||
|
nextRowKey
|
nextRowKey | string | ||
|
nextTableName
|
nextTableName | string | ||
|
ID externo
|
externalId | string | ||
|
maxCreated
|
maxCreated | date-time | ||
|
minCreated
|
minCreated | date-time | ||
|
modifiedSince
|
modifiedSince | date-time | ||
|
showPersonalHiddenCategories
|
showPersonalHiddenCategories | boolean | ||
|
teamIds
|
teamIds | array of string | ||
|
textToSearch
|
textToSearch | string |
Retornos
Obtém as configurações de alerta de uma equipe específica
Obtém as configurações de alerta de uma equipe específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | array |
ID da equipe. |
Retornos
Obtém as configurações de alerta de uma equipe específica
Obtém as configurações de alerta de uma equipe específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe para a qual as configurações devem ser recuperadas. |
Retornos
- Corpo
- AlertSettings
Obtém as licenças de número de voz de uma assinatura
Obtém as licenças de número de voz de uma assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura |
Retornos
- Corpo
- UserLicenseInfo
Obtém as licenças de usuário de uma assinatura
Obtém as licenças de usuário de uma assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura |
Retornos
- Corpo
- UserLicenseInfo
Obtém fontes de eventos de uma equipe específica
Obtém fontes de eventos de uma equipe específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe para a qual as fontes devem ser recuperadas. |
Retornos
- response
- array of EventSourceEndpointInfo
Obtém informações de uma equipe específica
Obtém informações de uma equipe específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe que deve ser recuperada. |
Retornos
- Corpo
- TeamInfo
Obtém o progresso da instalação de um usuário específico
Obtém o progresso da instalação de um usuário específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário para o qual o progresso deve ser recuperado. |
Retornos
- Corpo
- UserSetupProgress
Obtém o progresso da instalação de uma equipe específica
Obtém o progresso da instalação de uma equipe específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe para a qual o progresso deve ser recuperado. |
Retornos
- Corpo
- TeamSetupProgress
Obtém os nomes de todas as imagens de categoria de alerta
Obtém os nomes de todas as imagens de categoria de alerta. Você pode obter a imagem acessando account.signl4.com/images/alerts/categoryImageName.svg.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of string |
Obtém um anexo especificado de um alerta especificado
Obtém um anexo especificado de um alerta especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
ID do alerta que contém o anexo desejado. |
|
ID do anexo
|
attachmentId | True | string |
Id do anexo que você deseja recuperar. |
|
Largura da imagem
|
width | integer |
Parâmetro opcional que define a largura desejada da imagem recuperada. |
|
|
Altura da imagem
|
height | integer |
Parâmetro opcional que define a altura desejada da imagem recuperada. |
|
|
Scale
|
scale | boolean |
Parâmetro opcional que define se ele deseja dimensionar a imagem recuperada. O padrão é definido como true. |
Retornos
- response
- binary
Receba um alerta
Obtém um alerta por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
ID do alerta solicitado. |
|
ID do Usuário
|
userId | string |
ID de usuário. |
Retornos
- Corpo
- V2.AlertInfo
Reconhecer um alerta
Confirme um alerta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do alerta
|
alertId | True | string |
Id para reconhecer um alerta. |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retornos
- Corpo
- V2.AlertInfo
Recuperar todas as definições disponíveis
Recupere todas as definições disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Linguagem
|
language | integer |
|
Retornos
Recuperar uma definição
Recupere uma definição.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de definição
|
definitionId | True | string |
ID de definição |
|
Linguagem
|
language | integer |
|
Retornos
Remove um usuário ou convite de uma equipe
Remove um usuário ou convite de uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe da qual o usuário deve ser excluído |
|
ID do Usuário
|
userId | True | string |
ID do usuário que deve ser excluído |
|
ID do Usuário
|
requesterUserId | string |
ID do usuário que removerá o outro usuário. |
Retirar o fechamento de vários alertas
Esse método tenta desfazer vários fechamentos de alerta. A operação é tratada em segundo plano.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
alertIds
|
alertIds | True | array of string | |
|
descr
|
descr | string | ||
|
uid
|
uid | True | string |
Retorna as informações de preço do canal da assinatura
Retorna as informações de preço do canal da assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura que precisa ser recuperada. |
Retornos
- Corpo
- ChannelPriceInfo
Retorna ações remotas
Exemplo de solicitação:
GET /RemoteActions?externalId=12345
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | string |
ID da equipe |
|
|
ID externa
|
externalId | string |
Filtro opcional para id externa |
|
|
Tipo
|
type | integer |
|
|
|
Serviço executor
|
executorService | string |
Serviço executor |
|
|
Linguagem
|
language | integer |
|
Retornos
- response
- array of V2.RemoteActionInfo
Retorna informações do agendamento do dever com a ID especificada
Retorna informações do agendamento do dever com a ID especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
Id da equipe à qual o dever pertence |
|
ID de Agendamento do Dever
|
scheduleId | True | string |
ID do agendamento de dever solicitado. |
Retornos
- Corpo
- ScheduleInfo
Retorna informações sobre todos os agendamentos planejados
Retorna informações sobre todos os agendamentos planejados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | integer | ||
|
minDate
|
minDate | date-time | ||
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | string |
Retornos
- response
- array of V2.ScheduleDetails
Retorna o Relatório de Alertas
Retorna o Relatório de Alertas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe para a qual você deseja obter as informações do arquivo de relatório de serviço. |
|
Nome do Arquivo
|
fileName | True | string |
Nome do arquivo que você deseja baixar. |
Retornos
- response
- binary
Retorna os recursos de uma assinatura especificada
Retorna os recursos de uma assinatura especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da assinatura
|
subscriptionId | True | string |
ID da assinatura da qual os recursos precisam ser recuperados. |
Retornos
- response
- array of SubscriptionFeature
Retorna todas as informações sobre uma determinada instância de script
Obtém a instância de script especificada pela ID da instância passada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da instância de script
|
instanceId | True | string |
ID da instância de script a ser retornada. |
Retornos
- Corpo
- ScriptInstanceDetails
Retorna todas as instâncias de script da equipe SIGNL4
Retorna todas as instâncias de script na assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de equipe
|
teamId | array |
IDs de equipe. |
|
|
Modificado desde
|
modifiedSince | date-time |
Modificado desde então. |
Retornos
- response
- array of ScriptInstanceInfo
Retorna todos os scripts de inventário
Retorna todos os scripts de inventário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Linguagem
|
language | string |
Linguagem |
Retornos
- response
- array of InventoryScriptInfo
Retorna todos os scripts de inventário disponíveis
Retorna todos os scripts de inventário disponíveis que podem ser adicionados a uma assinatura SIGNL4.
Retornos
- response
- array of InventoryScriptInfo
Retorna trabalhos remotos paginado do Diário
Exemplo de solicitação:
POST /remoteActions/journal/paged?maxResults=100
{
"statusCode": "Executed"
}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Resultados Máximos
|
maxResults | integer |
Resultados Máximos |
|
|
Linguagem
|
language | integer |
|
|
|
actionId
|
actionId | string | ||
|
continuationToken
|
continuationToken | string | ||
|
maxCreationDate
|
maxCreationDate | date-time | ||
|
minCreationDate
|
minCreationDate | date-time | ||
|
modifiedSince
|
modifiedSince | date-time | ||
|
códigos de status
|
statusCodes | integer |
|
Retornos
Retorna um script de inventário por sua ID
Obtém o script especificado pela ID de script passada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Script ID
|
scriptId | True | string |
A ID do script a ser retornado. |
|
Linguagem
|
language | string |
Linguagem |
Retornos
- Corpo
- ScriptInstanceDetails
Retorna um trabalho remoto do Diário
Exemplo de solicitação:
GET /remoteActions/journal/{jobId}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | string |
A ID do trabalho a ser retornado |
|
Linguagem
|
language | integer |
|
Retornos
- Corpo
- V2.RemoteJob
Retorna uma ação remota
Exemplo de solicitação:
GET /RemoteActions/{actionId}
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da ação
|
actionId | True | string |
A ID da ação a ser retornada |
|
Linguagem
|
language | integer |
|
Retornos
- Corpo
- V2.RemoteActionDetails
Salvar feriados para uma equipe
Salve feriados para uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID de equipe da equipe para a qual você deseja salvar feriados |
|
Ano
|
year | True | integer |
Ano em que você deseja salvar feriados para |
|
dia
|
day | integer | ||
|
month
|
month | integer |
|
Retornos
- Corpo
- V2.TeamHolidayDetails
Salvar feriados repetidos para uma equipe
Salve feriados repetidos para uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID de equipe da equipe para a qual você deseja salvar feriados |
|
dia
|
day | integer | ||
|
month
|
month | integer |
|
Retornos
- Corpo
- V2.TeamHolidayDetails
Salvar vários agendamentos
Salve vários agendamentos. Se desejar, é possível substituir os agendamentos existentes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe a ser definida |
|
Override
|
overrideExisting | boolean |
Substitua ou corte os agendamentos existentes se definido como true. |
|
|
término
|
end | date-time | ||
|
id
|
id | string | ||
|
opções
|
options | integer | ||
|
start
|
start | date-time | ||
|
userId
|
userId | string |
Retornos
- response
- array of ScheduleInfo
Socar o usuário
O usuário especificado será socado para o dever.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | True | string |
Retornos
Socar o usuário como Gerente
O usuário especificado será socado como um gerente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | True | string |
Retornos
Socar o usuário para fora
O usuário especificado será retirado do serviço.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
teamIds
|
teamIds | array of string | ||
|
userId
|
userId | True | string |
Retornos
Valida um número de telefone criado anteriormente para um usuário
Valida um número de telefone criado anteriormente para um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID de usuário do usuário que você deseja validar o número de telefone criado anteriormente |
|
número de telefone
|
phoneNumber | string | ||
|
validationCode
|
validationCode | string |
Validar um intervalo de tempo de um padrão
Valide um intervalo de tempo de um padrão em relação a todos os slots de tempo existentes de outros padrões.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
teamId | True | string |
ID da equipe do padrão de alertas |
|
ID do padrão
|
patternId | string |
Alertando a ID do padrão para o qual você deseja economizar intervalos de tempo. Pode ser nulo |
|
|
IDs de categoria
|
categoryIds | array |
IDs de categoria do padrão que você deseja validar. Pode ser nulo. |
|
|
hora
|
hour | integer | ||
|
minutes
|
minutes | integer | ||
|
Semana
|
weekday | integer |
|
|
|
id
|
id | string |
Retornos
Verifica se um usuário tem a permissão fornecida
Verifica se um usuário tem a permissão fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
ID do usuário para o qual verificar as permissões. |
|
permissões
|
permissions | array of string | ||
|
teamIds
|
teamIds | array of string |
Retornos
Definições
AlertAuditReportFileInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
fileSizeInBytes
|
fileSizeInBytes | integer | |
|
lastRecord
|
lastRecord | date-time | |
|
última atualização
|
lastUpdated | date-time | |
|
month
|
month | integer | |
|
ano
|
year | integer |
AlertEscalationModes
AlertFilterActions
AlertFilterModes
AlertNotificationInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
address
|
address | string | |
|
deviceName
|
deviceName | string | |
|
lastUpdate
|
lastUpdate | date-time | |
|
messageStatus
|
messageStatus | AlertNotificationInfoMessageStatus |
|
|
messageStatusErrorCode
|
messageStatusErrorCode | integer | |
|
notificationChannelType
|
notificationChannelType | AlertNotificationInfoChannelType |
|
|
userId
|
userId | string | |
|
userStatus
|
userStatus | AlertNotificationInfoUserStatus |
|
AlertNotificationInfoChannelType
- 0 = nenhum
- 1 = Push
- 2 = Email
- 4 = Bot
- 8 = Voz
- 16 = SMS
- 0 = nenhum
- 1 = Push
- 2 = Email
- 4 = Bot
- 8 = Voz
- 16 = SMS
AlertNotificationInfoMessageStatus
- 0 = nenhum
- 1 = Rejeitado
- 2 = Falha
- 3 = Enfileirado
- 4 = Transmitido
- 5 = Buffer
- 6 = Entregue
- 7 = Cancelado
- 8 = Protegido
- 9 = AbuseProtected
- 10 = Atrasado
- 0 = nenhum
- 1 = Rejeitado
- 2 = Falha
- 3 = Enfileirado
- 4 = Transmitido
- 5 = Buffer
- 6 = Entregue
- 7 = Cancelado
- 8 = Protegido
- 9 = AbuseProtected
- 10 = Atrasado
AlertNotificationInfoUserStatus
- 0 = nenhum
- 1 = MessageCreated
- 2 = NotOnDuty
- 3 = CategoryHidden
- 4 = CategoryMuted
- 5 = NoNotificationProfiles
- 6 = NoMessagesByNotificationProfiles
- 0 = nenhum
- 1 = MessageCreated
- 2 = NotOnDuty
- 3 = CategoryHidden
- 4 = CategoryMuted
- 5 = NoNotificationProfiles
- 6 = NoMessagesByNotificationProfiles
AlertResponseModes
AlertSettings
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
escEnabled
|
escEnabled | boolean | |
|
escMode
|
escMode | AlertEscalationModes |
|
|
escRefId
|
escRefId | string | |
|
filterAction
|
filterAction | AlertFilterActions |
|
|
filterMode
|
filterMode | AlertFilterModes |
|
|
notificationProfileOverrides
|
notificationProfileOverrides | array of AlertSettingsNotificationProfile | |
|
optOut
|
optOut | TeamCategoryOptOutModes |
|
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | |
|
persNotInterval
|
persNotInterval | integer | |
|
persNotMode
|
persNotMode | PersistentNotificationModes |
|
|
responseMode
|
responseMode | AlertResponseModes |
|
|
responseTime
|
responseTime | integer |
AlertSettingsChannelType
AlertSettingsNotificationProfile
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
canal
|
channel | AlertSettingsChannelType |
|
|
atraso
|
delay | integer | |
|
enabled
|
enabled | boolean |
CategoryAugmentation
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
tipo
|
type | CategoryAugmentationType |
|
|
value
|
value | string |
CategoryAugmentationType
- 0 = Parâmetro
- 1 = Assunto
- 2 = Texto
- 3 = Localização
- 0 = Parâmetro
- 1 = Assunto
- 2 = Texto
- 3 = Localização
CategoryEnrichment
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
tipo
|
type | CategoryEnrichmentType |
|
|
value
|
value | string |
CategoryEnrichmentType
CategoryInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
augmentations
|
augmentations | array of CategoryAugmentation | |
|
color
|
color | string | |
|
enriquecimentos
|
enrichments | array of CategoryEnrichment | |
|
id
|
id | string | |
|
nome_da_imagem
|
imageName | string | |
|
isDefault
|
isDefault | boolean | |
|
keywordMatching
|
keywordMatching | KeywordMatchingType |
|
|
Palavras-chave
|
keywords | array of string | |
|
palavras-chaveExcluded
|
keywordsExcluded | array of string | |
|
nome
|
name | string | |
|
opções
|
options | CategoryInfoOptions |
|
|
ordem
|
order | integer | |
|
teamId
|
teamId | string |
CategoryInfoOptions
- 0 = nenhum
- 1 = Oculto
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
- 0 = nenhum
- 1 = Oculto
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
CategoryMetrics
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categoryId
|
categoryId | string | |
|
last24h
|
last24h | integer | |
|
lastAlert
|
lastAlert | date-time | |
|
subscriberCount
|
subscriberCount | integer |
CategorySubscriptionInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | CategorySubscriptionStatus |
|
|
userId
|
userId | string |
CategorySubscriptionStatus
ChannelPriceInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
mensagem de texto
|
sms | integer | |
|
voicePerMinute
|
voicePerMinute | integer |
DutySummaryInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dutyEnd
|
dutyEnd | date-time | |
|
dutyId
|
dutyId | string | |
|
dutyStart
|
dutyStart | date-time |
EventParameterInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
ordem
|
order | integer | |
|
tipo
|
type | EventParameterTypes |
|
|
value
|
value | string |
EventParameterTypes
- 0 = nenhum
- 1 = Objeto
- 2 = Matriz
- 3 = Construtor
- 4 = Propriedade
- 5 = Comentário
- 6 = Inteiro
- 7 = Float
- 8 = Cadeia de caracteres
- 9 = Boolean
- 10 = Nulo
- 11 = Indefinido
- 12 = Data
- 13 = Bruto
- 14 = Bytes
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
- 0 = nenhum
- 1 = Objeto
- 2 = Matriz
- 3 = Construtor
- 4 = Propriedade
- 5 = Comentário
- 6 = Inteiro
- 7 = Float
- 8 = Cadeia de caracteres
- 9 = Boolean
- 10 = Nulo
- 11 = Indefinido
- 12 = Data
- 13 = Bruto
- 14 = Bytes
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
EventSeverities
EventSourceEndpointInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
address
|
address | string | |
|
descrição
|
description | string | |
|
desabilitado
|
disabled | boolean | |
|
groupId
|
groupId | string | |
|
id
|
id | string | |
|
lastEvent
|
lastEvent | date-time | |
|
nome
|
name | string | |
|
subType
|
subType | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
tipo
|
type | EventSourceTypes |
|
EventSourceTypes
- 0 = nenhum
- 1 = Email
- 2 = WebHook
- 3 = Script
- 4 = Sistema
- 5 = Manual
- 6 = Voz
- 7 = API
- 0 = nenhum
- 1 = Email
- 2 = WebHook
- 3 = Script
- 4 = Sistema
- 5 = Manual
- 6 = Voz
- 7 = API
EventStatusCodes
- 0 = nenhum
- 1 = Processamento
- 2 = Signled
- 3 = Filtrado
- 4 = Resolvido
- 5 = Descartado
- 6 = Reconhecido
- 7 = Suprimido
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Erro
- 0 = nenhum
- 1 = Processamento
- 2 = Signled
- 3 = Filtrado
- 4 = Resolvido
- 5 = Descartado
- 6 = Reconhecido
- 7 = Suprimido
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Erro
InventoryScriptInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
config
|
config | ||
|
dados
|
data | ScriptDescriptionData | |
|
padrão de evento
|
eventPattern | ||
|
localizationDetails
|
localizationDetails | array of ScriptLocalizationDetail | |
|
scriptId
|
scriptId | string | |
|
scriptName
|
scriptName | string | |
|
visibilidade
|
visibility | string |
KeywordMatchingType
LocationInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
latitude
|
latitude | double | |
|
longitude
|
longitude | double | |
|
carimbo de data/hora
|
timestamp | date-time |
MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of EventSourceEndpointInfo | |
|
Erros
|
errors | array of V2.EventSourceEndpointError |
MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of TeamDutySummaryInfo | |
|
Erros
|
errors | array of V2.TeamDutySummaryError |
MultiTeamResult-2-UserDutyInfo-V2.DutyError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of UserDutyInfo | |
|
Erros
|
errors | array of V2.DutyError |
MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of V2.AlertCountsDetails | |
|
Erros
|
errors | array of V2.AlertReportError |
MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of V2.AlertSettingsDetails | |
|
Erros
|
errors | array of V2.AlertSettingsError |
MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of V2.CategoryDetails | |
|
Erros
|
errors | array of V2.CategoryError |
MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of V2.TeamDutySettingsDetails | |
|
Erros
|
errors | array of V2.TeamDutySettingsError |
MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of V2.TeamPermissions | |
|
Erros
|
errors | array of V2.PermissionError |
MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of V2.UserDetails | |
|
Erros
|
errors | array of V2.TeamUserError |
MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of V2.UserDutyDetails | |
|
Erros
|
errors | array of V2.DutyChangeError |
OverviewEvent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
acknowledgedAlerts
|
acknowledgedAlerts | array of string | |
|
alertId
|
alertId | string | |
|
categoryId
|
categoryId | string | |
|
closedAlerts
|
closedAlerts | array of string | |
|
tempoDeCriação
|
creationTime | date-time | |
|
eventSourceGroupId
|
eventSourceGroupId | string | |
|
eventSourceId
|
eventSourceId | string | |
|
eventSourceTeamId
|
eventSourceTeamId | string | |
|
eventSourceType
|
eventSourceType | EventSourceTypes |
|
|
eventStatus
|
eventStatus | EventStatusCodes |
|
|
id
|
id | string | |
|
últimaModificação
|
lastModified | date-time | |
|
severidade
|
severity | EventSeverities |
|
|
teamId
|
teamId | string | |
|
enviar SMS
|
text | string | |
|
title
|
title | string |
PagedResultsPublicContinuationToken
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nextPartitionKey
|
nextPartitionKey | string | |
|
nextRowKey
|
nextRowKey | string | |
|
nextTableName
|
nextTableName | string |
PagedResultsPublic-1-OverviewEvent-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
continuationToken
|
continuationToken | PagedResultsPublicContinuationToken | |
|
hasMore
|
hasMore | boolean | |
|
results
|
results | array of OverviewEvent |
PagedResultsPublic-1-V2.AlertInfo-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
continuationToken
|
continuationToken | PagedResultsPublicContinuationToken | |
|
hasMore
|
hasMore | boolean | |
|
results
|
results | array of V2.AlertInfo |
PagedResultsPublic-1-V2.RemoteJob-
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
continuationToken
|
continuationToken | PagedResultsPublicContinuationToken | |
|
hasMore
|
hasMore | boolean | |
|
results
|
results | array of V2.RemoteJob |
PersistentNotificationModes
Pré-paidBalanceInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
saldo
|
balance | integer | |
|
latestTopUp
|
latestTopUp | date-time | |
|
pendingTransactions
|
pendingTransactions | boolean |
Pré-paidSettingsInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
topUpAmount
|
topUpAmount | integer | |
|
topUpEnabled
|
topUpEnabled | boolean | |
|
topUpLimit
|
topUpLimit | integer |
PrepaidTransactionInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
quantidade
|
amount | integer | |
|
autoTopUpId
|
autoTopUpId | string | |
|
criadas
|
created | date-time | |
|
createdBy
|
createdBy | string | |
|
moeda
|
currency | string | |
|
modified
|
modified | date-time | |
|
packageCode
|
packageCode | string | |
|
status
|
status | string | |
|
código de status
|
statusCode | integer | |
|
subscriptionId
|
subscriptionId | string | |
|
ID da transação
|
transactionId | string |
ScheduleInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
término
|
end | date-time | |
|
id
|
id | string | |
|
opções
|
options | integer | |
|
start
|
start | date-time | |
|
userId
|
userId | string |
ScriptDescriptionData
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
description | string | |
|
nome
|
name | string | |
|
scriptType
|
scriptType | string | |
|
Descrição Curta
|
shortDescription | string |
ScriptInstanceDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
config
|
config | ||
|
customScriptDescription
|
customScriptDescription | string | |
|
customScriptName
|
customScriptName | string | |
|
enabled
|
enabled | boolean | |
|
padrão de evento
|
eventPattern | ||
|
eventSourceId
|
eventSourceId | string | |
|
instanceId
|
instanceId | string | |
|
últimaModificação
|
lastModified | date-time | |
|
runtimeInformation
|
runtimeInformation | ScriptInstanceInfoRuntimeInformationModel | |
|
scriptId
|
scriptId | string | |
|
scriptName
|
scriptName | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
webhookUrl
|
webhookUrl | string |
ScriptInstanceInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
customScriptDescription
|
customScriptDescription | string | |
|
customScriptName
|
customScriptName | string | |
|
enabled
|
enabled | boolean | |
|
padrão de evento
|
eventPattern | ||
|
eventSourceId
|
eventSourceId | string | |
|
instanceId
|
instanceId | string | |
|
últimaModificação
|
lastModified | date-time | |
|
runtimeInformation
|
runtimeInformation | ScriptInstanceInfoRuntimeInformationModel | |
|
scriptId
|
scriptId | string | |
|
scriptName
|
scriptName | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string |
ScriptInstanceInfoRuntimeInformationModel
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
runtimeStatus
|
runtimeStatus | ScriptInstanceInfoRuntimeStatus |
|
|
runtimeStatusMessage
|
runtimeStatusMessage | string |
ScriptInstanceInfoRuntimeStatus
- 0 = Desconhecido
- 1 = Iniciando
- 2 = OK
- 3 = Parar
- 4 = Parado
- -1 = Erro
- 0 = Desconhecido
- 1 = Iniciando
- 2 = OK
- 3 = Parar
- 4 = Parado
- -1 = Erro
ScriptLocalizationDetail
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
config
|
config | ||
|
dados
|
data | ScriptDescriptionData | |
|
linguagem
|
language | string |
SubscriptionFeature
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
tipo
|
type | integer | |
|
value
|
value | string |
SubscriptionInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da filial
|
branchId | string | |
|
country
|
country | string | |
|
moeda
|
currency | string | |
|
externalAccountId
|
externalAccountId | string | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
nextBilling
|
nextBilling | date-time | |
|
ID do proprietário
|
ownerId | string | |
|
planCode
|
planCode | string | |
|
planState
|
planState | integer | |
|
referralEnabled
|
referralEnabled | boolean | |
|
status
|
status | integer |
TeamCategoryOptOutModes
TeamDutySummaryInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dutyAssistEnabled
|
dutyAssistEnabled | boolean | |
|
dutySummaries
|
dutySummaries | array of DutySummaryInfo | |
|
teamId
|
teamId | string |
TeamInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
imageLastModified
|
imageLastModified | date-time | |
|
memberIds
|
memberIds | array of string | |
|
nome
|
name | string | |
|
setupProgressEnabled
|
setupProgressEnabled | boolean | |
|
subscriptionId
|
subscriptionId | string | |
|
timezone
|
timezone | string |
TeamSetupProgress
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
completedSteps
|
completedSteps | array of string | |
|
teamId
|
teamId | string | |
|
carimbo de data/hora
|
timestamp | date-time |
UserDutyInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
lastChange
|
lastChange | date-time | |
|
onDuty
|
onDuty | boolean | |
|
onManagerDuty
|
onManagerDuty | boolean | |
|
em atraso
|
overdue | boolean | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
UserImage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | byte | |
|
contentDispostion
|
contentDispostion | string | |
|
contentEncoding
|
contentEncoding | string | |
|
tipo de conteúdo
|
contentType | string | |
|
últimaModificação
|
lastModified | date-time | |
|
nome
|
name | string |
Informações do usuário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
colorIndex
|
colorIndex | integer | |
|
contactAddresses
|
contactAddresses | array of | |
|
dutyInfos
|
dutyInfos | UserDutyInfo | |
|
externalAuthProvider
|
externalAuthProvider | string | |
|
id
|
id | string | |
|
isDeactivated
|
isDeactivated | boolean | |
|
isInvite
|
isInvite | boolean | |
|
isRemoteActionPinSet
|
isRemoteActionPinSet | boolean | |
|
lastSeen
|
lastSeen | date-time | |
|
email
|
string | ||
|
nome
|
name | string | |
|
roleId
|
roleId | string | |
|
subscriptionId
|
subscriptionId | string | |
|
Fuso horário
|
timeZone | string | |
|
userImageLastModified
|
userImageLastModified | date-time |
UserLicenseInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
currentUsers
|
currentUsers | integer | |
|
isFree
|
isFree | boolean | |
|
isTrial
|
isTrial | boolean | |
|
licensedUsers
|
licensedUsers | integer | |
|
planCode
|
planCode | string |
UserPermission
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
permitido
|
allowed | boolean | |
|
permissão
|
permission | string |
UserSetupProgress
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
completedSteps
|
completedSteps | array of string | |
|
carimbo de data/hora
|
timestamp | date-time | |
|
userId
|
userId | string |
V2. AlertAnnotationDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
teamId
|
teamId | string | |
|
enviar SMS
|
text | string | |
|
carimbo de data/hora
|
timestamp | date-time | |
|
tipo
|
type | V2.AlertAnnotationTypes |
|
|
userId
|
userId | string |
V2. AlertAnnotationTypes
V2. AlertAttachmentInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo de conteúdo
|
contentType | string | |
|
id
|
id | string | |
|
nome
|
name | string |
V2. AlertCategoryCountsDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Reconhecido
|
acknowledged | integer | |
|
categoryId
|
categoryId | string | |
|
fechado
|
closed | integer | |
|
Unhandled
|
unhandled | integer |
V2. AlertCountTypes
- 1 = TeamCurrentDuty
- 2 = TeamLastDuty
- 3 = UserLastDutyChange
- 4 = Last24Hours
- 1 = TeamCurrentDuty
- 2 = TeamLastDuty
- 3 = UserLastDutyChange
- 4 = Last24Hours
V2. AlertCountsDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Reconhecido
|
acknowledged | integer | |
|
categoryCounts
|
categoryCounts | array of V2.AlertCategoryCountsDetails | |
|
fechado
|
closed | integer | |
|
término
|
end | date-time | |
|
últimaModificação
|
lastModified | date-time | |
|
start
|
start | date-time | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
tipo
|
type | V2.AlertCountTypes |
|
|
typeString
|
typeString | string | |
|
Unhandled
|
unhandled | integer | |
|
userId
|
userId | string |
V2. AlertDeliveryStatusCodes
- 0 = nenhum
- 1 = Abrir
- 2 = Falha
- 4 = Transmitido
- 6 = Entregue
- 8 = Protegido
- 9 = AbuseProtected
- 22 = Falha parcial
- 24 = PartlyTransmitted
- 26 = Parcialmente Entregue
- 30 = NoOneOnDuty
- 31 = NoOneNotified
- 0 = nenhum
- 1 = Abrir
- 2 = Falha
- 4 = Transmitido
- 6 = Entregue
- 8 = Protegido
- 9 = AbuseProtected
- 22 = Falha parcial
- 24 = PartlyTransmitted
- 26 = Parcialmente Entregue
- 30 = NoOneOnDuty
- 31 = NoOneNotified
V2. AlertDeliveryStatusDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
alertId
|
alertId | string | |
|
código de status
|
statusCode | V2.AlertDeliveryStatusCodes |
|
|
userDeliveryStatus
|
userDeliveryStatus | array of V2.UserDeliveryStatus |
V2. AlertDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.EventParameterDetails | |
|
attachments
|
attachments | array of V2.AlertAttachmentInfo | |
|
categoryId
|
categoryId | string | |
|
Escalações
|
escalations | array of V2.AlertEscalationDetails | |
|
eventId
|
eventId | string | |
|
ID externo
|
externalId | string | |
|
Sinalizadores
|
flags | V2.AlertFlags |
|
|
histórico
|
history | V2.AlertHistoryInfo | |
|
id
|
id | string | |
|
últimaModificação
|
lastModified | date-time | |
|
requiredAcknowledgements
|
requiredAcknowledgements | integer | |
|
severidade
|
severity | V2.AlertSeverities |
|
|
status
|
status | V2.AlertStatusDetails | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
enviar SMS
|
text | string | |
|
timelineEntries
|
timelineEntries | array of | |
|
title
|
title | string | |
|
workflowType
|
workflowType | V2.AlertWorkflowTypes |
|
V2. AlertEscalationDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
alertId
|
alertId | string | |
|
alertStatus
|
alertStatus | V2.AlertStatusCodes |
|
|
escType
|
escType | V2.AlertEscalationType |
|
|
status
|
status | V2.AlertEscalationStatus |
|
|
teamId
|
teamId | string | |
|
teamName
|
teamName | string | |
|
carimbo de data/hora
|
timestamp | date-time |
V2. AlertEscalationStatus
- 0 = Ok
- 1 = InProgress
- 2 = TargetInvalid
- 3 = TargetPrivate
- 4 = Filtrado
- 5 = Suprimido
- 0 = Ok
- 1 = InProgress
- 2 = TargetInvalid
- 3 = TargetPrivate
- 4 = Filtrado
- 5 = Suprimido
V2. AlertEscalationType
V2. AlertFlags
- 0 = nenhum
- 1 = HasAttachments
- 2 = HasAnnotations
- 4 = IsBreached
- 8 = HasLocationInfo
- 16 = EscalatedToTeam
- 32 = EscalatedToManager
- 64 = CreatedByEscalation
- 0 = nenhum
- 1 = HasAttachments
- 2 = HasAnnotations
- 4 = IsBreached
- 8 = HasLocationInfo
- 16 = EscalatedToTeam
- 32 = EscalatedToManager
- 64 = CreatedByEscalation
V2. AlertHistoryInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
acknowledgedAt
|
acknowledgedAt | date-time | |
|
Agradecimentos
|
acknowledgements | array of string | |
|
closedAt
|
closedAt | date-time | |
|
closedBy
|
closedBy | string | |
|
criadas
|
created | date-time |
V2. AlertInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categoryId
|
categoryId | string | |
|
eventId
|
eventId | string | |
|
ID externo
|
externalId | string | |
|
Sinalizadores
|
flags | V2.AlertFlags |
|
|
histórico
|
history | V2.AlertHistoryInfo | |
|
id
|
id | string | |
|
últimaModificação
|
lastModified | date-time | |
|
requiredAcknowledgements
|
requiredAcknowledgements | integer | |
|
severidade
|
severity | V2.AlertSeverities |
|
|
status
|
status | V2.AlertStatusDetails | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
enviar SMS
|
text | string | |
|
title
|
title | string | |
|
workflowType
|
workflowType | V2.AlertWorkflowTypes |
|
V2. AlertReportError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. AlertSettingsChannelType
V2. AlertSettingsDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
escEnabled
|
escEnabled | boolean | |
|
escMode
|
escMode | AlertEscalationModes |
|
|
escRefId
|
escRefId | string | |
|
filterAction
|
filterAction | AlertFilterActions |
|
|
filterMode
|
filterMode | AlertFilterModes |
|
|
notificationProfileOverrides
|
notificationProfileOverrides | array of V2.AlertSettingsNotificationProfileDetails | |
|
optOut
|
optOut | TeamCategoryOptOutModes |
|
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | |
|
persNotInterval
|
persNotInterval | integer | |
|
persNotMode
|
persNotMode | PersistentNotificationModes |
|
|
responseMode
|
responseMode | AlertResponseModes |
|
|
responseTime
|
responseTime | integer | |
|
teamId
|
teamId | string |
V2. AlertSettingsError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. AlertSettingsNotificationProfileDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
canal
|
channel | V2.AlertSettingsChannelType |
|
|
atrasoemminutos
|
delayInMinutes | integer | |
|
enabled
|
enabled | boolean |
V2. AlertSeverities
V2. AlertStatusCodes
- 0 = nenhum
- 1 = Abrir
- 2 = Reconhecido
- 4 = Fechado
- 8 = NoReply
- 16 = Falha
- 32 = Erro
- 0 = nenhum
- 1 = Abrir
- 2 = Reconhecido
- 4 = Fechado
- 8 = NoReply
- 16 = Falha
- 32 = Erro
V2. AlertStatusDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
alertDeliveryStatus
|
alertDeliveryStatus | V2.AlertDeliveryStatusDetails | |
|
código de status
|
statusCode | V2.AlertStatusCodes |
|
V2. AlertWorkflowTypes
- 0 = nenhum
- 1 = Usuário
- 2 = TeamBroadcast
- 3 = TeamEscalation
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
- 0 = nenhum
- 1 = Usuário
- 2 = TeamBroadcast
- 3 = TeamEscalation
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
V2. AlertingPatternChannelType
V2. AlertingPatternDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categories
|
categories | array of string | |
|
escalationSettings
|
escalationSettings | V2.AlertingPatternEscalationSettings | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
notificationProfileOverrides
|
notificationProfileOverrides | array of V2.AlertingPatternNotificationProfileDetails | |
|
overrideEscalationSettings
|
overrideEscalationSettings | boolean | |
|
overrideNotificationProfiles
|
overrideNotificationProfiles | boolean | |
|
overrideResponseSettings
|
overrideResponseSettings | boolean | |
|
responseSettings
|
responseSettings | V2.AlertingPatternResponseSettings | |
|
suppressSignl
|
suppressSignl | boolean | |
|
timeSlots
|
timeSlots | array of V2.TimeSlotDetails |
V2. AlertingPatternEscalationSettings
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
mode
|
mode | AlertEscalationModes |
|
|
referenceId
|
referenceId | string |
V2. AlertingPatternNotificationProfileDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
canal
|
channel | V2.AlertingPatternChannelType |
|
|
atrasoemminutos
|
delayInMinutes | integer | |
|
enabled
|
enabled | boolean |
V2. AlertingPatternResponseSettings
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
responseMode
|
responseMode | AlertResponseModes |
|
|
responseTime
|
responseTime | integer |
V2. CalloutTemplateDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
categoryId
|
categoryId | string | |
|
ID externo
|
externalId | string | |
|
id
|
id | string | |
|
local
|
location | string | |
|
nome
|
name | string | |
|
assunto
|
subject | string | |
|
targetAllTeams
|
targetAllTeams | boolean | |
|
targetTeamId
|
targetTeamId | string | |
|
enviar SMS
|
text | string | |
|
workflowType
|
workflowType | V2.CalloutTemplateWorkflowType |
|
V2. CalloutTemplateWorkflowType
- 0 = AsConfiguredInTeam
- 2 = TeamBroadcast
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
- 0 = AsConfiguredInTeam
- 2 = TeamBroadcast
- 4 = MultiAcknowledge
- 5 = MultiAcknowledgeEmergency
V2. CategoryAugmentationDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
tipo
|
type | V2.CategoryAugmentationType |
|
|
value
|
value | string |
V2. CategoryAugmentationType
- 0 = Parâmetro
- 1 = Assunto
- 2 = Texto
- 3 = Localização
- 0 = Parâmetro
- 1 = Assunto
- 2 = Texto
- 3 = Localização
V2. CategoryDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
augmentations
|
augmentations | array of V2.CategoryAugmentationDetails | |
|
color
|
color | string | |
|
enriquecimentos
|
enrichments | array of V2.CategoryEnrichmentDetails | |
|
id
|
id | string | |
|
nome_da_imagem
|
imageName | string | |
|
isDefault
|
isDefault | boolean | |
|
keywordMatching
|
keywordMatching | V2.KeywordMatchingType |
|
|
Palavras-chave
|
keywords | array of string | |
|
palavras-chaveExcluded
|
keywordsExcluded | array of string | |
|
nome
|
name | string | |
|
opções
|
options | V2.CategoryOptions |
|
|
ordem
|
order | integer | |
|
teamId
|
teamId | string |
V2. CategoryEnrichmentDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
tipo
|
type | V2.CategoryEnrichmentType |
|
|
value
|
value | string |
V2. CategoryEnrichmentType
V2. CategoryError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. CategoryOptions
- 0 = nenhum
- 1 = Oculto
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
- 0 = nenhum
- 1 = Oculto
- 2 = DenyDelete
- 4 = HideOptOut
- 8 = HideKeywords
V2. ChannelType
- 0 = nenhum
- 1 = Push
- 2 = Email
- 4 = Bot
- 8 = Voz
- 16 = SMS
- 0 = nenhum
- 1 = Push
- 2 = Email
- 4 = Bot
- 8 = Voz
- 16 = SMS
V2. DutyChangeError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. DutyError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. DutyModes
V2. EventDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.EventParameterDetails | |
|
acknowledgedAlerts
|
acknowledgedAlerts | array of string | |
|
closedAlerts
|
closedAlerts | array of string | |
|
tempoDeCriação
|
creationTime | date-time | |
|
eventSourceGroupId
|
eventSourceGroupId | string | |
|
eventSourceId
|
eventSourceId | string | |
|
eventSourceTeamId
|
eventSourceTeamId | string | |
|
eventSourceType
|
eventSourceType | V2.EventSourceTypes |
|
|
eventStatus
|
eventStatus | V2.EventStatusCodes |
|
|
ID externo
|
externalId | string | |
|
from
|
from | string | |
|
id
|
id | string | |
|
últimaModificação
|
lastModified | date-time | |
|
severidade
|
severity | V2.EventSeverities |
|
|
targets
|
targets | array of V2.EventTargetDetails | |
|
enviar SMS
|
text | string | |
|
title
|
title | string |
V2. EventParameterDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
opções
|
options | V2.EventParameterOptions |
|
|
ordem
|
order | integer | |
|
tipo
|
type | V2.EventParameterTypes |
|
|
value
|
value | string |
V2. EventParameterOptions
V2. EventParameterTypes
- 0 = nenhum
- 1 = Objeto
- 2 = Matriz
- 3 = Construtor
- 4 = Propriedade
- 5 = Comentário
- 6 = Inteiro
- 7 = Float
- 8 = Cadeia de caracteres
- 9 = Boolean
- 10 = Nulo
- 11 = Indefinido
- 12 = Data
- 13 = Bruto
- 14 = Bytes
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
- 0 = nenhum
- 1 = Objeto
- 2 = Matriz
- 3 = Construtor
- 4 = Propriedade
- 5 = Comentário
- 6 = Inteiro
- 7 = Float
- 8 = Cadeia de caracteres
- 9 = Boolean
- 10 = Nulo
- 11 = Indefinido
- 12 = Data
- 13 = Bruto
- 14 = Bytes
- 15 = Guid
- 16 = Uri
- 17 = TimeSpan
- 100 = Html
V2. EventSeverities
V2. EventSourceEndpointError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. EventSourceTypes
- 0 = nenhum
- 1 = Email
- 2 = WebHook
- 3 = Script
- 4 = Sistema
- 5 = Manual
- 6 = Voz
- 7 = API
- 0 = nenhum
- 1 = Email
- 2 = WebHook
- 3 = Script
- 4 = Sistema
- 5 = Manual
- 6 = Voz
- 7 = API
V2. EventStatusCodes
- 0 = nenhum
- 1 = Processamento
- 2 = Signled
- 3 = Filtrado
- 4 = Resolvido
- 5 = Descartado
- 6 = Reconhecido
- 7 = Suprimido
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Erro
- 0 = nenhum
- 1 = Processamento
- 2 = Signled
- 3 = Filtrado
- 4 = Resolvido
- 5 = Descartado
- 6 = Reconhecido
- 7 = Suprimido
- 8 = NoRuleApplied
- 9 = MultipleTargetStatus
- 1000 = Erro
V2. EventTargetDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
alertId
|
alertId | string | |
|
categoryId
|
categoryId | string | |
|
tempoDeCriação
|
creationTime | date-time | |
|
distributionId
|
distributionId | string | |
|
eventId
|
eventId | string | |
|
eventTargetStatus
|
eventTargetStatus | V2.EventTargetStatusCode |
|
|
id
|
id | string | |
|
últimaModificação
|
lastModified | date-time | |
|
teamId
|
teamId | string |
V2. EventTargetStatusCode
- 0 = nenhum
- 1 = Processamento
- 2 = Signled
- 3 = Filtrado
- 4 = Resolvido
- 5 = Descartado
- 6 = Reconhecido
- 7 = Suprimido
- 1000 = Erro
- 0 = nenhum
- 1 = Processamento
- 2 = Signled
- 3 = Filtrado
- 4 = Resolvido
- 5 = Descartado
- 6 = Reconhecido
- 7 = Suprimido
- 1000 = Erro
V2. HolidayDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dia
|
day | integer | |
|
month
|
month | V2.Month |
|
|
Repetindo
|
repeating | boolean | |
|
ano
|
year | integer |
V2. InvitationResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorMessage
|
errorMessage | string | |
|
invitedUser
|
invitedUser | V2.InvitedUserInfo | |
|
sucesso
|
success | boolean |
V2. InvitedUserInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
mailAddress
|
mailAddress | string | |
|
roleId
|
roleId | string | |
|
status
|
status | V2.UserStatus |
|
|
userId
|
userId | string |
V2. KeywordMatchingType
V2. Mês
- 0 = Não definido
- 1 = Janeiro
- 2 = Fevereiro
- 3 = Março
- 4 = Abril
- 5 = Maio
- 6 = Junho
- 7 = Julho
- 8 = Agosto
- 9 = Setembro
- 10 = Outubro
- 11 = Novembro
- 12 = Dezembro
- 0 = Não definido
- 1 = Janeiro
- 2 = Fevereiro
- 3 = Março
- 4 = Abril
- 5 = Maio
- 6 = Junho
- 7 = Julho
- 8 = Agosto
- 9 = Setembro
- 10 = Outubro
- 11 = Novembro
- 12 = Dezembro
V2. NotificationProfileDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
canal
|
channel | V2.ChannelType |
|
|
atrasoemminutos
|
delayInMinutes | integer | |
|
enabled
|
enabled | boolean | |
|
opções
|
options | integer | |
|
persistente
|
persistent | boolean |
V2. OverlappingTimeSlotsDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
refId
|
refId | string | |
|
timeSlots
|
timeSlots | array of V2.TimeSlotDetails |
V2. PermissionError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. PhoneNumberValidationStatus
- 0 = NotValidated
- 1 = Validado
- 2 = CountryNotSupported
- 0 = NotValidated
- 1 = Validado
- 2 = CountryNotSupported
V2. RemoteActionDefinitionDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.RemoteActionDefinitionParameterDetails | |
|
createdAt
|
createdAt | date-time | |
|
descrição
|
description | string | |
|
executorService
|
executorService | string | |
|
ID externo
|
externalId | string | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
código de status
|
statusCode | V2.RemoteActionDefinitionStatus |
|
|
statusDescription
|
statusDescription | string | |
|
tipo
|
type | V2.RemoteActionTypes |
|
|
versão
|
version | integer |
V2. RemoteActionDefinitionParameterDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
controlType
|
controlType | V2.RemoteActionParameterControlTypes |
|
|
defaultValue
|
defaultValue | string | |
|
descrição
|
description | string | |
|
nome de exibição
|
displayName | string | |
|
nome
|
name | string | |
|
opções
|
options | V2.RemoteActionParameterOptions |
|
|
ordem
|
order | integer | |
|
values
|
values | array of string |
V2. RemoteActionDefinitionStatus
V2. RemoteActionDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.RemoteActionParameter | |
|
acesso
|
access | array of V2.RemoteActionTeamAccessDetails | |
|
createdAt
|
createdAt | date-time | |
|
currentPrincipal
|
currentPrincipal | V2.RemoteActionPrincipalAccessDetails | |
|
definitionId
|
definitionId | string | |
|
definitionVersion
|
definitionVersion | integer | |
|
descrição
|
description | string | |
|
enabled
|
enabled | boolean | |
|
executorService
|
executorService | string | |
|
ID externo
|
externalId | string | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
código de status
|
statusCode | V2.RemoteActionStatus |
|
|
statusDescription
|
statusDescription | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
tipo
|
type | V2.RemoteActionTypes |
|
V2. RemoteActionInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
acesso
|
access | array of V2.RemoteActionTeamAccessDetails | |
|
createdAt
|
createdAt | date-time | |
|
currentPrincipal
|
currentPrincipal | V2.RemoteActionPrincipalAccessDetails | |
|
definitionId
|
definitionId | string | |
|
descrição
|
description | string | |
|
enabled
|
enabled | boolean | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
código de status
|
statusCode | V2.RemoteActionStatus |
|
|
statusDescription
|
statusDescription | string | |
|
subscriptionId
|
subscriptionId | string | |
|
teamId
|
teamId | string | |
|
tipo
|
type | V2.RemoteActionTypes |
|
V2. RemoteActionParameter
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
controlType
|
controlType | V2.RemoteActionParameterControlTypes |
|
|
nome de exibição
|
displayName | string | |
|
nome
|
name | string | |
|
opções
|
options | V2.RemoteActionParameterOptions |
|
|
ordem
|
order | integer | |
|
value
|
value | string | |
|
values
|
values | array of string |
V2. RemoteActionParameterControlTypes
- 0 = Texto
- 1 = MultiLineText
- 2 = Inteiro
- 3 = Duplo
- 4 = Bool
- 5 = Tempo
- 6 = Data
- 7 = Fuso Horário
- 8 = Senha
- 9 = PIN
- 10 = SingleChoice
- 11 = MultiChoice
- 12 = Sugestão
- 0 = Texto
- 1 = MultiLineText
- 2 = Inteiro
- 3 = Duplo
- 4 = Bool
- 5 = Tempo
- 6 = Data
- 7 = Fuso Horário
- 8 = Senha
- 9 = PIN
- 10 = SingleChoice
- 11 = MultiChoice
- 12 = Sugestão
V2. RemoteActionParameterOptions
- 0 = nenhum
- 1 = Obrigatório
- 2 = Bloqueado
- 4 = Criptografado
- 0 = nenhum
- 1 = Obrigatório
- 2 = Bloqueado
- 4 = Criptografado
V2. RemoteActionPrincipalAccessDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
canEdit
|
canEdit | boolean | |
|
canExecute
|
canExecute | boolean |
V2. RemoteActionStatus
- 0 = Desativado
- 1 = Ativado
- 2 = Inválido
- 4 = Provedor Desabilitado
- 0 = Desativado
- 1 = Ativado
- 2 = Inválido
- 4 = Provedor Desabilitado
V2. RemoteActionTeamAccessDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
canEdit
|
canEdit | boolean | |
|
canExecute
|
canExecute | boolean | |
|
teamId
|
teamId | string |
V2. RemoteActionTypes
- 0 = Desconhecido
- 1 = Script
- 2 = EnterpriseAlert
- 3 = Webhook
- 0 = Desconhecido
- 1 = Script
- 2 = EnterpriseAlert
- 3 = Webhook
V2. RemoteJob
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
parameters
|
parameters | array of V2.RemoteJobParameter | |
|
actionId
|
actionId | string | |
|
activatedAt
|
activatedAt | date-time | |
|
createdAt
|
createdAt | date-time | |
|
creatorInfo
|
creatorInfo | V2.RemoteJobCreatorDetails | |
|
definitionId
|
definitionId | string | |
|
ID externo
|
externalId | string | |
|
id
|
id | string | |
|
lastUpdate
|
lastUpdate | date-time | |
|
opções
|
options | V2.RemoteJobOptions |
|
|
startedAt
|
startedAt | date-time | |
|
código de status
|
statusCode | V2.RemoteJobStatusCodes |
|
|
statusDescription
|
statusDescription | string | |
|
detalhes do status
|
statusDetails | string | |
|
tipo
|
type | V2.RemoteActionTypes |
|
V2. RemoteJobCreatorDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
referenceId
|
referenceId | string | |
|
referenceName
|
referenceName | string | |
|
tipo
|
type | V2.RemoteJobCreatorType |
|
V2. RemoteJobCreatorType
V2. RemoteJobOptions
V2. RemoteJobParameter
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
value
|
value | string |
V2. RemoteJobStatusCodes
- 0 = nenhum
- 1 = Pendente
- 2 = Pronto
- 4 = Execução
- 8 = Executado
- 16 = Erro
- 0 = nenhum
- 1 = Pendente
- 2 = Pronto
- 4 = Execução
- 8 = Executado
- 16 = Erro
V2. ScheduleDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
término
|
end | date-time | |
|
id
|
id | string | |
|
opções
|
options | integer | |
|
start
|
start | date-time | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. TeamDutySettingsDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
autosnapEnabled
|
autosnapEnabled | boolean | |
|
dutyAssistantEnabled
|
dutyAssistantEnabled | boolean | |
|
dutyChangeNotificationsEnabled
|
dutyChangeNotificationsEnabled | boolean | |
|
dutyLength
|
dutyLength | integer | |
|
handoverDate
|
handoverDate | date-time | |
|
handoverTime
|
handoverTime | integer | |
|
handoverWeekDay
|
handoverWeekDay | integer | |
|
minMemberOnDuty
|
minMemberOnDuty | integer | |
|
schedulingEnabled
|
schedulingEnabled | boolean | |
|
shiftReportCarbonCopyMail
|
shiftReportCarbonCopyMail | string | |
|
shiftReportEnabled
|
shiftReportEnabled | boolean | |
|
teamId
|
teamId | string | |
|
timezone
|
timezone | string |
V2. TeamDutySettingsError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. TeamDutySummaryError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
userId
|
userId | string |
V2. TeamHolidayDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Férias
|
holidays | array of V2.HolidayDetails | |
|
teamId
|
teamId | string |
V2. TeamImageDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | byte | |
|
contentDispostion
|
contentDispostion | string | |
|
contentEncoding
|
contentEncoding | string | |
|
tipo de conteúdo
|
contentType | string | |
|
últimaModificação
|
lastModified | date-time | |
|
nome
|
name | string |
V2. TeamMembershipDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
mailAddress
|
mailAddress | string | |
|
memberSince
|
memberSince | date-time | |
|
roleId
|
roleId | string | |
|
status
|
status | V2.UserStatus |
|
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. TeamPermissions
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
permissões
|
permissions | array of UserPermission | |
|
teamId
|
teamId | string |
V2. TeamPrivacySettingsDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
hideContactAddresses
|
hideContactAddresses | boolean | |
|
hideDutyData
|
hideDutyData | boolean | |
|
hideForEscalation
|
hideForEscalation | boolean | |
|
teamId
|
teamId | string |
V2. TeamPublicDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
privacySettings
|
privacySettings | V2.TeamPrivacySettingsDetails |
V2. TeamUserError
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de erro
|
errorCode | integer | |
|
errorDescription
|
errorDescription | string | |
|
teamId
|
teamId | string |
V2. TimeSlotDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
término
|
end | V2.WeekTimeDetails | |
|
id
|
id | string | |
|
start
|
start | V2.WeekTimeDetails |
V2. TimeSlotValidationResultDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
isOverlapping
|
isOverlapping | boolean | |
|
item
|
item | V2.TimeSlotDetails | |
|
overlappingTimeSlots
|
overlappingTimeSlots | array of V2.OverlappingTimeSlotsDetails | |
|
válido
|
valid | boolean |
V2. UserDeliveryStatus
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de status
|
statusCode | V2.UserDeliveryStatusCodes |
|
|
userId
|
userId | string |
V2. UserDeliveryStatusCodes
- 0 = nenhum
- 1 = Abrir
- 2 = Falha
- 4 = Transmitido
- 6 = Entregue
- 8 = Protegido
- 9 = AbuseProtected
- 24 = PartlyTransmitted
- 26 = Parcialmente Entregue
- 30 = NotOnDuty
- 31 = CategoryOptOut
- 32 = NoMessagesSent
- 0 = nenhum
- 1 = Abrir
- 2 = Falha
- 4 = Transmitido
- 6 = Entregue
- 8 = Protegido
- 9 = AbuseProtected
- 24 = PartlyTransmitted
- 26 = Parcialmente Entregue
- 30 = NotOnDuty
- 31 = CategoryOptOut
- 32 = NoMessagesSent
V2. UserDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
colorIndex
|
colorIndex | integer | |
|
contactAddresses
|
contactAddresses | array of | |
|
dutyInfos
|
dutyInfos | array of V2.UserDutyDetails | |
|
externalAuthProvider
|
externalAuthProvider | string | |
|
id
|
id | string | |
|
isDeactivated
|
isDeactivated | boolean | |
|
isInvite
|
isInvite | boolean | |
|
lastSeen
|
lastSeen | date-time | |
|
email
|
string | ||
|
nome
|
name | string | |
|
remoteActionPinSet
|
remoteActionPinSet | boolean | |
|
subscriptionId
|
subscriptionId | string | |
|
Fuso horário
|
timeZone | string | |
|
userImageLastModified
|
userImageLastModified | date-time |
V2. UserDutyDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dutyMode
|
dutyMode | V2.DutyModes |
|
|
lastChange
|
lastChange | date-time | |
|
onDutyTime
|
onDutyTime | integer | |
|
em atraso
|
overdue | boolean | |
|
teamId
|
teamId | string | |
|
userId
|
userId | string |
V2. UserLocaleResponseDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
linguagem
|
language | string | |
|
Fuso horário
|
timeZone | string |
V2. UserPhoneNumberDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código do país
|
countryCode | string | |
|
número de telefone
|
phoneNumber | string | |
|
validationStatus
|
validationStatus | V2.PhoneNumberValidationStatus |
|
V2. UserStatus
V2. WeekTimeDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
hora
|
hour | integer | |
|
minutes
|
minutes | integer | |
|
Semana
|
weekday | V2.Weekday |
|
V2. Semana
- 0 = Feriado
- 1 = Segunda-feira
- 2 = Terça-feira
- 3 = Quarta-feira
- 4 = Quinta-feira
- 5 = Sexta-feira
- 6 = Sábado
- 7 = Domingo
- 0 = Feriado
- 1 = Segunda-feira
- 2 = Terça-feira
- 3 = Quarta-feira
- 4 = Quinta-feira
- 5 = Sexta-feira
- 6 = Sábado
- 7 = Domingo
WebhookInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
description | string | |
|
enabled
|
enabled | boolean | |
|
extUrl
|
extUrl | string | |
|
id
|
id | string | |
|
nome
|
name | string | |
|
subId
|
subId | string | |
|
teamId
|
teamId | string |
cadeia
Esse é o tipo de dados básico 'string'.
binário
Esse é o tipo de dados básico 'binary'.