DELETE
/
calls
/
{id}
/
notes
/
{noteId}
curl --request DELETE \
  --url https://app.happyrobot.ai/api/v1/calls/{id}/notes/{noteId} \
  --header 'authorization: <authorization>'
{
  "id": "<string>",
  "organization_id": "<string>",
  "type": "Inbound",
  "status": "Scheduled",
  "provider": "Twilio",
  "metadata": {
    "call_sid": "<string>",
    "from": "+1234567890",
    "to": "+1234567890",
    "recording_sid": "<string>",
    "tags": [
      "<string>"
    ],
    "custom": {
      "clientId": "123",
      "orderId": "456"
    }
  },
  "use_case": {
    "id": "<string>",
    "organization_id": "<string>",
    "name": "Kate",
    "transfer_number": "<string>",
    "extract_with_ai": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "string",
        "example": "<string>",
        "required": true
      }
    ],
    "classification_tags": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "language": "en-US",
    "work_start": "<string>",
    "work_end": "<string>",
    "timezone": "<string>",
    "keywords": [
      "<string>"
    ],
    "hook": {
      "url": "<string>",
      "headers": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    },
    "params": {},
    "amd": true,
    "amd_behavior": "Hangup",
    "amd_messages": {},
    "sample_labels": [
      {
        "name": "<string>",
        "color": "slate"
      }
    ],
    "hidden": true,
    "evaluation_models": [
      "<string>"
    ],
    "model": "<string>"
  },
  "agent": {
    "id": "<string>",
    "name": "<string>"
  },
  "language": "en-US",
  "params": {},
  "extraction": {},
  "classification": {
    "tag": "<string>",
    "reasoning": "<string>"
  },
  "created": "2024-01-01T01:01:01Z",
  "duration": 123,
  "viewed_by": [
    "<string>"
  ],
  "notes": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "content": "<string>",
      "flagged": true,
      "created_at": "2024-01-01T01:01:01Z"
    }
  ],
  "samples": [
    "<string>"
  ],
  "ratings": [
    {
      "emoji": "✅",
      "email": "jsmith@example.com",
      "created": "2024-01-01T01:01:01Z"
    }
  ],
  "scheduled_for": "<string>",
  "campaign_id": "<string>"
}

Headers

authorization
string
required

Your API key for authentication. Use Bearer format.

Path Parameters

id
string
required

ID of the call.

noteId
string
required

ID of the note.

Response

200 - application/json
id
string
required

Unique identifier for the call.

organization_id
string
required

Organization ID.

type
enum<string>
required

Type of the call.

Available options:
Inbound,
Outbound
status
enum<string>
required

Status of the call.

Available options:
Scheduled,
Queued,
Initiated,
Ringing,
In progress,
Transferred,
Completed,
AMD Terminated,
Busy,
No answer,
Canceled,
Failed
provider
enum<string>
required

Provider of the call.

Available options:
Twilio,
Web,
Chat
metadata
object
required

Call metadata.

use_case
object
required

Use case that handled the call.

agent
object
required

Agent that handled the call.

language
enum<string>
required

Language of the call.

Available options:
en-US,
es-MX,
es-ES,
in-IN
params
object

Dynamic parameters to inject into the templated use case prompt.

extraction
object

AI extracted data from the call.

classification
object

Tag classification of the call.

created
string
required

Date the call was created.

duration
number

Duration of the call in seconds.

viewed_by
string[]
required

User emails that have viewed the call in the Happyrobot App.

notes
object[]

Notes associated with the call.

samples
string[]

Sample IDs that are associated with the call.

ratings
object[]

Ratings emojis associated with the call.

scheduled_for
string

UTC datetime the call is scheduled for.

campaign_id
string

Campaign ID.

Was this page helpful?

Return a pre-signed URL to the call recordingGenerate a completion for a list of messages for a given use case