openapi: 3.1.0
info:
  title: Callfire API
  version: '2026-10-06'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-06: 33 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Callfire has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 25
    documentation: 8
    pages-with-code: 6
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-06'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.callfire.com/webhooks-guide.html
  - https://developers.callfire.com/docs.html
  - https://developers.callfire.com/contacts-guide.html
  - https://developers.callfire.com/security-guide.html
  - https://developers.callfire.com/legacy-migration.html
  - https://developers.callfire.com/usecase-sms-chat.html
  - https://developers.callfire.com/quick-start-guide.html
servers:
- url: https://api.callfire.com
paths:
  /callfirexml/campaign:
    post:
      operationId: post_callfirexml_campaign
      tags:
      - Callfirexml
      summary: Callfire XML Campaign
      x-source: https://developers.callfire.com/legacy-migration.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /callfirexml/campaign/{id}:
    put:
      operationId: put_callfirexml_campaign_id
      tags:
      - Callfirexml
      summary: Callfire XML Campaign
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /calls:
    get:
      operationId: get_calls
      tags:
      - Calls
      summary: Find calls get
      description: Search for all calls sent or received by the user.
      x-source: https://developers.callfire.com/docs.html
      parameters:
      - name: fields
        in: query
        required: false
        schema:
          type: string
        description: Limit fields received in response.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of records to return.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
        description: Offset to the start of a given page.
      - name: id
        in: query
        required: false
        schema:
          type: array
        description: Lists the Call ids to search for.
      - name: campaignId
        in: query
        required: false
        schema:
          type: integer
        description: An id of a campaign.
      - name: batchId
        in: query
        required: false
        schema:
          type: integer
        description: An id of a contact batch.
      - name: fromNumber
        in: query
        required: false
        schema:
          type: string
        description: Phone number the call was from.
      - name: toNumber
        in: query
        required: false
        schema:
          type: string
        description: Phone number the call was sent to.
      - name: label
        in: query
        required: false
        schema:
          type: string
        description: A label for a specific call.
      - name: states
        in: query
        required: false
        schema:
          type: string
        description: Comma separated list of call states.
      - name: results
        in: query
        required: false
        schema:
          type: string
        description: Comma separated list of call results.
      - name: inbound
        in: query
        required: false
        schema:
          type: boolean
        description: Filters inbound calls.
      - name: intervalBegin
        in: query
        required: false
        schema:
          type: integer
        description: Start of the find time interval (ms).
      - name: intervalEnd
        in: query
        required: false
        schema:
          type: integer
        description: End of the find time interval (ms).
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCallsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_calls
      tags:
      - Calls
      summary: Send calls post
      description: Use the /calls API to send individual calls quickly.
      x-source: https://developers.callfire.com/docs.html
      parameters:
      - name: fields
        in: query
        required: false
        schema:
          type: string
        description: Limit fields received in response.
      - name: campaignId
        in: query
        required: false
        schema:
          type: integer
        description: Specifies a campaignId to send calls quickly on a previously created campaign
      - name: defaultLiveMessage
        in: query
        required: false
        schema:
          type: string
        description: Text to be turned into a sound, this text will be played when the phone is answered.
      - name: defaultMachineMessage
        in: query
        required: false
        schema:
          type: string
        description: Text to be turned into a sound, this text will be played when answering machine is detected.
      - name: defaultLiveMessageSoundId
        in: query
        required: false
        schema:
          type: integer
        description: Id of sound file to play if phone is answered.
      - name: defaultMachineMessageSoundId
        in: query
        required: false
        schema:
          type: integer
        description: An id of a sound file to play if answering machine is detected.
      - name: defaultVoice
        in: query
        required: false
        schema:
          type: string
        description: The voice set by default for all text-to-speech messages.
      - name: strictValidation
        in: query
        required: false
        schema:
          type: boolean
        description: Turns on strict validation for recipients.
      - name: body
        in: query
        required: true
        schema:
          type: array
        description: List of CallRecipient objects.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCallsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCallsResponse'
      x-evidence:
        kind: documentation
  /calls/broadcasts:
    get:
      operationId: get_calls_broadcasts
      tags:
      - Calls
      summary: Find call broadcasts get
      description: Search for all voice broadcasts created by user.
      x-source: https://developers.callfire.com/docs.html
      parameters:
      - name: fields
        in: query
        required: false
        schema:
          type: string
        description: Limit fields received in response.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of records to return.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
        description: Offset to the start of a given page.
      - name: label
        in: query
        required: false
        schema:
          type: string
        description: A label of a voice broadcast.
      - name: name
        in: query
        required: false
        schema:
          type: string
        description: A name of voice broadcast.
      - name: running
        in: query
        required: false
        schema:
          type: boolean
        description: Specify whether the campaigns should be running.
      - name: scheduled
        in: query
        required: false
        schema:
          type: boolean
        description: Specify whether the campaigns should be scheduled.
      - name: intervalBegin
        in: query
        required: false
        schema:
          type: integer
        description: Start of the find time interval (ms).
      - name: intervalEnd
        in: query
        required: false
        schema:
          type: integer
        description: End of the find time interval (ms).
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCallsBroadcastsResponse'
      x-evidence:
        kind: documentation
  /campaign/{campaignid}/call:
    post:
      operationId: post_campaign_campaignid_call
      tags:
      - Campaign
      summary: Sending Calls
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: campaignid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /files/recording/dynamic/{hash}/{year}/{month}/{campaign}/{filename}:
    get:
      operationId: get_files_recording_dynamic_hash_year_month_campaign_filename
      tags:
      - Files
      summary: GET /files/recording/dynamic/{hash}/{year}/{month}/{campaign}/{filename}
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: hash
        in: path
        required: true
        schema:
          type: string
      - name: year
        in: path
        required: true
        schema:
          type: string
      - name: month
        in: path
        required: true
        schema:
          type: string
      - name: campaign
        in: path
        required: true
        schema:
          type: string
      - name: filename
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /files/recording/dynamic/{hash}/{year}/{month}/{campaign}/{filename}/mp3:
    get:
      operationId: get_files_recording_dynamic_hash_year_month_campaign_filename_mp3
      tags:
      - Files
      summary: GET /files/recording/dynamic/{hash}/{year}/{month}/{campaign}/{filename}/mp3
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: hash
        in: path
        required: true
        schema:
          type: string
      - name: year
        in: path
        required: true
        schema:
          type: string
      - name: month
        in: path
        required: true
        schema:
          type: string
      - name: campaign
        in: path
        required: true
        schema:
          type: string
      - name: filename
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /files/recording/list/{campid}/{callid}:
    get:
      operationId: get_files_recording_list_campid_callid
      tags:
      - Files
      summary: GET /files/recording/list/{campid}/{callid}
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: campid
        in: path
        required: true
        schema:
          type: string
      - name: callid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /files/recording/{fileid}:
    get:
      operationId: get_files_recording_fileid
      tags:
      - Files
      summary: GET /files/recording/{fileid}
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: fileid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /inbound/numbers:
    get:
      operationId: get_inbound_numbers
      tags:
      - Inbound
      summary: Phone Numbers
      x-source: https://developers.callfire.com/legacy-migration.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_inbound_numbers
      tags:
      - Inbound
      summary: Phone Numbers
      x-source: https://developers.callfire.com/legacy-migration.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /reports/call/{callid}:
    get:
      operationId: get_reports_call_callid
      tags:
      - Reports
      summary: Reports
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: callid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /reports/callback/callfinish/{campaignid}:
    post:
      operationId: post_reports_callback_callfinish_campaignid
      tags:
      - Reports
      summary: Callbacks
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: campaignid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /reports/callback/{callbackid}:
    post:
      operationId: post_reports_callback_callbackid
      tags:
      - Reports
      summary: Callbacks
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: callbackid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at callbackId
  /reports/calls/finished/{campaignid}:
    get:
      operationId: get_reports_calls_finished_campaignid
      tags:
      - Reports
      summary: Reports
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: campaignid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /reports/calls/{campaignid}:
    get:
      operationId: get_reports_calls_campaignid
      tags:
      - Reports
      summary: Reports
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: campaignid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /service/clicktocall/sendconnect:
    get:
      operationId: get_service_clicktocall_sendconnect
      tags:
      - Service
      summary: GET /service/clicktocall/sendconnect
      x-source: https://developers.callfire.com/legacy-migration.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /sms/send:
    post:
      operationId: post_sms_send
      tags:
      - Sms
      summary: SMS API
      x-source: https://developers.callfire.com/legacy-migration.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /utils/getNumberDetails:
    get:
      operationId: get_utils_getNumberDetails
      tags:
      - Utils
      summary: GET /utils/getNumberDetails
      x-source: https://developers.callfire.com/legacy-migration.html
      parameters:
      - name: npanxs
        in: query
        required: true
        schema:
          type: string
        description: AREA_CODE
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2:
    get:
      operationId: get_v2
      tags:
      - Api
      summary: GET /v2
      x-source: https://developers.callfire.com/docs.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \n C#.NET \n Java \n JS \n Python \n PHP \n Go -->\n API Reference \n The CallFire Developers API V2 is built from the\
          \ ground up as a REST API. Easy to understand resource URLs, more features and functionality, and adherence to industry practices makes\
          \ the CallFire API V2 better. Using many HTTP standards and features, the API can be consumed by any HTTP client, and no 3rd party SDKs\
          \ are required. JS"
  /v2/calls/broadcasts:
    get:
      operationId: get_v2_calls_broadcasts
      tags:
      - Calls
      summary: GET /v2/calls/broadcasts
      x-source: https://developers.callfire.com/docs.html
      parameters:
      - name: name
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2CallsBroadcastsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u username:password -H \"Content-Type:application/json\" -X GET \" https://api.callfire.com/v2/calls/broadcasts?name=broadcast\
          \ name&label=my label&running=true&offset=0&limit=10&fields=items(id,name,status,sounds)&scheduled=false&intervalBegin=1473781817000&intervalEnd=1473781817000\"\
          \ \n Example Response \n {\n \"items\": [\n {\n \"id\": 14,\n \"name\": \"Example API VB\",\n \"status\": \"STOPPED\",\n \"lastModified"
    post:
      operationId: post_v2_calls_broadcasts
      tags:
      - Calls
      summary: POST /v2/calls/broadcasts
      x-source: https://developers.callfire.com/docs.html
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV2CallsBroadcastsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u username:password -H \"Content-Type:application/json\" -X POST -d '\n {\n \"name\":\"Example API Call Broadcast\",\n\
          \ \"fromNumber\":\"12135551189\",\n \"recipients\":\n [\n {\n \"phoneNumber\":\"2134441133\"\n },\n {\n \"phoneNumber\":\"2135551144\"\
          \n }\n ],\n \"answeringMachineConfig\":\"AM_AND_LIVE\",\n \"sounds\":\n {\n \"liveSoundText\":\"Hello! This is a live answer text to\
          \ speech recording\",\n \"machineSoundText\":\"This is an answ"
  /v2/calls/broadcasts/{broadcastid}:
    put:
      operationId: put_v2_calls_broadcasts_broadcastid
      tags:
      - Calls
      summary: PUT /v2/calls/broadcasts/{broadcastId}
      x-source: https://developers.callfire.com/docs.html
      parameters:
      - name: broadcastid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u username:password -H \"Content-Type:application/json\" -X PUT -d '\n {\n \"name\":\"Call Broadcast with Schedules\"\
          ,\n \"answeringMachineConfig\":\"LIVE_IMMEDIATE\",\n \"sounds\":\n {\n \"liveSoundText\":\"Hello! This is an updated Call Broadcast\
          \ config tts\"\n },\n \"schedules\": [\n {\n \"startTimeOfDay\":\n {\n \"hour\": 10,\n \"minute\": 0,\n \"second\": 0\n },\n \"stopTimeOfDay\"\
          :\n {\n \"hour\": 18,\n \"minute\": 0,\n \"second\": 0\n },\n"
  /v2/calls/broadcasts/{broadcastid}/{id}:
    post:
      operationId: post_v2_calls_broadcasts_broadcastid_id
      tags:
      - Calls
      summary: POST /v2/calls/broadcasts/{broadcastId}/archive
      x-source: https://developers.callfire.com/docs.html
      parameters:
      - name: broadcastid
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV2CallsBroadcastsBroadcastidIdResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u username:password -H \"Content-Type:application/json\" -X POST \" https://api.callfire.com/v2/calls/broadcasts/11646003/archive\
          \ \" \n Example Response \n 200 OK - No Response \n Sample Code \n Sample Code \n import com.callfire.api.client.CallfireClient; \n\
          \ class ApiClientSample {\n public static void main(String[] args) {\n CallfireClient callfireClient = new CallfireClient(\"api_login\"\
          , \"api_password"
        collapsed_from: 2 example path(s) differing only at id
  /v2/calls/broadcasts/{id}/recipients:
    get:
      operationId: get_v2_calls_broadcasts_id_recipients
      tags:
      - Calls
      summary: GET /v2/calls/broadcasts/{id}/recipients
      x-source: https://developers.callfire.com/docs.html
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2CallsBroadcastsIdRecipientsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl' samples tab \n print(response) \n Add recipients to a call broadcast post \n Use this API to add the recipients to an\
          \ existing voice broadcast. Post a list of Recipient objects to be added to the voice broadcast campaign. These contacts will not go\
          \ through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of\
          \ numbers \n path \n "
  /v2/contacts/lists:
    post:
      operationId: post_v2_contacts_lists
      tags:
      - Contacts
      summary: POST /v2/contacts/lists
      x-source: https://developers.callfire.com/contacts-guide.html
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV2ContactsListsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u username:password -H \"Content-Type:application/json\" -X POST -d '\n {\n \"name\":\"My Contact List\",\n \"contacts\"\
          :\n [\n {\n \"firstName\": \"Alice\",\n \"lastName\": \"Moore\",\n \"homePhone\": \"12135551126\"\n },\n {\n \"firstName\": \"Bob\"\
          ,\n \"lastName\": \"Smith\",\n \"homePhone\": \"12135551127\",\n \"properties\": {\n \"age\": 30\n }\n }\n ]\n }' \"https://api.callfire.com/v2/contacts/lists\""
  /v2/contacts/lists/upload:
    post:
      operationId: post_v2_contacts_lists_upload
      tags:
      - Contacts
      summary: POST /v2/contacts/lists/upload
      x-source: https://developers.callfire.com/contacts-guide.html
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV2ContactsListsUploadResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u username:password -X POST -F \"name=My Contact List\" -F \"file=@contacts.csv\" -F \"useCustomFields=true\" \"https://api.callfire.com/v2/contacts/lists/upload\"\
          \ \n response: \n {\n \" id \": 4 \n } \n[-curl]\n[+java]\n import com.callfire.api.client.CallfireClient;\n import com.callfire.api.client.api.common.model.ResourceId;\n\
          \ import java.io.File;\n class ApiClientSample {\n public static void main(String[] "
  /v2/contacts/lists/{listid}/items:
    post:
      operationId: post_v2_contacts_lists_listid_items
      tags:
      - Contacts
      summary: POST /v2/contacts/lists/{listId}/items
      x-source: https://developers.callfire.com/contacts-guide.html
      parameters:
      - name: listid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u username:password -H \"Content-Type:application/json\" -X POST -d '\n {\n \"contacts\":\n [\n {\n \"firstName\":\"Alice\"\
          ,\n \"lastName\":\"Moore\",\n \"homePhone\":\"12135551126\"\n },\n {\n \"firstName\":\"Bob\",\n \"lastName\":\"Smith\",\n \"homePhone\"\
          :\"12135551127\",\n \"properties\":\n {\n \"age\":30\n }\n }\n ]\n }' \"https://api.callfire.com/v2/contacts/lists/45006708003/items\""
  /v2/me/callerids/{calleridid}:
    post:
      operationId: post_v2_me_callerids_calleridid
      tags:
      - Me
      summary: POST /v2/me/callerids/{calleridId}
      x-source: https://developers.callfire.com/quick-start-guide.html
      parameters:
      - name: calleridid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u \"username:password\" -H \"Content-Type:application/json\" -X POST \"https://api.callfire.com/v2/me/callerids/12135551175\"\
          \n send a POST request to /me/callerids/{callerid}/verification-code with the verification code in payload\nas shown in the example\
          \ below. The API operation returns 'true' if the code is accepted, or 'false' if the code is wrong. "
  /v2/me/callerids/{calleridid}/verification-code:
    post:
      operationId: post_v2_me_callerids_calleridid_verification_code
      tags:
      - Me
      summary: POST /v2/me/callerids/{calleridId}/verification-code
      x-source: https://developers.callfire.com/quick-start-guide.html
      parameters:
      - name: calleridid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u \"username:password\" -H \"Content-Type:application/json\" -X POST -d '\n {\n \"verificationCode\":\"1234\"\n }' \"\
          https://api.callfire.com/v2/me/callerids/12135551175/verification-code\"\n You may use several Caller IDs within one account."
  /v2/{v2id}:
    get:
      operationId: get_v2_v2id
      tags:
      - Api
      summary: GET /v2/calls
      x-source: https://developers.callfire.com/docs.html
      parameters:
      - name: v2id
        in: path
        required: true
        schema:
          type: string
      - name: batchId
        in: query
        required: false
        schema:
          type: string
      - name: campaignId
        in: query
        required: false
        schema:
          type: string
      - name: fromNumber
        in: query
        required: false
        schema:
          type: string
      - name: id
        in: query
        required: false
        schema:
          type: string
      - name: label
        in: query
        required: false
        schema:
          type: string
      - name: toNumber
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2V2IdResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl -u username:password -H "Content-Type:application/json" -X GET " https://api.callfire.com/v2/calls?id=11646003&id=12646003&id=13776003&campaignId=449060003&batchId=447060003&fromNumber=12135551126&toNumber=12136666123&label=my
          label&states=READY,FINISHED,INVALID&results=LA&inboubd=true&intervalBegin=1473781817000&intervalEnd=1473781817000&offset=0&limit=10&fields=items(id,fromNumber,toNumber,
        collapsed_from: 3 example path(s) differing only at v2Id
    post:
      operationId: post_v2_v2id
      tags:
      - Api
      summary: POST /v2/calls
      x-source: https://developers.callfire.com/docs.html
      parameters:
      - name: v2id
        in: path
        required: true
        schema:
          type: string
      - name: campaignId
        in: query
        required: false
        schema:
          type: string
      - name: defaultVoice
        in: query
        required: false
        schema:
          type: string
      - name: fields
        in: query
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV2V2IdResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -u username:password -H \"Content-Type:application/json\" -X POST -d '\n [\n {\n \"phoneNumber\": \"12135551100\",\n \"\
          liveMessage\": \"Hello, Alice, this is message for live answer\",\n \"machineMessage\": \"Hello, Alice, this is message for answering\
          \ machine\"\n },\n {\n \"phoneNumber\": \"12135551101\",\n \"liveMessage\": \"Hello, Bob, this is message for live answer\",\n \"machineMessage\"\
          : \"Hello, Bob, this is message fo"
        collapsed_from: 4 example path(s) differing only at v2Id
components:
  schemas:
    GetCallsResponse:
      type: object
      properties:
        items:
          type: array
          description: Array of Call objects.
        limit:
          type: integer
        offset:
          type: integer
        totalCount:
          type: integer
    PostCallsRequest:
      type: object
      properties:
        attributes:
          type: object
          description: Map of user-defined string attributes associated with recipient.
        contactId:
          type: integer
          description: An id of existing contact used as recipient.
        dialplanXml:
          type: string
          description: An IVR xml document describing dialplan.
        fromNumber:
          type: string
          description: '~'
        liveMessage:
          type: string
          description: Text to be turned into a sound, this will be played when the phone is answered.
        liveMessageSoundId:
          type: integer
          description: An id of a sound file to play if phone is answered.
        machineMessage:
          type: string
          description: Text to be turned into a sound, this will be played when answering machine is detected.
        machineMessageSoundId:
          type: integer
          description: An id of a sound file to play if answering machine is detected.
        phoneNumber:
          type: string
          description: Recipient's phone number in E.164 format.
        transferDigit:
          type: string
          description: A digit pressed to initiate the transfer.
        transferMessage:
          type: string
          description: Text to be turned into a sound, this will be played when the transfer digit is pressed.
        transferMessageSoundId:
          type: integer
          description: An id of a sound file to play if call is transferred.
        transferNumber:
          type: string
          description: Phone number to transfer the call to.
        voice:
          type: string
          description: The voice to be used.
    PostCallsResponse:
      type: object
      properties:
        items:
          type: array
          description: Array of Call objects.
    GetCallsBroadcastsResponse:
      type: object
      properties:
        items:
          type: array
          description: Array of CallBroadcast objects.
        totalCount:
          type: integer
    GetV2CallsBroadcastsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
              status:
                type: string
              lastModified:
                type: integer
              fromNumber:
                type: string
              localTimeRestriction:
                type: object
                properties:
                  enabled:
                    type: boolean
              retryConfig:
                type: object
                properties:
                  maxAttempts:
                    type: integer
                  minutesBetweenAttempts:
                    type: integer
                  retryPhoneTypes:
                    type: array
                    items:
                      type: string
              resumeNextDay:
                type: boolean
              answeringMachineConfig:
                type: string
              sounds:
                type: object
                properties:
                  liveSoundText:
                    type: string
                  liveSoundId:
                    type: integer
                  machineSoundText:
                    type: string
                  machineSoundId:
                    type: integer
        totalCount:
          type: integer
    PostV2CallsBroadcastsResponse:
      type: object
      properties:
        id:
          type: integer
    PostV2CallsBroadcastsBroadcastidIdResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              fromNumber:
                type: string
              toNumber:
                type: string
              state:
                type: string
              campaignId:
                type: integer
              batchId:
                type: integer
              contact:
                type: object
                properties:
                  id:
                    type: integer
                  homePhone:
                    type: string
              inbound:
                type: boolean
              created:
                type: integer
              modified:
                type: integer
              agentCall:
                type: boolean
    GetV2CallsBroadcastsIdRecipientsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              fromNumber:
                type: string
              toNumber:
                type: string
              state:
                type: string
              campaignId:
                type: integer
              batchId:
                type: integer
              contact:
                type: object
                properties:
                  id:
                    type: integer
                  homePhone:
                    type: string
              inbound:
                type: boolean
              created:
                type: integer
              modified:
                type: integer
              agentCall:
                type: boolean
    PostV2ContactsListsResponse:
      type: object
      properties:
        ' id ':
          type: integer
    PostV2ContactsListsUploadResponse:
      type: object
      properties:
        ' id ':
          type: integer
    GetV2V2IdResponse:
      type: object
      properties:
        id:
          type: integer
        fromNumber:
          type: string
        toNumber:
          type: string
        state:
          type: string
        campaignId:
          type: integer
        batchId:
          type: integer
        contact:
          type: object
          properties:
            id:
              type: integer
            homePhone:
              type: string
        labels:
          type: array
          items:
            type: string
        attributes:
          type: object
          properties:
            external_user_id:
              type: string
            external_route_id:
              type: string
        inbound:
          type: boolean
        created:
          type: integer
        modified:
          type: integer
        finalCallResult:
          type: string
        records:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              billedAmount:
                type: number
              finishTime:
                type: integer
              callResult:
                type: string
              questionResponses:
                type: array
                items:
                  type: object
                  properties:
                    question:
                      type: string
                    response:
                      type: string
        agentCall:
          type: boolean
    PostV2V2IdResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              fromNumber:
                type: string
              toNumber:
                type: string
              state:
                type: string
              campaignId:
                type: integer
              batchId:
                type: integer
              contact:
                type: object
                properties:
                  id:
                    type: integer
                  homePhone:
                    type: string
              inbound:
                type: boolean
              created:
                type: integer
              modified:
                type: integer
              agentCall:
                type: boolean
tags:
- name: Api
- name: Callfirexml
- name: Calls
- name: Campaign
- name: Contacts
- name: Files
- name: Inbound
- name: Me
- name: Reports
- name: Service
- name: Sms
- name: Utils