GET /api/aiphonecall/v1

Changed on

Get the status of an AI phone call

Request

  • Base URL
    https://forecaster.cairhealth.com
  • URL
    https://forecaster.cairhealth.com/api/aiphonecall/v1
  • Auth
    HTTP bearer

Query parameters

callIdstring required

ID of the call to check

Headers

x-organization-idstring required

Organization ID for authentication

Response

Call status retrieved successfully

callIdstring
status'pending' | 'in_progress' | 'completed' | 'failed'
resultsobject

Call results (only present if status is completed)

errorstring

Error message (only present if status is failed)

errorDetailsobject

Detailed error information (only present if status is failed)

Changes