Skip to main content
GET
/
api
/
v
{version}
/
get
/
subaccount
/
fw_status_updates
Recupera atualizações nos status das mensagens to-mobile submetidas desde o horário especificado (UTC). Somente atualizações das mensagens to-mobile pertencentes à subconta especificada da conta que está fazendo a chamada 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/subaccount/fw_status_updates
{
  "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

SubAccountID
integer<int32>

ID da subconta (número começando com 6.........)

FromUTC
string

Recupera registros de status das mensagens da subconta atualizados após FromUTC. O formato do 'FromUTC': 'yyyy-MM-dd HH24:mm:ss'

Response

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

Contém uma lista dos status das Mensagens encaminhadas (to-mobile) solicitadas.

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

Para 'fw_status_updates', o parâmetro 'fromUTC' da próxima requisição deve ser definido com este valor. Se você faz polling regular para mudanças de status das mensagens to-mobile, deve usar essa marcação retornada (high-water mark) nas requisições seguintes. Reusar valores de marcação (FromUTC) enquanto obtém um grande número de registros pode resultar em limitação (throttling) das suas próximas requisições.

Statuses
any

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