menu logo

API/Voicebot/Status

Get the current status and results of a queued voice call.

Authentication

All API requests require an API key to be included in the headers:

Authorization: Bearer [access-key]

Endpoint

GET https://voicebot.intron.health/voicebot/v1/status/:call_id

Path variables

Field Type Description Required Default Options
call_id String the call id generated in response when the call was queued yes

Basic request and response sample

                    
                        curl --location 'https://voicebot.intron.health/voicebot/v1/status/call-id' \
                        --header 'Authorization: Bearer my-api-key'
                    
                
                    
                    import requests

                    url = "https://voicebot.intron.health/voicebot/v1/status/call-id"

                    payload = {}
                    headers = {
                        'Authorization': 'Bearer my-api-key'
                    }

                    response = requests.request("GET", url, headers=headers, data=payload)

                    print(response.text)
                    
                
                    
                        const myHeaders = new Headers();
                        myHeaders.append("Authorization", "Bearer my-api-key");
                        
                        const requestOptions = {
                          method: "GET",
                          headers: myHeaders
                        };
                        
                        fetch("https://voicebot.intron.health/voicebot/v1/status/call-id", requestOptions)
                          .then((response) => response.text())
                          .then((result) => console.log(result))
                          .catch((error) => console.error(error));
                    
                
                    
                        {
                            "data": {
                                "call_id": "12a9767f-b865-4404-91d0-a65d4cdt78fs",
                                "call_duration_in_seconds": 3,
                                "processing_status": "VOICE_CALL_PROCESSED"
                            },
                            "message": "call status found",
                            "status": "Ok"
                        }

Quotas and Limits

  • Rate limit: 100 requests per minute