Skip to main content
POST
/
api
/
v
{version}
/
terminal
/
sysreset
Envia uma mensagem de 'reset' do sistema para terminais de destino (Autenticação: Provisionamento)
curl --request POST \
  --url https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1/api/v{version}/terminal/sysreset \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "DestinationID": "01008988SKY5909",
    "UserMessageID": 2097,
    "ResetModem": true,
    "ResetApplication": true,
    "RegistrationTimeQualifierIdx": 123,
    "LastTransmitTimeQualifierIdx": 123,
    "DeleteAllGrants": true,
    "DeleteChannelConfig": true,
    "DeleteServiceConfig": true,
    "DeleteGnssFix": true,
    "AbortTxMsgs": true,
    "AbortRxMsgs": true,
    "WakeupInterval": 123,
    "VCID": 123,
    "GeoBeam": 123,
    "DelayedSendOptions": {
      "DelayedSend": true,
      "MessageExpireUTC": "2022-11-25 12:00:23"
    }
  }
]
'
{
  "Submissions": [
    {
      "ID": 10844864715,
      "DestinationID": "01008988SKY5909",
      "UserMessageID": 1003,
      "OTAMessageSize": 202,
      "OperationMode": null
    },
    {
      "ID": 10844864716,
      "DestinationID": "01008989SKY5900",
      "UserMessageID": 1003,
      "OTAMessageSize": 202,
      "OperationMode": null
    }
  ]
}

Path Parameters

​
version
string
required

Body

​
DestinationID
string | null

Destino da mensagem (ID principal do terminal).

Example:

"01008988SKY5909"

​
UserMessageID
integer<int64> | null

ID da mensagem do cliente. Deve ser fornecido para mapear para o número do Gateway. O Gateway não armazena este ID.

Example:

2097

​
ResetModem
boolean | null

ResetModem - reseta o modem se true.

​
ResetApplication
boolean | null

ResetApplication - reseta a aplicação se true.

​
RegistrationTimeQualifierIdx
integer<int32> | null

RegistrationTimeQualifierIdx - 0 se não especificado.

​
LastTransmitTimeQualifierIdx
integer<int32> | null

LastTransmitTimeQualifierIdx - 0 se não especificado.

​
DeleteAllGrants
boolean | null

DeleteAllGrants - false se não especificado.

​
DeleteChannelConfig
boolean | null

DeleteChannelConfig - false se não especificado.

​
DeleteServiceConfig
boolean | null

DeleteServiceConfig - false se não especificado.

​
DeleteGnssFix
boolean | null

DeleteGnssFix - false se não especificado.

​
AbortTxMsgs
boolean | null

AbortTxMsgs - false se não especificado.

​
AbortRxMsgs
boolean | null

AbortRxMsgs - false se não especificado.

​
WakeupInterval
integer<int32> | null

Apenas terminais IDP - null se não especificado.

​
VCID
integer<int32> | null

Apenas terminais IDP - null se não especificado.

​
GeoBeam
integer<int32> | null

Apenas terminais IDP - null se não especificado.

​
DelayedSendOptions
object

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.

Response

Chamada realizada com sucesso. Verifique o ErrorID para possíveis erros.

Resposta da submissão de mensagens.

​
ErrorID
integer<int32> | null

Presente apenas em caso de falha. O valor ErrorID serve como referência para entender a causa do erro.

Example:

0

​
Submissions
object[] | null

Array com informações sobre submissões de mensagens FW