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

# Listar SMS recebidos

> Mostra os SMS que chegaram de volta — respostas dos destinatários. Dá para filtrar por data, número ou texto.



## OpenAPI

````yaml /sms-api/api-reference/openapi-sms.json get /v1/sms/inbound
openapi: 3.0.3
info:
  title: Notifique API. SMS
  description: >-
    Envie SMS, acompanhe a entrega e veja mensagens recebidas. Use
    `Authorization: Bearer sk_live_...` ou `x-api-key` para autenticar.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfSmsBearerAuth: []
  - ntfSmsApiKeyHeader: []
tags:
  - name: SMS
    description: Enviar SMS, consultar status e ver mensagens recebidas.
paths:
  /v1/sms/inbound:
    get:
      tags:
        - SMS
      summary: Listar SMS recebidos
      description: >-
        Mostra os SMS que chegaram de volta — respostas dos destinatários. Dá
        para filtrar por data, número ou texto.
      operationId: ntfSms_getV1SmsInbound
      parameters:
        - name: page
          in: query
          schema:
            type: string
          description: Página (padrão 1).
        - name: limit
          in: query
          schema:
            type: string
          description: Itens por página (padrão 20, máx. 100).
        - name: q
          in: query
          schema:
            type: string
          description: >-
            Busca no corpo (case insensitive) ou no remetente (se o valor tiver
            8+ dígitos).
        - name: provider
          in: query
          schema:
            type: string
            enum:
              - SMS_DEV
              - MOBIZON
              - COMTELE
              - SMS_BARATO
          description: Filtrar por provedor de SMS (valores inválidos são ignorados).
        - name: linked
          in: query
          schema:
            type: string
          description: >-
            `true` ou `1` para retornar só MO correlacionados a um SMS enviado
            pelo workspace (`relatedSmsLogId` preenchido).
        - name: dateFrom
          in: query
          schema:
            type: string
            format: date-time
          description: Início do intervalo em `receivedAt` (inclusive).
        - name: dateTo
          in: query
          schema:
            type: string
            format: date-time
          description: Fim do intervalo em `receivedAt` (inclusive).
      responses:
        '200':
          description: Lista de MO e paginação.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - pagination
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/NtfSms_SmsInboundListItem'
                  pagination:
                    type: object
                    required:
                      - total
                      - page
                      - limit
                      - totalPages
                    properties:
                      total:
                        type: integer
                      page:
                        type: integer
                      limit:
                        type: integer
                      totalPages:
                        type: integer
        '401':
          description: API Key ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfSms_ErrorResponse'
        '403':
          description: Escopo sms:read ausente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfSms_ErrorResponse'
components:
  schemas:
    NtfSms_SmsInboundListItem:
      type: object
      description: Item na listagem de SMS recebidos; `receivedAt` em ISO 8601.
      properties:
        id:
          type: string
        workspaceId:
          type: string
        provider:
          type: string
        externalMoId:
          type: string
          nullable: true
        from:
          type: string
        body:
          type: string
          nullable: true
        refer:
          type: string
          nullable: true
        receivedAt:
          type: string
          format: date-time
        relatedSmsLogId:
          type: string
          nullable: true
    NtfSms_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
          description: Lista de erros de validação por campo.
      required:
        - success
        - error
        - message
        - code
  securitySchemes:
    ntfSmsBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfSmsApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'API Key no header x-api-key. Exemplo: `x-api-key: sk_live_xxxxx`'

````