Calls

Trigger a new call

Initiates a new call using a specific assistant ID. The request body must contain at least a phone number. Optionally, a callback_url can be provided where Callbook AI will send call results after completion.

post/crm/webhook/new_call/api/{ASSISTANT_ID}

Request

  • Base URL: https://api.callbook.ai
  • URL: https://api.callbook.ai/crm/webhook/new_call/api/{ASSISTANT_ID}
  • Auth: HTTP bearer

Path parameters

ASSISTANT_IDstring required
Example:assistant_123456

The unique identifier of the assistant initiating the call.

Request body

phonestring

The customer's phone number (required).

namestring

The customer's name (optional but recommended).

callback_urlstring uri

(Optional) A webhook URL where Callbook AI will send the call results after completion.

next_paymentstring

(Optional) The customer's next payment date.

last_purchase_datestring

(Optional) The last date of purchase.

product_intereststring

(Optional) The product or service the customer is interested in.

locationstring

(Optional) The customer's location.

Example request

{
  "phone": "+14155552671",
  "name": "John Doe",
  "callback_url": "https://yourserver.com/webhook/call_results",
  "next_payment": "2025-02-10",
  "last_purchase_date": "2025-01-15",
  "product_interest": "Premium Plan",
  "location": "New York"
}

Response

Call successfully triggered.

statusstring
call_idstring

Example response

{
  "status": "success",
  "call_id": "call_789456"
}

Changes

No recorded changes to this operation across all 1 revision of this API.