Skip to main content
GET
/
api
/
v
{version}
/
get
/
subaccounts
/
re_messages
Recupera mensagens de retorno (from-mobile) recebidas pelo OGx Gateway após o horário especificado (UTC). Mensagens pertencentes à conta que está fazendo a chamada (super-conta) e todas as suas subcontas serão recuperadas. (Autenticação roles: SuperAccountUser, Provisioning)
curl --request GET \
  --url https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1/api/v{version}/get/subaccounts/re_messages
{
  "Statuses": [
    {
      "ID": 10844864715,
      "IsClosed": true,
      "State": 1,
      "CreateUTC": "2022-11-25 12:00:20",
      "StatusUTC": "2022-11-25 12:00:23",
      "Transport": 1,
      "RegionName": "AMERRB8",
      "ReferenceNumber": 41
    },
    {
      "ID": 10844864716,
      "IsClosed": false,
      "State": 0,
      "CreateUTC": "2022-11-25 12:00:00",
      "StatusUTC": "2022-11-25 12:00:15",
      "Transport": 1,
      "ReferenceNumber": 20
    },
    {
      "ID": 10844864806,
      "ErrorID": 14
    }
  ]
}

Path Parameters

​
version
string
required

Query Parameters

​
FromUTC
string

Recupera registros de mensagens recebidas após FromUTC. O formato do 'FromUTC': 'yyyy-MM-dd HH24:mm:ss'

​
IncludeTypes
boolean
default:false

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

​
IncludeRawPayload
boolean
default:false

Por padrão, o OGWS retorna mensagens já decodificadas. Se precisar obter a Mensagem em formato bruto, binário, o cliente deve definir este campo como true; caso contrário, somente a Mensagem decodificada será retornada.

Response

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

Contém uma lista de registros das Mensagens from-mobile.

​
ErrorID
any

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

Example:

0

​
NextFromUTC
any

Contém o valor do próximo campo fromUTC que o cliente precisa fornecer em uma requisição para receber mensagens contíguas. Pode ser omitido em caso de erro ou se nenhuma mensagem foi retornada. Se você faz polling regular para mensagens from-mobile, deve usar essa marcação (high-water mark) nas requisições seguintes. Reusar valores de marcação (fromUTC) ao obter muitos registros pode resultar em limitação (throttling) das próximas requisições.

Example:

"2022-11-25 12:00:03"

​
Messages
any

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