CA Voice Calls

Place a test voice call via Sierra

Changed on

Single-request, stateless endpoint to place a Sierra voice-agent test call.

Requires scope: voice_calls:write

Two possible 202 response shapes, depending on payload.dry_run:

  • Dry run (dry_run=true, the default). Shape depends on payload.purpose:

    • mammogram-member-availability-test (Playbook API)::

      {
          "mode": "dry_run",
          "validated_config": {"purpose": ..., "target": None, "inputs": {...}},
          "sierra_request_preview": {
              "url": "https://api.sierra.chat/playbooks/<playbook_id>/start",
              "target": "MemberSchedulingTestTarget",
              "body": {"idempotencyKey": ..., "entities": {...}, "events": [...]}
          }
      }
      
    • member-scheduling-agent-test / facility-scheduling-agent-test / member-appointment-confirmation-agent-test (direct-agent API)::

      {
          "mode": "dry_run",
          "validated_config": {"purpose": ..., "target": None, "inputs": {...}},
          "sierra_request_preview": {
              "url": "https://api.sierra.chat/chat/telephony/outbound/<agent_id>",
              "agent_params": {...}
          }
      }
      
  • Real run (dry_run=false). Shape depends on payload.purpose:

    • mammogram-member-availability-test -- dispatched to Sierra's Playbook API directly, in-request (no public /results support since this path writes no CAVoiceCallRequest)::

      {"mode": "confirmed", "status": "dispatched", "call_id": <str>}
      

      A Sierra dispatch failure returns 502 SierraDispatchFailedResponse instead.

    • member-scheduling-agent-test / facility-scheduling-agent-test / member-appointment-confirmation-agent-test -- the call is queued, not yet placed, so there is no call_id/disposition to report; task_id is the queued OutboundCallTask's pk (no public /results support since this path writes no CAVoiceCallRequest)::

      {"mode": "confirmed", "status": "queued", "task_id": <int>}
      
post/api/v1/ca/voice-calls/test

Request

  • Base URL
    https://api.cloverhealth.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.cloverhealth.com/api/v1/ca/voice-calls/test
  • Auth
    HTTP bearer

Request body

purposestring required
inputsobject
caller_id_numberstring nullable
dry_runboolean

Response

Accepted

object required

Changes

    • info

      added the new optional request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status