TalkPush Calls API API

openapi: 3.2.0
info:
  description: '<b>Production Base URL to be used during implementation:</b> {your company workspace subdomain}.talkpush.com/api/talkpush_services


    With the Talkpush APIs you can instantly plug your lead source into out platform to enjoy the benefits of Talkpush. You can also synch your <b> existing HR / Recruitment technology stack </b> with your Talkpush account. To be able to use our API you will need pass an api key as a parameter for each API call.  In case you do not know your current API key you can contact our support team at cs@talkpush.com.

    '
  version: '2.0'
  title: Talkpush Agents Calls API
  contact:
    email: admin@talkpush.com
servers:
- url: https://company_subdomain.talkpush.com/api/talkpush_services
tags:
- name: Calls API
  description: Collection of endpoints related to calls data
paths:
  /calls:
    get:
      tags:
      - Calls API
      summary: Retrieve a list of calls within a date range
      description: This endpoint returns a paginated list of calls within the specified date range. Each call record includes the associated app_id. The start_date and end_date parameters are required and must be in DD-MM-YYYY format.
      parameters:
      - name: api_key
        in: query
        description: The API key provided for your application.
        required: true
        schema:
          type: string
      - name: start_date
        in: query
        description: Start of the date range filter. Date format must be DD-MM-YYYY (e.g., 01-02-2026). Required.
        required: true
        schema:
          type: string
      - name: end_date
        in: query
        description: End of the date range filter. Date format must be DD-MM-YYYY (e.g., 13-02-2026). Required.
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: Page number of the results to return. Default is 1.
        required: false
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: Calls were returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/calls_response'
        '400':
          description: 'Bad request. Possible messages:

            - ''start_date and end_date are required'' (when required date parameters are missing).

            - ''Invalid date format. Use DD-MM-YYYY (e.g., 01-02-2026)'' (when date parameters are not in the expected format).'
        '401':
          description: Invalid API key.
        '500':
          description: Internal server error, we will provide you with the exception message of the application.
components:
  schemas:
    calls_pagination:
      type: object
      properties:
        page:
          type: integer
          description: The current page number.
        per_page:
          type: integer
          description: The number of records per page.
        total_records:
          type: integer
          description: The total number of call records matching the query.
        total_pages:
          type: integer
          description: The total number of pages available.
    call_body:
      type: object
      properties:
        call_id:
          type: string
          description: The unique identifier of the call.
        app_id:
          type: string
          description: The application ID associated with the call.
        call_type:
          type: string
          description: The type of the call. E.g. "OUTBOUND", "INBOUND".
        direction:
          type: string
          description: The direction of the call. E.g. "OUT", "IN".
        from_number:
          type: string
          description: The phone number that initiated the call.
        to_number:
          type: string
          description: The phone number that received the call.
        status:
          type: string
          description: 'The status of the call. Possible values: "no_answer", "ringing", "busy", "answered", "failed", "cancelled", "unanswered", "started", "timeout", "rejected", "completed".'
        duration_seconds:
          type: integer
          description: The duration of the call in seconds.
        started_at:
          type: string
          format: date-time
          description: The timestamp when the call started. ISO 8601 format.
        ended_at:
          type:
          - string
          - 'null'
          format: date-time
          description: The timestamp when the call ended. ISO 8601 format. Null if the call was not answered.
        manager_email:
          type: string
          description: The email of the Talkpush CRM user (recruiter/manager) who handled the call.
        candidate_id:
          type: string
          description: The unique candidate identifier associated with the call.
        campaign_id:
          type: string
          description: The ID of the campaign associated with the call.
        recording_url:
          type:
          - string
          - 'null'
          description: The URL of the call recording, if available.
    calls_response:
      type: object
      properties:
        start_date:
          type: string
          description: The start date of the requested date range. Format DD-MM-YYYY.
        end_date:
          type: string
          description: The end date of the requested date range. Format DD-MM-YYYY.
        pagination:
          $ref: '#/components/schemas/calls_pagination'
        calls:
          type: array
          items:
            $ref: '#/components/schemas/call_body'