> ## Documentation Index > Fetch the complete documentation index at: https://doc.allcomtelecom.com/llms.txt > Use this file to discover all available pages before exploring further. # Envia mensagem de “reset” do sistema > Autenticação: Token Bearer Limitação de taxa: sim (grupo SEND de métodos) Autorização: Conta de usuário ## OpenAPI ````yaml POST /api/v{version}/terminal/sysreset openapi: 3.0.1 info: title: OpenAPI Auth Store description: API de exemplo para demonstração de autenticação e obtenção de tokens. license: name: Allcom Telecom version: 1.0.0 servers: - url: >- https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1 security: [] paths: /api/v{version}/terminal/sysreset: post: tags: - Terminal summary: >- Envia uma mensagem de 'reset' do sistema para terminais de destino (Autenticação: Provisionamento) description: "Autenticação: Token Bearer\r\n\r\nLimitação de taxa: sim (grupo SEND de métodos)\r\n\r\nAutorização: Conta de usuário" parameters: - name: version in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SysResetMessage' text/json: schema: type: array items: $ref: '#/components/schemas/SysResetMessage' application/*+json: schema: type: array items: $ref: '#/components/schemas/SysResetMessage' responses: '200': description: >- Chamada realizada com sucesso. Verifique o ErrorID para possíveis erros. content: application/json: schema: $ref: '#/components/schemas/SubmitMessagesResponse' example: Submissions: - ID: 10844864715 DestinationID: 01008988SKY5909 UserMessageID: 1003 OTAMessageSize: 202 OperationMode: null - ID: 10844864716 DestinationID: 01008989SKY5900 UserMessageID: 1003 OTAMessageSize: 202 OperationMode: null '401': description: Quando falha a autenticação e autorização. content: application/json: example: Quando falha a autenticação e autorização. '429': description: >- Quando o usuário ultrapassa o limite provisionado de requisições para o endpoint da API, será retornado o código HTTP 429 “Muitas Requisições”. content: application/json: example: >- Quando o usuário ultrapassa o limite provisionado de requisições para o endpoint da API, será retornado o código HTTP 429 “Muitas Requisições”. components: schemas: SysResetMessage: type: object properties: DestinationID: type: string description: Destino da mensagem (ID principal do terminal). nullable: true example: 01008988SKY5909 UserMessageID: type: integer description: >- ID da mensagem do cliente. Deve ser fornecido para mapear para o número do Gateway. O Gateway não armazena este ID. format: int64 nullable: true example: 2097 ResetModem: type: boolean description: ResetModem - reseta o modem se true. nullable: true ResetApplication: type: boolean description: ResetApplication - reseta a aplicação se true. nullable: true RegistrationTimeQualifierIdx: type: integer description: RegistrationTimeQualifierIdx - 0 se não especificado. format: int32 nullable: true LastTransmitTimeQualifierIdx: type: integer description: LastTransmitTimeQualifierIdx - 0 se não especificado. format: int32 nullable: true DeleteAllGrants: type: boolean description: DeleteAllGrants - false se não especificado. nullable: true DeleteChannelConfig: type: boolean description: DeleteChannelConfig - false se não especificado. nullable: true DeleteServiceConfig: type: boolean description: DeleteServiceConfig - false se não especificado. nullable: true DeleteGnssFix: type: boolean description: DeleteGnssFix - false se não especificado. nullable: true AbortTxMsgs: type: boolean description: AbortTxMsgs - false se não especificado. nullable: true AbortRxMsgs: type: boolean description: AbortRxMsgs - false se não especificado. nullable: true WakeupInterval: type: integer description: Apenas terminais IDP - null se não especificado. format: int32 nullable: true VCID: type: integer description: Apenas terminais IDP - null se não especificado. format: int32 nullable: true GeoBeam: type: integer description: Apenas terminais IDP - null se não especificado. format: int32 nullable: true DelayedSendOptions: $ref: '#/components/schemas/SatelliteDelayedSendOptions' additionalProperties: false description: >- Classe que representa uma mensagem de reset do sistema to-mobile para terminais. SubmitMessagesResponse: type: object properties: ErrorID: type: integer description: >- Presente apenas em caso de falha. O valor ErrorID serve como referência para entender a causa do erro. format: int32 nullable: true example: 0 Submissions: type: array items: $ref: '#/components/schemas/SubmitMessageResult' description: Array com informações sobre submissões de mensagens FW nullable: true additionalProperties: false description: Resposta da submissão de mensagens. SatelliteDelayedSendOptions: required: - DelayedSend type: object properties: DelayedSend: type: boolean description: >- Se definido como true, a mensagem to-mobile será enfileirada para envio apenas quando o Gateway receber uma mensagem from-mobile do terminal de destino. example: true MessageExpireUTC: type: string description: >- Se nenhuma mensagem from-mobile chegar antes do MessageExpireUTC, a mensagem será encerrada com o status 'timed out'. Se MessageExpireUTC não for definido, o Gateway o configurará para 5 dias a partir do envio da mensagem. nullable: true example: '2022-11-25 12:00:23' additionalProperties: false description: >- Esta classe controla o envio atrasado de mensagens to-mobile. Aplica-se somente a mensagens enviadas pela rede via satélite. Esta opção é ignorada se a rede celular for usada. O envio atrasado é normalmente usado para mensagens to-mobile a terminais que ficam desligados a maior parte do tempo, mas enviam mensagens from-mobile ao serem ligados. SubmitMessageResult: type: object properties: ID: type: integer description: >- ID da mensagem to-mobile gerado pelo Gateway. O cliente pode usar este ID para consultar o status da mensagem. O valor do ID pode reiniciar para 1 após atingir o máximo para seu tipo. Pode ser omitido se não houver valor válido disponível ou necessário. format: int64 nullable: true example: 10844864715 DestinationID: type: string description: >- Número de identificação (Prime ID) do terminal ou ID fornecido pelo usuário em caso de erro. nullable: true example: 01008988SKY5909 ErrorID: type: integer description: |- Número do erro ou zero se a mensagem foi aceita pelo Gateway. Pode ser omitido se não houver erro. format: int32 nullable: true example: 0 UserMessageID: type: integer description: >- Se enviado junto com a mensagem, o Gateway retorna este número para permitir mapear IDs locais (UserMessageID) para IDs do Gateway (ID). Pode ser omitido se não houver valor válido disponível ou necessário. format: int64 nullable: true example: 2097 OTAMessageSize: type: integer description: >- Tamanho da mensagem Over-the-air em bytes. Pode ser omitido se não houver valor válido disponível ou necessário. format: int32 nullable: true OperationMode: type: integer description: |- Modo operacional do terminal: 0 - ALWAYS_ON (IDP ou OGx) 1 - WAKE_UP (IDP ou OGx) 2 - RECEIVE_ON_SEND (apenas OGx) 3 - HYBRID (apenas OGx) Pode ser omitido se o modo for ALWAYS_ON. format: int32 nullable: true ScheduledSendUTC: type: string description: >- Se o terminal estiver em modo WAKE_UP ou HYBRID, contém o horário estimado para transmissão. Pode ser omitido se o modo for ALWAYS_ON. nullable: true TerminalWakeupPeriod: type: integer description: >- Período de wake-up do terminal em segundos se estiver em modo WAKE_UP ou HYBRID. Pode ser omitido se o modo for ALWAYS_ON. format: int32 nullable: true additionalProperties: false description: >- Informações sobre uma mensagem enviada retornadas pelo serviço. Cada objeto contém informações de uma mensagem to-mobile submetida. Em caso de erro (ErrorID > 0), o ID da mensagem não será definido. Contudo, NetworkID e UserMessageID, se definidos, são retornados. ````