> ## Documentation Index > Fetch the complete documentation index at: https://docs.corafone.com/llms.txt > Use this file to discover all available pages before exploring further. # call.completed > Webhook event sent when a call's status is updated to Completed. ## Event `call.completed` Sent when an existing call's `status` is **updated** to `Completed` (for example, from `Processing` or `Queued`). This follows the call change stream on status updates; a call **inserted** already as `Completed` does not trigger this webhook from that path. Delivered inside the [standard webhook envelope](/webhooks); the fields below are the inner `payload` object. Emission is gated by server configuration; if the outbound emitter is disabled, no webhook is sent. ## Payload fields These fields are on the inner `payload` object (inside the [standard envelope](/webhooks)). | Field | Required | Description | | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `callId` | **Yes** | Internal call id. | | `phoneNumber` | **No** | Dialed or caller number in E.164 (e.g. `+15125550123`). **Omitted entirely** when a full, valid E.164 number isn't available — for example a non-telephonic call, or when only a partial/invalid value (such as a bare country code like `+1`) was captured. The field is never sent as a partial or invalid value, so treat it as optional and absent when no valid number exists. | | `fileNumber` | **No** | The filenumber on the Account, either provided by submission or generated if no external id provided. | | `status` | **Yes** | Call status; for this event, always `Completed` (same casing as stored on the call record). | | `duration` | **Yes** | Call length in **milliseconds** (`durationMs` on the call); `0` if not set. | | `direction` | **No** | Call direction from the agent config that handled the call: `INBOUND` for incoming agents, `OUTBOUND` for outgoing agents. 'UNKNOWN' when the direction cannot be resolved; treat an absent value as unknown. | | `isTestCall` | **Yes** | `true` when the call is classified as a test call; otherwise `false`. See [Test call classification](#test-call-classification). | | `outcomes` | **Yes** | Object of outcome flags (see below). Always present; may be `{}` if nothing was detected. | | `summary` | **Yes** | Call note or summary. May be an empty string. | | `recordingUrl` | **No** | URL to the call recording on Cora's API. **Authenticated endpoint** — requires `X-User-Email` + `X-API-Key` headers; see [Fetching `recordingUrl`](#fetching-recordingurl). Omitted if no recording is available. | | `createdAt` | **Yes** | Timestamp from the call record. ISO-8601 | | `endedAt` | **Yes** | Timestamp when the webhook payload was built. ISO-8601 | ### Direction `direction` is included when Cora can resolve the agent config for the completed call. Cora uses the main agent to determine the value. If the agent config cannot be resolved, `direction` is omitted instead of sending an `UNKNOWN` string; consumers should treat a missing `direction` as unknown. ### Test call classification `isTestCall` is `true` when any of these conditions apply: * The call was made through a test-call flow, including edit-agent phone and browser test calls. * The call was manually triggered from an account page. * The call was made to or received from an agent in test mode. * The call was made to or received from a phone number listed as a test phone number on an account. ### Outcomes Every property in `outcomes` is **optional**: only keys with values from call analysis (or label fallbacks) are included. Before delivery, the webhook removes any outcome keys that are not approved for external consumers; those keys never appear in the payload. The tables below list **possible** keys that may be sent after that filtering, grouped for readability. #### Collection | Field | Required | Type | Definition | | ---------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------ | | `refuseToPay` | **No** | boolean | Refused to pay. | | `dispute` | **No** | boolean | Debt disputed on the call. | | `engaged_negotiations` | **No** | boolean | Consumer engaged in payment negotiation (e.g. adjusted amounts or explored options). | | `acknowledgeDebt` | **No** | boolean | Consumer acknowledged the debt. | | `payDate` | **No** | boolean | Pay frequency or pay date was discussed. | | `sentSms` | **No** | boolean | Follow-up SMS was sent. | | `useLenderAgain` | **No** | boolean | Whether the consumer would use the lender again (`true` / `false`); omitted when not determined. | #### Language | Field | Required | Type | Definition | | ------------- | -------- | ------- | ------------------------ | | `spanishCall` | **No** | boolean | Call handled in Spanish. | #### Contact | Field | Required | Type | Definition | | ------------------- | -------- | ------- | ---------------------------------------------------------------- | | `confirmedName` | **No** | boolean | Name was confirmed. | | `deceased` | **No** | boolean | Subject indicated as deceased. | | `wantedToTalkHuman` | **No** | boolean | Asked for a human agent. | | `statusTransfer` | **No** | boolean | Call transferred due to status (e.g. to another queue or agent). | | `wasTheRightNumber` | **No** | boolean | Reached the intended number. | | `wasTheRightParty` | **No** | boolean | Reached the correct party or debtor. | | `wasWrongNumber` | **No** | boolean | Wrong number. | | `wasWrongParty` | **No** | boolean | Wrong person. | #### Compliance | Field | Required | Type | Definition | | ------------------------- | -------- | ------- | ------------------------------------- | | `ceaseAndDesist` | **No** | boolean | Cease-communication request. | | `complaintAboutCollector` | **No** | boolean | Complaint about the collector. | | `doNotCall` | **No** | boolean | Do-not-call request. | | `fraud` | **No** | boolean | Fraud indicated or suspected. | | `lawSuitRisk` | **No** | boolean | Lawsuit or legal risk surfaced. | | `legalAction` | **No** | boolean | Legal action mentioned or threatened. | #### Preference | Field | Required | Type | Definition | | --------------------- | -------- | ------- | ------------------------------------- | | `callbackConsent` | **No** | boolean | Explicit consent to future callbacks. | | `emailOnlyPreference` | **No** | boolean | Email-only contact preference. | | `wantsCallBack` | **No** | boolean | Wants a callback. | #### Payments & Plans | Field | Required | Type | Definition | | --------------------- | -------- | ------- | --------------------------------------------------------------------------------------------- | | `cardDetailsProvided` | **No** | boolean | Card details were given on the call. | | `paymentFailed` | **No** | boolean | Payment attempt failed. | | `paymentMade` | **No** | boolean | Payment succeeded. | | `plan_accepted` | **No** | boolean | Payment plan accepted. | | `plan_type` | **No** | string | Plan kind: `pay_in_full`, `settle_today`, `settlement_plan`, `regular_plan`, `tailored_plan`. | | `promiseToPayDays` | **No** | number | Days until promised payment. | #### Employment | Field | Required | Type | Definition | | -------------- | -------- | ------- | ------------------------ | | `isEmployed` | **No** | boolean | Employed. | | `isUnemployed` | **No** | boolean | Unemployed. | | `multipleJobs` | **No** | boolean | Multiple jobs indicated. | #### Call progress | Field | Required | Type | Definition | | ----------------------- | -------- | ------- | ---------------------------------------- | | `attemptedVerification` | **No** | boolean | Identity verification was attempted. | | `debtMentioned` | **No** | boolean | Debt was mentioned in the flow. | | `mirandaRead` | **No** | boolean | Miranda (or equivalent) disclosure read. | | `offeredPaymentOptions` | **No** | boolean | Payment options were offered. | #### Legal | Field | Required | Type | Definition | | -------------------------- | -------- | ------- | ------------------------------------------------- | | `bankruptcy` | **No** | boolean | Bankruptcy mentioned or claimed. | | `bankruptcyAttorneyName` | **No** | string | Bankruptcy attorney name, if provided. | | `bankruptcyAttorneyPhone` | **No** | string | Bankruptcy attorney phone, if provided. | | `bankruptcyCaseNumber` | **No** | string | Bankruptcy case number, if provided. | | `bankruptcyChapter` | **No** | string | Bankruptcy chapter, if provided. | | `bankruptcyFilingDate` | **No** | string | Bankruptcy filing date, if provided. | | `claimsPaidDirect` | **No** | boolean | Claims payment was made directly to the creditor. | | `coDebtorRefused` | **No** | boolean | Co-debtor refused to pay or engage. | | `debtConsolidation` | **No** | boolean | Debt consolidation in play or discussed. | | `debtConsolidationCompany` | **No** | string | Named debt consolidation company. | | `deployed` | **No** | boolean | Military deployment indicated. | | `hospitalized` | **No** | boolean | Hospitalization indicated. | | `jail` | **No** | boolean | Incarceration indicated. | Future API versions may add keys; treat unexpected keys as forward-compatible. ## Fetching `recordingUrl` When `recordingUrl` is present in the payload, it points to an authenticated endpoint on Cora's API of the form: ```text theme={null} https://api.corafone.com/calls//recording ``` The endpoint streams the audio file (typically `audio/mpeg`) and supports HTTP `Range` requests for seeking. **The URL is not publicly accessible** — opening it directly in a browser will return `401 Authentication required`. You must include the headers below on every `GET`. ### Required headers | Header | Value | | -------------- | --------------------------------------------------------------------- | | `X-User-Email` | Email of an organization member on the same organization as the call. | | `X-API-Key` | The API key associated with that user. | ### Org isolation The user identified by `X-User-Email` must belong to the same organization as the call (the same `organization.id` from the webhook envelope). Cross-organization access is rejected with `403`. ### Example — curl ```bash theme={null} curl -L \ -H "X-User-Email: integration@yourcompany.com" \ -H "X-API-Key: " \ -o recording.mp3 \ "https://api.corafone.com/calls/67a0f74d1c2e8a12f9130ae2/recording" ``` ### Response codes | Status | Meaning | | ------ | ------------------------------------------------------------------------------------------- | | `200` | Audio stream returned. | | `206` | Partial content returned (when a `Range` header is sent). | | `401` | Missing or invalid credentials. | | `403` | The authenticated user does not belong to the call's organization. | | `404` | Recording is not available for this call (e.g. not yet uploaded, or no recording was made). | | `502` | Upstream recording fetch failed; safe to retry later. | ### Operational notes * `recordingUrl` is omitted from the payload when no recording exists for the call. Treat the field as optional. * The URL is stable for the lifetime of the recording — you can store it and re-fetch later as long as the recording is retained. * If you need the recording available to a non-authenticated consumer (for example, to embed in another tool), download it server-side first using the headers above and re-host it from your side. * Native HTML `