Skip to main content
GET
/
api
/
v
{version}
/
get
/
fw_messages
Recupera registros de mensagens to-mobile definidos por uma lista de IDs de mensagens to-mobile (IDList). Somente mensagens pertencentes à conta que está fazendo a chamada (ou uma de suas subcontas imediatas) serão recuperadas. (Autenticação)
curl --request GET \
  --url https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1/api/v{version}/get/fw_messages
{
  "Messages": [
    {
      "ID": 10844864715,
      "StatusUTC": "2022-11-25 12:00:23",
      "CreateUTC": "2022-11-25 12:00:03",
      "IsClosed": true,
      "State": 1,
      "NetworkID": "01008988SKY5909",
      "DestinationID": "KAAA4235100020",
      "Payload": {
        "Name": "getTerminalStatus",
        "SIN": 16,
        "MIN": 2,
        "IsForward": "True",
        "Fields": []
      },
      "ReferenceNumber": 1012,
      "Transport": 1,
      "RegionName": "AMERRB8"
    },
    {
      "ID": 10844864716,
      "StatusUTC": "2022-11-25 12:00:15",
      "CreateUTC": "2022-11-25 12:00:04",
      "IsClosed": false,
      "State": 0,
      "NetworkID": "01008988SKY5909",
      "DestinationID": "KAAA4235100020",
      "Payload": {
        "Name": "getTerminalStatus",
        "SIN": 16,
        "MIN": 2,
        "IsForward": "True",
        "Fields": []
      },
      "ReferenceNumber": 1012,
      "Transport": 1
    },
    {
      "ID": 10844864806,
      "ErrorID": 14
    }
  ]
}

Path Parameters

​
version
string
required

Query Parameters

​
IDList
string

Lista de IDs de mensagens to-mobile

​
IncludeTypes
boolean
default:false

Defina este campo como true se desejar que o Payload inclua também os tipos dos campos.

​
IncludeRawPayload
boolean
default:false

Por padrão, o OGWS retorna mensagens já decodificadas. Se for necessário obter a mensagem em formato bruto (binário), o cliente deve definir este campo como true, caso contrário, será retornada apenas a mensagem decodificada.

Response

Sucesso

Resposta a uma chamada que recupera mensagens para móvel (FW). Contém uma lista de mensagens encaminhadas (to-mobile) solicitadas.

​
ErrorID
any

Presente somente em caso de falha. Valor ErrorID serve para referência na identificação da causa do erro.

Example:

0

​
Messages
any

Array de registros das mensagens FW (to-mobile) solicitadas.