> ## 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 para celular por IDs

> 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)



## OpenAPI

````yaml GET /api/v{version}/get/fw_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/fw_messages:
    get:
      tags:
        - Get
      summary: "Recupera registros de mensagens to-mobile definidos por uma lista de IDs de mensagens to-mobile (IDList). \r\nSomente mensagens pertencentes à conta que está fazendo a chamada (ou uma de suas subcontas imediatas) serão recuperadas. (Autenticação)"
      description: "Recupera registros de mensagens to-mobile definidos por uma lista de IDs de mensagens to-mobile (IDList). \r\nSomente mensagens pertencentes à conta que está fazendo a chamada (ou uma de suas subcontas imediatas) serão recuperadas. (Autenticação)"
      parameters:
        - name: IDList
          in: query
          description: Lista de IDs de mensagens to-mobile
          schema:
            type: string
        - name: IncludeTypes
          in: query
          description: >-
            Defina este campo como true se desejar 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 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.
          schema:
            type: boolean
            default: false
        - name: version
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetForwardMessagesResponse'
              example:
                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
        '401':
          description: Não autorizado
        '429':
          description: Muitas requisições
components:
  schemas:
    GetForwardMessagesResponse:
      description: "Resposta a uma chamada que recupera mensagens para móvel (FW).\r\nContém uma lista de mensagens encaminhadas (to-mobile) solicitadas."
      properties:
        ErrorID:
          description: >-
            Presente somente em caso de falha. Valor ErrorID serve para
            referência na identificação da causa do erro.
          example: 0
        Messages:
          description: Array de registros das mensagens FW (to-mobile) solicitadas.

````