Place one outbound call through the same gates as a campaign

POST /v1/calls

Place one outbound call through the same gates as a campaign

cURL

curl --request POST \
  --url https://api-us.larynth.com/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --cookie lx_session= \
  --data '
{
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_e164": "<string>",
  "to_e164": "<string>",
  "amd_mode": "off",
  "amd_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ring_timeout_s": 30,
  "variables": {}
}
'

202

{
  "call_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "direction": "inbound",
  "mode": "cascade",
  "opted_out": true,
  "recording_allowed": true,
  "status": "queued",
  "updated_at": "2023-11-07T05:31:56Z",
  "agent_billable_ms": 123,
  "agent_price_micro": 123,
  "amd_after_ms": 123,
  "amd_answer_headers": {
    "diversion": [
      "<string>"
    ],
    "history_info": [
      "<string>"
    ],
    "p_early_media": [
      "<string>"
    ],
    "reason": [
      "<string>"
    ]
  },
  "amd_early_media_tone": "none",
  "amd_reason": "<string>",
  "amd_ringback_cycles": 123,
  "amd_t200_ms": 123,
  "amd_verdict": "unknown",
  "answered_at": "2023-11-07T05:31:56Z",
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assistant_version": 123,
  "attestation": "A",
  "billable_ms": 123,
  "bridged_ms": 123,
  "bridged_price_micro": 123,
  "campaign_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cause": "<string>",
  "codec": "G722",
  "disclosure_played_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "from_e164": "<string>",
  "hangup_by": "local",
  "number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outcome": "<string>",
  "price_micro": 123,
  "recording_notice_played_at": "2023-11-07T05:31:56Z",
  "sip_code": 123,
  "summary": "<string>",
  "to_e164": "<string>"
}

Authorizations

sessionapiKey

lx_session · string · cookie · required

Dashboard session cookie

Headers

Idempotency-Key · string · required

Replays within 24 h return the stored response; the same key with a different body returns 409

Required string length: 8 - 255

Body

application/json

assistant_id · string<uuid> · required

The published version is used

from_e164 · string · required

Must be an active number of this tenant

Pattern: ^\+[1-9][0-9]{6,14}$

purpose · enum<string> · required

Available options: informational, telemarketing

to_e164 · string · required

Pattern: ^\+[1-9][0-9]{6,14}$

amd_mode · enum<string> · default: off

Available options: off, hangup_on_machine, voicemail

amd_profile_id · string<uuid>

contact_id · string<uuid>

ring_timeout_s · integer<int64> · default: 30

Required range: 15 <= x <= 60

variables · object

Show child attributes

Response

202

application/json

Accepted

call_id · string · required

Pattern: ^[a-z0-9]{2,8}_[0-9A-HJKMNP-TV-Z]{26}$

created_at · string<date-time> · required

direction · enum<string> · required

Available options: inbound, outbound, web_test

mode · enum<string> · required

Available options: cascade, s2s

opted_out · boolean · required

recording_allowed · boolean · required

status · enum<string> · required

Available options: queued, dialing, ringing, in_progress, completed, no_answer, busy, failed, canceled, rejected

updated_at · string<date-time> · required

agent_billable_ms · integer<int64>

Part of billable_ms handled by the agent

agent_price_micro · integer<int64>

Settled price of the agent part in micro-USD

amd_after_ms · integer<int64>

amd_answer_headers · object

Allow-listed 200 OK headers; values can carry phone numbers

Show child attributes

amd_early_media_tone · enum<string>

Available options: none, ringback, sit, other

amd_reason · string

amd_ringback_cycles · integer<int64>

Ringback cycles heard before answer

amd_t200_ms · integer<int64>

Originate to 200 OK; absent when not answered

amd_verdict · enum<string>

Available options: unknown, human, voicemail, carrier_vm, ivr, screener, fax, sit

answered_at · string<date-time>

assistant_id · string<uuid>

assistant_version · integer<int64>

attestation · enum<string>

Available options: A, B, C

billable_ms · integer<int64>

bridged_ms · integer<int64>

Part of billable_ms bridged to a human after a transfer

bridged_price_micro · integer<int64>

Settled price of the bridged part in micro-USD, billed at the transfer_minute rate

campaign_contact_id · string<uuid>

campaign_id · string<uuid>

cause · string

codec · enum<string>

Available options: G722, PCMU, PCMA, opus

disclosure_played_at · string<date-time>

ended_at · string<date-time>

from_e164 · string

hangup_by · enum<string>

Available options: local, remote, system

number_id · string<uuid>

outcome · string

price_micro · integer<int64>

Settled price in micro-USD

recording_notice_played_at · string<date-time>

sip_code · integer<int64>

summary · string

Short post-call summary, present on list items once analysed

to_e164 · string