> ## Documentation Index
> Fetch the complete documentation index at: https://invoca-5bd45748-mintlify-8d5425ca.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Prompt Recordings

> Upload, list, and delete the audio recordings that Invoca plays as IVR prompts on advertiser campaigns, using the Network Integration prompt_recordings API.

# Prompt Recordings

## Assign prompts to campaigns

Professional prompt recordings can be assigned to advertiser campaigns. The prompts uploaded at Network level can be assigned to any advertiser campaign from that network. The prompts at Advertiser level can be assigned only to the campaigns of that specific advertiser.

### Retrieve available prompts

It's possible to retrieve all the prompts assigned to a network or an advertiser. The attributes returned for a prompt are:

| Field             | Description                                       |
| ----------------- | ------------------------------------------------- |
| id\_from\_network | the network's id for this prompt                  |
| prompt\_text      | the text of the recording                         |
| prompt\_url       | the url of the prompt recording file              |
| prompt\_received  | the date when the professional prompt was created |

**Example: Network prompt recordings**

GET

`https://invoca.net/api/@@NETWORK_API_VERSION/<network_id>.json`

Response

```json theme={null}
{
  "name": "Invoca",
  "users": [],
  "prompt_recordings": [
    {
      "id_from_network": "a1b2",
      "prompt_text": "Thank you. Your call is being connected.",
      "prompt_url": "http://example.com/recording.wav",
      "prompt_received": "2015-08-02 08:49:28 -0700"
    },
    {
      "id_from_network": "pr_342",
      "prompt_text": "This prompt is on order",
      "prompt_url": "http://example.com/recording_order.wav",
      "prompt_received": null
    }
  ]
}
```

**Example: Advertiser prompt recordings**

GET

`https://invoca.net/api/@@NETWORK_API_VERSION/<network_id>/advertisers/<advertiser_id_from_network>.json`

Response

```json theme={null}
{
  "id_from_network": "11",
  "name": "Travel Agency",
  "oauth_refresh_token": null,
  "approval_status": "Approved",
  "web_integration_phone_number": "5555551234",
  "default_creative_id_from_network": "1234",
  "sites": [],
  "users": [],
  "prompt_recordings": [
    {
      "id_from_network": "rec736",
      "prompt_text": "Thank you for calling.",
      "prompt_url": "http://example.com/recording.wav",
      "prompt_received": "2015-08-02 08:49:28 -0700"
    }
  ]
}
```

### Assign prompt to advertiser campaign

A prompt can be assigned to an advertiser campaign IVR tree by specifying its id\_from\_network at the specific node. The same request can be used to assign a new prompt or replace an existing one.

**Example: assign prompt recording**

POST

`https://invoca.net/api/@@NETWORK_API_VERSION/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>.json`

Request Body

```json theme={null}
{
  "ivr_tree": {
    "record_calls": false,
    "root": {
      "node_type": "Connect",
      "destination_phone_number": "8056173768",
      "destination_country_code": "",
      "prompt_id_from_network": "rec34"
    }
  }
}
```

**Example: list the prompts by retrieving the advertiser campaign**

GET

`https://invoca.net/api/@@NETWORK_API_VERSION/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>.json`

Response (*complete response not shown*)

```json theme={null}
{
  "name": "Selling Shoes",
  "status": "Activated",
  "future_terms": {
    "ivr_tree": {
      "record_calls": false,
      "root": {
        "node_type": "Connect",
        "destination_phone_number": "8056173768",
        "destination_country_code": "",
        "prompt": "Thank you. We appreciate your interest in our product.",
        "prompt_id_from_network": "rec34",
        "prompt_url": "http://example.com/recording.wav",
        "prompt_received": "2015-08-02 08:49:28 -0700"
      }
    }
  }
}
```

**Example: remove prompt recording from a campaign**

Just specify an empty id\_from\_network and the prompt will get unassigned from the campaign.

POST

`https://invoca.net/api/@@NETWORK_API_VERSION/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>.json`

Request Body

```json theme={null}
{
  "ivr_tree": {
    "record_calls": false,
    "root": {
      "node_type": "Connect",
      "destination_phone_number": "8056173768",
      "destination_country_code": "",
      "prompt_id_from_network": ""
    }
  }
}
```