Skip to main content
POST
/
api
/
v1
/
track-and-trace
/
trigger-check-call
Trigger a check call
curl --request POST \
  --url https://api.fleetworks.ai/api/v1/track-and-trace/trigger-check-call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "toPhone": "+15551234567",
  "waitingAtFacility": true,
  "nextStopIndex": 0,
  "loadNumber": "FW-123456",
  "metadata": {
    "internal_load_id": "ABC123",
    "customer_id": "12345",
    "priority": 1
  }
}'
{
  "success": true,
  "call": {
    "id": 12345,
    "fromPhone": "+15551234567",
    "toPhone": "+15559876543",
    "status": "IN_PROGRESS",
    "conversationId": 67890,
    "createdAt": "2024-03-15T14:30:00.000Z",
    "updatedAt": "2024-03-15T14:35:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

An authentication token that identifies the organization associated with the event. You can reach out to FleetWorks team to request a token.

Body

application/json
​
toPhone
string
required

Phone number to call in E.164 format. Must include country code with + prefix (e.g., +15551234567). For extensions, append ;ext= followed by the extension number (e.g., +15551234567;ext=123).

Example:

"+15551234567"

​
nextStopIndex
integer
required

The index of the next stop in the load's stop sequence (0-based). For example, 0 for the first stop (pickup), 1 for the second stop, etc. The stop information (appointment times, location) will be retrieved from the load data stored in FleetWorks.

Required range: x >= 0
Example:

0

​
loadNumber
string
required

Your load reference number. This is used for context during the call and in the extracted data.

Example:

"FW-123456"

​
waitingAtFacility
boolean

Optional. Set to true if the driver is already at the facility (shipper for pickup, receiver for dropoff). Helps the agent skip unnecessary ETA questions.

​
metadata
object

Optional. Custom metadata as key-value pairs that will be included in webhook events. This allows you to map calls back to your internal systems when receiving webhooks. Values can be strings or numbers.

Example:
{
  "internal_load_id": "ABC123",
  "customer_id": "12345",
  "priority": 1
}

Response

Success

​
success
boolean
​
call
object | null

Call details if the call was successfully initiated.

⌘I