Initiate an ELP assessment call

{
  "id": "elp_00000000-0000-0000-0000-000000000000",
  "status": "REQUESTED",
  "created_at": "2024-01-15T09:30:00Z",
  "call_id": "call_00000000-0000-0000-0000-000000000000",
  "carrier_id": "car_00000000-0000-0000-0000-000000000000",
  "phone_number": "string",
  "driver_name": "string",
  "carrier_name": "string",
  "mc_number": "string",
  "scoring_status": "PENDING",
  "conversational_communication": 1,
  "instruction_comprehension": 1,
  "sign_recognition": 1,
  "verbal_reporting": 1,
  "total_score": 1,
  "total_questions": 1,
  "questions_answered": 1,
  "valid_answers": 1,
  "notes": "string",
  "call": {
    "id": "call_00000000-0000-0000-0000-000000000000",
    "status": "string",
    "call_time": "2024-01-15T09:30:00Z",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "call_direction": "string",
    "phone_number": "string",
    "to_number": "string",
    "from_number": "string",
    "call_start_time": "2024-01-15T09:30:00Z",
    "call_end_time": "2024-01-15T09:30:00Z",
    "transcript": [
      {
        "role": "string",
        "content": "string",
        "id": "string",
        "timestamp": "string",
        "interrupted": true,
        "transcript_confidence": 1.1,
        "tool_calls": [
          {
            "id": "",
            "type": "",
            "function": {
              "name": "",
              "arguments": null
            }
          }
        ],
        "tool_call_id": "string"
      }
    ]
  }
}

Place an outbound call to a driver and run the FMCSA-aligned English Language Proficiency assessment. Creates an ELP test record in REQUESTED state, places the call, and links the two. Poll GET /v1/elp/tests/{test_id} to follow the test through to scoring.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

phone_numberstringRequired

Driver phone number to call (E.164 format)

Response

Successful Response

idstringformat: "^elp_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

statusenum

Lifecycle state of an ELP test.

Tracks whether the test ran, not its outcome quality. Outcome quality lives in the per-competency scores and the question counters (questions_answered, valid_answers). The system never renders a pass/fail verdict.

created_atdatetime

call_idstringformat: "^call_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

carrier_idstringformat: "^car_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

phone_numberstring or null

driver_namestring or null

carrier_namestring or null

mc_numberstring or null

scoring_statusenum or null

Status of the post-call scoring pipeline.

conversational_communicationinteger or null

instruction_comprehensioninteger or null

sign_recognitioninteger or null

verbal_reportinginteger or null

total_scoreinteger or null

total_questionsinteger or null

questions_answeredinteger or null

valid_answersinteger or null

notesstring or null

callobject or null

Associated phone call with transcript

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

$	curl -X POST https://tryenvoy.ai/api/v1/elp/tests \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"phone_number": "string"
>	}'

Authentication

Headers

Request

Response

Errors