Skip to main content
POST
/
api
/
v
{version}
/
submit
/
messages
Permite que usuários enviem uma ou mais mensagens to-mobile para seus terminais. (Autenticação)
curl --request POST \
  --url https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1/api/v{version}/submit/messages \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "DestinationID": "01008988SKY5909",
    "UserMessageID": 2097,
    "RawPayload": "B401323032322D30322D31372031363A34303A34352034392D305F3136343034355F315F3136343034355F325F3136343034355F335F3136343034355F345F3136343034355F355F3136343034355F365F3136343034355F375F3136343034355F385F3136343034355F395F3136343034355F31305F3136343034355F31315F31363430342D31333w==",
    "TransportType": 1,
    "DelayedSendOptions": {
      "DelayedSend": true,
      "MessageExpireUTC": "2022-11-25 12:00:23"
    }
  },
  {
    "DestinationID": "352648040000008",
    "UserMessageID": 2098,
    "RawPayload": "B401323032322D30322D31372031363A34303A34352034392D305F3136343034355F315F3136343034355F325F3136343034355F335F3136343034355F345F3136343034355F355F3136343034355F365F3136343034355F375F3136343034355F385F3136343034355F395F3136343034355F31305F3136343034355F31315F31363430342D31333w==",
    "TransportType": 2
  },
  {
    "DestinationID": "01008988SKY5909",
    "UserMessageID": 2099,
    "Payload": {
      "Name": "getTerminalStatus",
      "SIN": 16,
      "MIN": 2,
      "IsForward": "True",
      "Fields": []
    },
    "TransportType": 2
  }
]
'
{
  "Submissions": [
    {
      "ID": 10844864715,
      "DestinationID": "01008988SKY5909",
      "UserMessageID": 2097,
      "OTAMessageSize": 202,
      "OperationMode": null
    },
    {
      "ID": 10844864716,
      "DestinationID": "01008988SKY5900",
      "UserMessageID": 2098,
      "OTAMessageSize": 202,
      "OperationMode": null
    },
    {
      "ErrorID": 21827,
      "UserMessageID": 2099,
      "OperationMode": null
    }
  ]
}

Path Parameters

​
version
string
required

Body

application/json
​
DestinationID
string | null

Destino da mensagem do cliente. Pode ser o ID principal do terminal ou um ID de broadcast. Este campo pode ser omitido se o método 'submitToMultiple' for usado. Neste caso, o destino será retirado da lista 'Destinations' e esta propriedade será ignorada mesmo que especificada.

Example:

"01008988SKY5909"

​
UserMessageID
integer<int64> | null

ID da mensagem definido pelo cliente. Deve ser fornecido se quiser mapear para o número do Gateway - o ID na classe ForwardSubmission. O Gateway não armazena o UserMessageID em lugar algum. Este campo é irrelevante se o serviço SubmitMessagesToMultipleDestinations for chamado.

Example:

2097

​
RawPayload
string<byte> | null

Contém um array de bytes do payload bruto que será enviado ao destino sem alterações. Este payload deve seguir o formato das mensagens de terminal.

Example:

"tAEyMDIyLTAyLTE3IDE2OjQwOjQ1IDQ5LTBfMTY0MDQ1XzFfMTY0MDQ1XzJfMTY0MDQ1XzNfMTY0MDQ1XzRfMTY0MDQ1XzVfMTY0MDQ1XzZfMTY0MDQ1XzdfMTY0MDQ1XzhfMTY0MDQ1XzlfMTY0MDQ1XzEwXzE2NDA0NV8xMV8xNjQwNC0xMzU="

​
Payload
any
​
TransportType
integer<int32> | null

Especifica o transporte para envio da mensagem to-mobile. É opcional e deve ser omitido a não ser que queira limitar a um transporte específico. Opções possíveis:

  • 0: qualquer transporte (satélite ou celular). [Padrão se não especificado]
  • 1: somente satélite. Se definido, a mensagem nunca será enviada pela rede celular.
  • 2: somente celular.
​
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