> ## Documentation Index
> Fetch the complete documentation index at: https://doc.allcomtelecom.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Busca mensagens recebidas de subconta

> Recupera mensagens de retorno (from-mobile) recebidas pelo OGx Gateway após o horário especificado (UTC). 
Somente mensagens pertencentes à subconta especificada serão recuperadas. (Autenticação roles: SuperAccountUser, Provisioning)



## OpenAPI

````yaml GET /api/v{version}/get/subaccount/re_messages
openapi: 3.0.1
info:
  title: OpenAPI Auth Store
  description: API de exemplo para demonstração de autenticação e obtenção de tokens.
  license:
    name: Allcom Telecom
  version: 1.0.0
servers:
  - url: >-
      https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1
security: []
paths:
  /api/v{version}/get/subaccount/re_messages:
    get:
      tags:
        - Get
      summary: "Recupera mensagens de retorno (from-mobile) recebidas pelo OGx Gateway após o horário especificado (UTC). \r\nSomente mensagens pertencentes à subconta especificada serão recuperadas. (Autenticação roles: SuperAccountUser, Provisioning)"
      description: "Recupera mensagens de retorno (from-mobile) recebidas pelo OGx Gateway após o horário especificado (UTC). \r\nSomente mensagens pertencentes à subconta especificada serão recuperadas. (Autenticação roles: SuperAccountUser, Provisioning)"
      parameters:
        - name: FromUTC
          in: query
          description: >-
            Recupera registros de mensagens recebidas após FromUTC. O formato do
            'FromUTC': 'yyyy-MM-dd HH24:mm:ss'
          schema:
            type: string
        - name: SubAccountID
          in: query
          description: ID da subconta (número começando com 6.........)
          schema:
            type: integer
            format: int32
        - name: IncludeTypes
          in: query
          description: >-
            Defina este campo como true se quiser que o Payload inclua também os
            tipos dos campos.
          schema:
            type: boolean
            default: false
        - name: IncludeRawPayload
          in: query
          description: >-
            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.
          schema:
            type: boolean
            default: false
        - name: version
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            Chamada realizada com sucesso. Verifique o ErrorID para possíveis
            erros.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReturnMessagesResponse'
              example:
                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
        '401':
          description: Falha na autenticação e autorização
          content:
            application/json:
              example: Falha na autenticação e autorização
        '403':
          description: >-
            Quando o usuário não for um SuperAccountUser, a API retornará o
            código HTTP 403 “Proibido”
          content:
            application/json:
              example: >-
                Quando o usuário não for um SuperAccountUser, a API retornará o
                código HTTP 403 “Proibido”
        '429':
          description: >-
            Quando o usuário ultrapassa o limite provisionado de requisições
            para o endpoint da API, será retornado o código HTTP 429 “Muitas
            Requisições”
          content:
            application/json:
              example: >-
                Quando o usuário ultrapassa o limite provisionado de requisições
                para o endpoint da API, será retornado o código HTTP 429 “Muitas
                Requisições”
components:
  schemas:
    GetReturnMessagesResponse:
      description: Contém uma lista de registros das Mensagens from-mobile.
      properties:
        ErrorID:
          description: >-
            Presente somente em caso de falha. O valor ErrorID serve como
            referência para entender a causa do erro.
          example: 0
        NextFromUTC:
          description: "Contém o valor do próximo campo fromUTC que o cliente precisa fornecer em uma requisição para receber mensagens contíguas.\r\nPode ser omitido em caso de erro ou se nenhuma mensagem foi retornada.\r\nSe você faz polling regular para mensagens from-mobile, deve usar essa marcação (high-water mark) nas requisições seguintes.\r\nReusar 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:
          description: Array de registros das Mensagens FW (to-mobile) solicitadas.

````