> ## 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.

# Consultar envio RCS

> Consulta se foi enviado, entregue ou falhou, e vê os detalhes.



## OpenAPI

````yaml /rcs-api/api-reference/openapi-rcs.json get /v1/rcs/messages/{id}
openapi: 3.0.3
info:
  title: Notifique API RCS
  description: >-
    Envie mensagens RCS e consulte status. Autentique com `Authorization: Bearer
    sk_live_...` ou `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfRcsBearerAuth: []
  - ntfRcsApiKeyHeader: []
tags:
  - name: RCS
    description: Envio e consulta de mensagens RCS
paths:
  /v1/rcs/messages/{id}:
    get:
      tags:
        - RCS
      summary: Consultar envio RCS
      description: Consulta se foi enviado, entregue ou falhou, e vê os detalhes.
      operationId: ntfRcs_getV1RcsById
      parameters:
        - name: id
          in: path
          required: true
          description: ID (cuid) do RCS retornado no envio.
          schema:
            type: string
      responses:
        '200':
          description: Dados do RCS.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfRcs_RcsStatusResponse'
        '401':
          description: API Key ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfRcs_ErrorResponse'
        '403':
          description: Escopo rcs:read ausente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfRcs_ErrorResponse'
        '404':
          description: RCS não encontrado ou não pertence ao workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfRcs_ErrorResponse'
              example:
                success: false
                error: Not Found
                message: RCS message not found
                code: NOT_FOUND
components:
  schemas:
    NtfRcs_RcsStatusResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            rcsId:
              type: string
            to:
              type: string
            messageType:
              type: string
              enum:
                - BASIC
                - CARD
                - CAROUSEL
                - FILE
            payload:
              type: object
            refer:
              type: string
              nullable: true
            status:
              type: string
              enum:
                - SCHEDULED
                - QUEUED
                - SENT
                - PROCESSING
                - DELIVERED
                - FAILED
                - CANCELLED
              description: >-
                QUEUED = na fila; SCHEDULED = agendado; PROCESSING = aceito pelo
                provedor; SENT = enviado; DELIVERED = entregue; FAILED = falha;
                CANCELLED = cancelado.
            externalId:
              type: string
              nullable: true
            errorMessage:
              type: string
              nullable: true
            scheduledFor:
              type: string
              format: date-time
              nullable: true
            sentAt:
              type: string
              format: date-time
              nullable: true
            deliveredAt:
              type: string
              format: date-time
              nullable: true
            failedAt:
              type: string
              format: date-time
              nullable: true
            createdAt:
              type: string
              format: date-time
            updatedAt:
              type: string
              format: date-time
    NtfRcs_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:
    ntfRcsBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfRcsApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'API Key no header x-api-key. Exemplo: `x-api-key: sk_live_xxxxx`'

````