Requests

Retrieve a Request

Fetch details for a request by ID.

get/v1/requests/{requestId}

Request

  • Base URL: https://robodialer-service-api-9nc4t1p9.uc.gateway.dev
  • URL: https://robodialer-service-api-9nc4t1p9.uc.gateway.dev/v1/requests/{requestId}
  • Auth: HTTP bearer

Path parameters

requestIdstring required

The request ID

Response

Request retrieved successfully. Single-request reads include phone-call enrichment fields (transcript, recordingDownloadUrl, etc.) when a representative call has completed.

requestIdstring
requestBatchIdstring
schemaIdstring
requestTypestring
state'PROCESSING' | 'SUCCESS' | 'PARTIAL' | 'FAILURE'

Request lifecycle state (uppercase). See State for what each value means and which response fields are populated for it.

inputsobject

The request's inputs, echoed back exactly as submitted on POST /v1/requests, including any additional keys outside the schema's required and optional lists. Values are strings.

resultsobject

Structured request output fields. Empty {} on PROCESSING and FAILURE; partially populated on PARTIAL; fully populated on SUCCESS.

missingFieldsstring[]

Schema fields the request was unable to obtain. Populated on PARTIAL and FAILURE requests where extraction ran but came up short.

dateCreatedstring date-time nullable

Time the request was created, ISO-8601 with UTC offset (e.g. "2026-04-24T15:30:00.123456+00:00").

completedAtstring date-time nullable

Time the request reached a terminal state (SUCCESS, PARTIAL, or FAILURE). null while the request is still PROCESSING.

dueDatestring date-time nullable

Date this request is scheduled to run, as an ISO-8601 timestamp (e.g. "2026-05-08T03:00:00+00:00"). Set at submission time based on your account's daily call capacity and any work already pending. null when no due date is set.

internalIdstring nullable

Optional. Echoed back from the request body if you supplied one at create time. The key is always present in this response (as null when not supplied), unlike on webhook payloads where the key is omitted entirely.

internalTagstring nullable

Optional. Echoed back from the request body if you supplied one at create time. The key is always present in this response (as null when not supplied), unlike on webhook payloads where the key is omitted entirely.

modality'digital_only' | 'phone_only' | 'digital_plus_phone' nullable

How the result was obtained. See Modality for the value semantics. phone_only and digital_plus_phone both mean a phone call was placed (billable at the phone-call rate); digital_only means no phone call.

data_completeness'minimum' nullable

Completeness tier of a digital-only result. See data_completeness for current and reserved values.

tostring

The phone number that was dialed, echoed back in sanitized form. Present only once a representative phone call has completed (any terminal state), and only when the number was one you supplied (payerLookup.phoneNumberSource is input). When SuperDial dialed a number from its own payer directory (superdial or phoneBook), to is omitted; read the number from payerLookup.phoneNumberToUse instead, which is populated in every case and is also available before the call completes.

transcriptstring

Full call transcript. Present only when a representative phone call has completed.

recordingDownloadUrlstring

Signed URL for the call recording. Present only when a phone call has completed and a recording exists. The URL is short-lived: it expires 7 days after it is issued, and sooner on accounts configured for a shorter window. Download the recording rather than storing the URL, and fetch the request again if you need a fresh one.

callDurationstring

Call duration in HH:MM:SS format. Present only when a phone call has completed and recording length data exists.

callFromNumberstring

Optional. Outbound caller number (E.164): the line the call originated from. Present only when a phone call has completed AND your account has outbound-number visibility enabled. Contact your account team to turn this on.

callSummarystring

AI-generated call summary. Present only when a representative phone call has completed.

callAuditSummarystring

AI-generated audit summary. Present only when a representative phone call has completed.

resultSummarystring nullable

Prose summary of results for a SUCCESS or PARTIAL request that finished without a phone call (the electronic-only path). A phone-backed request carries callSummary instead. Null otherwise. Not a per-account setting, but a request only finishes without a phone call when electronic channels are enabled for your account, so this stays null on phone-only accounts.

scriptVersionstring

Optional. Script version used for the call. Present only when a phone call has completed AND your account has script-version visibility enabled.

isRoboCallboolean

Optional. Whether the winning attempt was handled by the AI agent (true) or a human (false). Returned on the single-request read only, and only when your account has compliance fields enabled.

resultSourcesobject nullable

Maps each field in results to the call number (contributingCalls[].call) of the phone call that produced its final value. Useful when a request spanned more than one call and you want to know which call each answer came from. Fields with no phone-call source (e.g. digital_only values) are omitted. Present alongside contributingCalls on the single-request read.

Example response

{
  "requestId": "8bF7xK2mP9qR4sT6uV0w",
  "requestBatchId": "pH9kJ2lM4nB6vC8xZ7Qr",
  "schemaId": "fWxzG4nqtpHsJxS5Lm3q",
  "requestType": "claim-status",
  "state": "SUCCESS",
  "inputs": {
    "payerName": "Sample Insurance Co",
    "memberId": "TEST123456789",
    "providerNpi": "1234567890",
    "phoneNumber": "2125551234",
    "dateOfService": "2026-03-15"
  },
  "results": {
    "claimStatus": "PAID",
    "paidAmount": "150.00",
    "checkNumber": "CHK998877",
    "paidDate": "2026-04-10"
  },
  "missingFields": [],
  "dateCreated": "2026-04-24T15:30:00.123456+00:00",
  "completedAt": "2026-04-24T15:32:18.987654+00:00",
  "dueDate": "2026-04-25T23:00:00+00:00",
  "internalId": "claim_internal_456",
  "internalTag": "march-batch",
  "modality": "phone_only",
  "data_completeness": null,
  "error": null,
  "payerLookup": {
    "inputPayerName": "Sample Insurance Co",
    "inputPhoneNumber": "2125551234",
    "matchedPayerName": null,
    "matchedPayerPhone": null,
    "phoneNumberToUse": "2125551234",
    "phoneNumberSource": "input"
  },
  "to": "+12125551234",
  "transcript": "SuperDial Agent: Hi, I'm calling to check on a claim status.\nRepresentative: Sure, can I get the claim number?...",
  "recordingDownloadUrl": "https://storage.googleapis.com/sd-recordings/.../recording.mp3?X-Goog-Signature=...",
  "callDuration": "00:08:42",
  "callSummary": "Verified claim status as PAID. Check #CHK998877 issued on 2026-04-10 for $150.00.",
  "callAuditSummary": "All claim status questions answered. Representative confirmed paid amount and check number.",
  "callSteps": [
    {
      "key": "claim-status",
      "schemaId": "fWxzG4nqtpHsJxS5Lm3q",
      "name": "Claim Status",
      "state": "SUCCESS",
      "fieldsRequired": 4,
      "fieldsCaptured": 4,
      "missingFields": [],
      "numContributingCalls": 1,
      "triggeredBy": null
    }
  ],
  "contributingCalls": [
    {
      "id": "9nQ4vT7xB2mK5pR8sL0w",
      "call": 1,
      "callStep": "claim-status",
      "fieldsCaptured": [
        "claimStatus",
        "paidAmount",
        "checkNumber",
        "paidDate"
      ],
      "results": {
        "claimStatus": "PAID",
        "paidAmount": "150.00",
        "checkNumber": "CHK998877",
        "paidDate": "2026-04-10"
      },
      "completedAt": "2026-04-24T15:32:18.987654+00:00"
    }
  ],
  "resultSources": {
    "claimStatus": 1,
    "paidAmount": 1,
    "checkNumber": 1,
    "paidDate": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.