Skip to main content
POST
/
call
cURL
curl --request POST \
  --url https://www.getrevox.com/api/call \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>"
}
'
{
  "call": {
    "id": "<string>",
    "from_phone_number": "<string>",
    "to_phone_number": "<string>",
    "direction": "inbound",
    "is_completed": true,
    "calls_count": 123,
    "next_call_at": "<unknown>",
    "last_call_attempt": {
      "id": "<string>",
      "phone_number": "<string>",
      "status": "queued",
      "result": "IVR",
      "recording_url": "<string>",
      "started_at": "<unknown>",
      "answered_at": "<unknown>",
      "ended_at": "<unknown>",
      "transcript": [
        {
          "role": "user",
          "content": "<string>"
        }
      ],
      "structured_output": {}
    },
    "call_retry_config": {
      "calling_window_start_time": "<string>",
      "calling_window_end_time": "<string>",
      "retry_delay_seconds": 7200,
      "max_retry_attempts": 3,
      "timezone": "<string>"
    },
    "llm_model": {
      "type": "dedicated-instance",
      "name": "gpt-4.1"
    },
    "call_attempts": [
      {
        "id": "<string>",
        "phone_number": "<string>",
        "status": "queued",
        "result": "IVR",
        "recording_url": "<string>",
        "started_at": "<unknown>",
        "answered_at": "<unknown>",
        "ended_at": "<unknown>",
        "transcript": [
          {
            "role": "user",
            "content": "<string>"
          }
        ],
        "structured_output": {}
      }
    ],
    "created_at": "<unknown>"
  }
}

Headers

​
authorization
string

Bearer auth token. Example: Bearer sk_123...

Body

application/json

Body

​
phone_number
string
required

The phone number to call in the E.164 format. Example: +1234567890

​
force_now
boolean

The prompt to use for the call. This will be given to the LLM (gpt-4.1)

​
from_phone_number
string

The phone number to use for making the call (e.g., +1234567890). If not provided, uses the default trunk.

​
prompt_variables
object

Variables to interpolate into the prompt. Wether you use an assistant_id or an assistant object, this will be used to interpolate the variables into the prompt.

​
assistant_id
string

The ID of the assistant to use for this call.

​
assistant
object

You can provide a custom assistant configuration here. If you don't provide an assistant_id, this assistant object will be used for this call.

Response

200 - application/json

200

​
call
object
required

This represent a call "order" that was requested by the user. A call order can be resolved over multiple call attempts spanning up to a few days.