> For the complete documentation index, see [llms.txt](https://docs.ggwp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ggwp.com/api-docs-voice/standard-package/voice-status-api.md).

# Voice Status API

\[ Base URL: `api.ggwp.com`]

`POST` /voice/v1/status

## **Description**

The Voice Status endpoint receives a list of **audio\_ids** given through the Voice Ingestion endpoint, and returns the current status for each corresponding audio file. Valid statuses include:

* **new**: the audio file was successfully received but not yet processed
* **complete**: the audio file has finished processing and any detected incidents are available through the GGWP Dashboard and webhook events
* **failed:** the audio file has failed to process after multiple retries

Files submitted through Voice Ingestion typically complete processing within 1-2 minutes, depending on traffic volume, and are then automatically routed through the GGWP platform’s processing pipeline. This process impacts player reputations, makes incidents available via dashboard and webhook events, and triggers any applicable auto-moderation rules. Optionally, this endpoint can also be used to track each file’s progress through the pipeline.

## **Parameters**

The following parameters are required in the POST request:

* **data:** the JSON-string corresponding to a list of valid **audio\_ids** to query for status
* **headers**
  * **x-api-key:** the GGWP API key corresponding to your organization and dashboard.

## **Example Call**

**Bash**

```bash
curl --location --request POST 'https://api.ggwp.com/voice/v1/status' \
--header 'Content-Type: application/json' \
--header 'x-api-key: api_key' \
--data-raw '[
    "example_id1",
    "example_id2",
    "example_id3"
]'
```

**Python**

```python
import json
import requests

# Prepare the headers with API key
headers = {
    "Content-Type": "application/json",
    "x-api-key": "GGWP_API_KEY"
}

# Prepare the JSON data with valid audio_ids
data = ["example_id1", "example_id2", "example_id3"]

# Send the POST request
response = requests.post(
    'https://api.ggwp.com/voice/v1/status',
    headers=headers,
    data=json.dumps(data)
)

# Examine the response
print(response.json())
```

## **Output**

* 200 response - successful operation

  ```bash
  {
      "status": {
          "example_id1": "new",
          "example_id2": "complete",
          "example_id3": "failed"
      }
  }
  ```
* 400
  * Invalid input parameters
* 403
  * Invalid or missing API key
* 500
  * Server-side error response