MEmentium
v2
outbound-calls

Initiate Sequential Calls

Start a sequential outbound calling workflow for a load.

This workflow will:

  1. Get ranked carriers from the recommendation system
  2. Call carriers one by one until the load is booked
  3. Wait for each call to complete before calling the next carrier
  4. Stop when a carrier books the load or all carriers are exhausted

The workflow can be stopped at any time using the stop endpoint. Progress can be monitored using the status endpoint.

post/v2/phone-calls/outbound/sequential

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Headers

mentium-workspace-idstring nullable

Request body

agent_idstring required

Outbound phone AI agent ID used for each call in the campaign

load_idstring required

TMS Load external reference ID

integration_connection_idstring required

Integration connection UUID for TMS

max_carriersinteger

Maximum number of carriers to call

delay_between_calls_secondsinteger

Delay between calls in seconds

call_timeout_secondsinteger

Max wait time for each call to complete (up to 15 mins)

workspace_phone_number_idstring nullable

Workspace phone number ID to use for outbound caller identity and linked phone agent resolution.

Response

Successful Response

workflow_idstring required

Temporal workflow ID

statusstring required

Workflow status (initiated)

Changes

No recorded changes to this operation across all 2 revisions of this API.