Callfire · Schema

PostCallsRequest

CompanyCommunicationsCloudMessagingVoice

Properties

Name	Type	Description
attributes	object	Map of user-defined string attributes associated with recipient.
contactId	integer	An id of existing contact used as recipient.
dialplanXml	string	An IVR xml document describing dialplan.
fromNumber	string	~
liveMessage	string	Text to be turned into a sound, this will be played when the phone is answered.
liveMessageSoundId	integer	An id of a sound file to play if phone is answered.
machineMessage	string	Text to be turned into a sound, this will be played when answering machine is detected.
machineMessageSoundId	integer	An id of a sound file to play if answering machine is detected.
phoneNumber	string	Recipient's phone number in E.164 format.
transferDigit	string	A digit pressed to initiate the transfer.
transferMessage	string	Text to be turned into a sound, this will be played when the transfer digit is pressed.
transferMessageSoundId	integer	An id of a sound file to play if call is transferred.
transferNumber	string	Phone number to transfer the call to.
voice	string	The voice to be used.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/callfire/main/json-schema/callfire-post-calls-request-schema.json",
  "title": "PostCallsRequest",
  "x-generated": "2026-10-06",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/callfire-openapi-generated.yml#/components/schemas/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."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/callfire-post-calls-request"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.