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

# Get messages



## OpenAPI

````yaml /openapi/sms.json get /v1/sms/messages/
openapi: 3.0.3
info:
  title: Yume API — SMS
  version: 1.0.0
  description: Отправка SMS через провайдеров.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/sms/messages/:
    get:
      tags:
        - messages
      summary: Get messages
      operationId: messages_list
      parameters:
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - name: pageSize
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - name: search
          required: false
          in: query
          description: A search term.
          schema:
            type: string
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSMSMessageList'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    PaginatedSMSMessageList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/SMSMessage'
    SMSMessage:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        count:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        cost:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        phones:
          type: array
          items:
            type: string
            maxLength: 32
          nullable: true
        message:
          type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Создан
        type:
          allOf:
            - $ref: '#/components/schemas/TypeEnum'
          minimum: 0
          maximum: 32767
        document_id:
          type: integer
          nullable: true
          readOnly: true
        created_by_id:
          type: integer
          nullable: true
          readOnly: true
        status:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/StatusEnum'
            - $ref: '#/components/schemas/BlankEnum'
            - $ref: '#/components/schemas/NullEnum'
        client:
          type: string
          readOnly: true
        request_id:
          type: string
          readOnly: true
      required:
        - client
        - created_at
        - created_by_id
        - document_id
        - id
        - message
        - request_id
    TypeEnum:
      enum:
        - 0
        - 1
        - 2
      type: integer
      description: |-
        * `0` - Обычное сообщение
        * `1` - Документ
        * `2` - Одноразовый код
    StatusEnum:
      enum:
        - PENDING
        - DELIVERED
        - FAILED
      type: string
      description: |-
        * `PENDING` - Ожидает
        * `DELIVERED` - Доставлено
        * `FAILED` - Ошибка
    BlankEnum:
      enum:
        - ''
    NullEnum:
      enum:
        - null
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````