Hang up an active call

POST

https://saperly.com/api/v1/calls/:id/hangup

POST

/api/v1/calls/:id/hangup

1 const url = 'https://saperly.com/api/v1/calls/id/hangup';
2 const options = {
3   method: 'POST',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "call": {
3     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4     "line_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
5     "direction": "inbound",
6     "from_number": "+14155552671",
7     "to_number": "+14155559876",
8     "status": "completed",
9     "duration_sec": 125,
10     "started_at": "2024-01-15T09:30:00Z",
11     "ended_at": "2024-01-15T09:32:05Z",
12     "recording_url": "https://saperly.com/recordings/3fa85f64-5717-4562-b3fc-2c963f66afa6.mp3",
13     "transcript": [
14       {
15         "speaker": "agent",
16         "text": "Hello, thank you for calling Saperly. How can I assist you today?",
17         "timestamp": "2024-01-15T09:30:10Z"
18       },
19       {
20         "speaker": "caller",
21         "text": "I need help with my account.",
22         "timestamp": "2024-01-15T09:30:15Z"
23       }
24     ],
25     "system_prompt": "Welcome to Saperly customer support.",
26     "begin_message": "Connecting your call now.",
27     "created_at": "2024-01-15T09:29:55Z"
28   }
29 }

Terminates an active call (initiated, ringing, or in_progress).

Authentication

AuthorizationBearer

Send as Authorization: Bearer <your-key>. Obtain keys from the portal — prefix sk_live_ for production, sk_test_ for sandbox.

Path parameters

idstringRequiredformat: "uuid"

Call ID

Response

Call terminated

callobject

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error