Skip to main content
POST
/
api
/
v1
/
track-and-trace
/
trigger-check-call-by-load
Trigger a check call, providing stops
curl --request POST \
  --url https://api.fleetworks.ai/api/v1/track-and-trace/trigger-check-call-by-load \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "toPhone": "+15551234567",
  "callType": "pickup",
  "waitingAtFacility": true,
  "nextStopApptStart": "2025-03-06T08:00:00",
  "nextStopApptEnd": "2025-03-06T10:00:00",
  "nextStopCity": "Chicago",
  "nextStopState": "IL",
  "loadNumber": "FW-123456",
  "loadStops": [
    {
      "type": "pickup",
      "address": {
        "city": "Chicago",
        "state": "IL"
      },
      "windowStart": "2025-03-06T08:00:00",
      "windowEnd": "2025-03-06T10:00:00"
    },
    {
      "type": "dropoff",
      "address": {
        "city": "New York",
        "state": "NY"
      },
      "windowStart": "2025-03-08T08:00:00",
      "windowEnd": "2025-03-08T10:00:00"
    }
  ],
  "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"

​
callType
enum<string>
required

Type of check-call the agent should run: • pickup (before/during pickup stop) • dropoff (before/during drop-off stop) Pick the one that best matches the driver's next stop.

Available options:
pickup,
dropoff
Example:

"pickup"

​
nextStopApptStart
string
required

Start of the appointment window (local stop-timezone).

Example:

"2025-03-06T08:00:00"

​
nextStopApptEnd
string
required

End of the appointment window for the next stop. Use the same value as start for FCFS.

Example:

"2025-03-06T10:00:00"

​
nextStopCity
string
required

City of the next stop.

​
nextStopState
string
required

State / province abbreviation of the next stop.

Example:

"IL"

​
loadNumber
string
required

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

Example:

"FW-123456"

​
loadStops
object[]
required

Required. Ordered list of all stops on the load. The agent uses this for context and the last stop in the array is used to determine the final destination information (city, state, appointment times).

​
reeferTemp
string

Optional. Target trailer temperature (e.g. 34). If provided, the load is considered a reefer load. Including it lets the agent confirm the driver is at the correct reefer temp. Also supports ranges.

​
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.

​
trackingOperatorPhone
string

Optional. Phone number to escalate the call to if the driver requests to speak with dispatch. Should be an E.164 formatted number (e.g. +15551234567).

Example:

"+15551234567"

​
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