For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
GuidesAPI Reference
GuidesAPI Reference
  • Endpoints
      • POSTInitiate an ELP assessment call
      • GETList ELP assessment tests
      • GETGet an ELP test
LogoLogo
SupportDashboard
EndpointsELP

Initiate an ELP assessment call

POST
/elp/tests
POST
/api/v1/elp/tests
$curl -X POST https://tryenvoy.ai/api/v1/elp/tests \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "phone_number": "string"
>}'
1{
2  "id": "elp_00000000-0000-0000-0000-000000000000",
3  "status": "REQUESTED",
4  "created_at": "2024-01-15T09:30:00Z",
5  "call_id": "call_00000000-0000-0000-0000-000000000000",
6  "carrier_id": "car_00000000-0000-0000-0000-000000000000",
7  "phone_number": "string",
8  "driver_name": "string",
9  "carrier_name": "string",
10  "mc_number": "string",
11  "scoring_status": "PENDING",
12  "conversational_communication": 1,
13  "instruction_comprehension": 1,
14  "sign_recognition": 1,
15  "verbal_reporting": 1,
16  "total_score": 1,
17  "total_questions": 1,
18  "questions_answered": 1,
19  "valid_answers": 1,
20  "notes": "string",
21  "call": {
22    "id": "call_00000000-0000-0000-0000-000000000000",
23    "status": "string",
24    "call_time": "2024-01-15T09:30:00Z",
25    "created_at": "2024-01-15T09:30:00Z",
26    "updated_at": "2024-01-15T09:30:00Z",
27    "call_direction": "string",
28    "phone_number": "string",
29    "to_number": "string",
30    "from_number": "string",
31    "call_start_time": "2024-01-15T09:30:00Z",
32    "call_end_time": "2024-01-15T09:30:00Z",
33    "transcript": [
34      {
35        "role": "string",
36        "content": "string",
37        "id": "string",
38        "timestamp": "string",
39        "interrupted": true,
40        "transcript_confidence": 1.1,
41        "tool_calls": [
42          {
43            "id": "",
44            "type": "",
45            "function": {
46              "name": "",
47              "arguments": null
48            }
49          }
50        ],
51        "tool_call_id": "string"
52      }
53    ]
54  }
55}

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.

Was this page helpful?
Previous

List ELP assessment tests

Next
Built with

Authentication

AuthorizationBearer

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

Headers

X-Organization-IDstring or nullOptional

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.

Allowed values:
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.

Allowed values:
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