Simulation Job

Lookup by phone number

Changed on

Find the matching simulation using the number used by the Roark simulation agent.

get/v1/simulation/job/lookup

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/simulation/job/lookup
  • Auth
    HTTP bearer

Query parameters

roarkPhoneNumberstring required

Phone number provisioned by Roark for the simulation job in E.164 format. In the case of an inbound simulation, this is the number that calls your agent; in the case of an outbound simulation, this is the number you call from your agent.

callReceivedAtstring date-time

ISO 8601 timestamp of when the call was received. Alternatively, any time between the start and end of the call is valid. Defaults to the current time, which fetches any jobs that are currently ongoing.

Response

Successfully found simulation job

Example response

{
  "data": {
    "simulationJobId": "7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f",
    "status": "COMPLETED",
    "processingStatus": "PROCESSED",
    "queuePosition": null,
    "callId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "roarkPhoneNumber": "+15551234567",
    "runPlan": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Billing Flow Test",
      "variables": {
        "promptToUse": "v1",
        "accountTier": "premium"
      }
    },
    "enrichment": {
      "requested": true,
      "outcome": "TIMED_OUT",
      "waitStartedAt": "2025-01-15T14:28:32.789Z",
      "waitEndedAt": "2025-01-15T14:43:32.789Z",
      "metricsScoredOnSimulationInstead": 4,
      "metricsNotCollected": 1
    },
    "invalidation": null,
    "failureOwner": null,
    "retryOfSimulationJobId": null,
    "attemptNumber": 1,
    "scheduledAt": null,
    "persona": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Sarah Johnson - Anxious Patient",
      "displayName": "Anxious Patient",
      "language": "EN",
      "secondaryLanguage": null,
      "understoodLanguages": [
        "EN"
      ],
      "accent": "US",
      "age": "ADULT",
      "gender": "FEMALE",
      "backgroundNoise": "OFFICE",
      "speechPace": "NORMAL",
      "speechClarity": "CLEAR",
      "hasDisfluencies": false,
      "baseEmotion": "FRUSTRATED",
      "intentClarity": "CLEAR",
      "confirmationStyle": "EXPLICIT",
      "memoryReliability": "HIGH",
      "responseTiming": "NORMAL",
      "interruption": "OCCASIONAL",
      "backstoryPrompt": "A busy professional calling during lunch break",
      "idleMessages": null,
      "idleTimeoutSeconds": 10,
      "idleMessageMaxSpokenCount": 3,
      "idleMessageResetCountOnUserSpeechEnabled": true,
      "properties": {
        "age": "35",
        "zipCode": "94105"
      },
      "createdAt": "2025-01-10T12:00:00.000Z",
      "updatedAt": "2025-01-10T12:00:00.000Z"
    },
    "backgroundNoise": {
      "backgroundNoise": "CITY",
      "backgroundNoiseVolume": 0.1,
      "source": "ENVIRONMENT"
    },
    "scenario": {
      "id": "f8e7d6c5-b4a3-9281-7069-5f4e3d2c1b0a",
      "description": "Patient calling to schedule an urgent dental appointment due to severe tooth pain"
    },
    "agentEndpoint": {
      "id": "3c2b1a09-8f7e-6d5c-4b3a-291807060504",
      "name": "PHONE",
      "phoneNumber": "+15555551234",
      "type": "PHONE"
    },
    "createdAt": "2025-01-15T14:23:45.123Z",
    "startedAt": "2025-01-15T14:24:15.456Z",
    "completedAt": "2025-01-15T14:28:32.789Z"
  }
}

Changes

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the optional property // to the response with the status