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



## OpenAPI

````yaml /openapi/integrations.json get /v1/crm/integrations/ringostat/calls/
openapi: 3.0.3
info:
  title: Yume API — Интеграции
  version: 1.0.0
  description: Подключение и управление внешними сервисами.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/crm/integrations/ringostat/calls/:
    get:
      tags:
        - ringostat
      summary: Get calls
      operationId: ringostat_calls_list
      parameters:
        - in: query
          name: end_at
          schema:
            type: string
            format: date-time
          description: >-
            End of the period. A date (YYYY-MM-DD) or a timestamp. Defaults to
            the first of the next month.
        - 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
        - in: query
          name: phone
          schema:
            type: string
          description: Outside number to filter the calls by.
        - in: query
          name: start_at
          schema:
            type: string
            format: date-time
          description: >-
            Start of the period, inclusive. A date (YYYY-MM-DD) or a timestamp.
            Defaults to the first of the current month.
        - in: query
          name: status
          schema:
            type: array
            items:
              type: string
          description: >-
            Call outcomes to keep, repeated once per value:
            ?status=ANSWERED&status=NO ANSWER.
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRingostatResultList'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    PaginatedRingostatResultList:
      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/RingostatResult'
    RingostatResult:
      type: object
      properties:
        caller:
          type: string
          readOnly: true
        dst:
          type: string
          readOnly: true
        pool_name:
          type: string
          readOnly: true
        disposition:
          type: string
          readOnly: true
        calldate:
          type: string
          format: date-time
          readOnly: true
        category_mark:
          type: string
          readOnly: true
        duration:
          type: integer
          readOnly: true
        call_type:
          type: string
          readOnly: true
        waittime:
          type: integer
          readOnly: true
        billsec:
          type: integer
          readOnly: true
        connected_with:
          type: string
          readOnly: true
        call_counter:
          type: integer
          readOnly: true
        proper_flag:
          type: boolean
          readOnly: true
        repeated_flag:
          type: boolean
          readOnly: true
        utm_source:
          type: string
          readOnly: true
        utm_medium:
          type: string
          readOnly: true
        utm_campaign:
          type: string
          readOnly: true
        utm_content:
          type: string
          readOnly: true
        utm_term:
          type: string
          readOnly: true
        uniqueid:
          type: string
          readOnly: true
        category_number:
          type: string
          readOnly: true
        employee_number:
          type: string
          readOnly: true
        employee_mark:
          type: string
          readOnly: true
        client_id:
          type: string
          readOnly: true
        remote_ip:
          type: string
          readOnly: true
        refferrer:
          type: string
          format: uri
          readOnly: true
        landing:
          type: string
          format: uri
          readOnly: true
        call_card:
          type: string
          format: uri
          readOnly: true
        additional_number:
          type: string
          readOnly: true
        has_recording:
          type: boolean
          readOnly: true
        scheme_name:
          type: string
          readOnly: true
        duration_ms:
          type: integer
          readOnly: true
        employee_fio:
          type: string
          readOnly: true
        department:
          type: string
          readOnly: true
        caller_number:
          type: string
          readOnly: true
        recording:
          type: string
          format: uri
          readOnly: true
        recording_wav:
          type: string
          format: uri
          readOnly: true
        yume_client_name:
          type: string
          readOnly: true
        yume_client_id:
          type: string
          readOnly: true
      required:
        - additional_number
        - billsec
        - call_card
        - call_counter
        - call_type
        - calldate
        - caller
        - caller_number
        - category_mark
        - category_number
        - client_id
        - connected_with
        - department
        - disposition
        - dst
        - duration
        - duration_ms
        - employee_fio
        - employee_mark
        - employee_number
        - has_recording
        - landing
        - pool_name
        - proper_flag
        - recording
        - recording_wav
        - refferrer
        - remote_ip
        - repeated_flag
        - scheme_name
        - uniqueid
        - utm_campaign
        - utm_content
        - utm_medium
        - utm_source
        - utm_term
        - waittime
        - yume_client_id
        - yume_client_name
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````