POST
/
calls
curl --request POST \
  --url https://api.prod.usesimple.ai/api/v1/calls \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "to_number": "+12345678900",
  "from_number_id": "123e4567-e89b-12d3-a456-426614174000",
  "record": false,
  "language": "en",
  "prompt": "Hello, I'\''m calling to confirm your appointment",
  "boost_keywords": [
    "appointment",
    "schedule",
    "morning"
  ],
  "agent_id": "123e4567-e89b-12d3-a456-426614174000",
  "params": {
    "appointment_type": "morning",
    "customer_id": "123456"
  },
  "external_identifiers": {
    "customer_id": "CUST-123456",
    "order_id": "ORD-789012"
  },
  "analyzers": [
    {
      "prompt": "<string>",
      "title": "<string>",
      "output_config": {
        "type": "string",
        "properties": {}
      }
    }
  ]
}'
{
  "success": true,
  "status": "<string>",
  "uuid": "<string>",
  "record": true,
  "language": "en",
  "answered_by": "voicemail",
  "analyzers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "output_config": {
        "type": "string",
        "properties": {}
      }
    }
  ],
  "analysis_results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "output_config": {},
      "result": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Body

application/json

Request to initiate an AI phone call

Response

200
application/json

Successful Response

The response is of type object.