End an active Leadping phone call

curl --request POST \
  --url https://api.leadping.ai/phone-call/{callId}/hangup \
  --header 'Authorization: Bearer <token>'

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/phone-call/{callId}/hangup");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.leadping.ai/phone-call/{callId}/hangup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/phone-call/{callId}/hangup"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/phone-call/{callId}/hangup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "status": "scheduled",
  "statusReason": "<string>",
  "direction": "<string>",
  "conversationId": "<string>",
  "leadId": "<string>",
  "phoneNumber": "<string>",
  "toPhoneNumber": "<string>",
  "fromPhoneNumberId": "<string>",
  "fromPhoneNumber": "<string>",
  "callerId": "<string>",
  "selectionReason": "StickyConversation",
  "wasManuallyOverridden": true,
  "campaignId": "<string>",
  "sourceId": "<string>",
  "endedAt": "2023-11-07T05:31:56Z",
  "queuedAt": "2023-11-07T05:31:56Z",
  "ringingAt": "2023-11-07T05:31:56Z",
  "answeredAt": "2023-11-07T05:31:56Z",
  "durationSeconds": 123,
  "billingStatus": "<string>",
  "billableAmount": 123,
  "voicemailUrl": "<string>",
  "consoleEntries": [
    {
      "id": "<string>",
      "stage": "<string>",
      "status": "<string>",
      "message": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z"
    }
  ],
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

POST

phone-call

{callId}

hangup

End an active Leadping phone call

curl --request POST \
  --url https://api.leadping.ai/phone-call/{callId}/hangup \
  --header 'Authorization: Bearer <token>'

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/phone-call/{callId}/hangup");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.leadping.ai/phone-call/{callId}/hangup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/phone-call/{callId}/hangup"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/phone-call/{callId}/hangup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "status": "scheduled",
  "statusReason": "<string>",
  "direction": "<string>",
  "conversationId": "<string>",
  "leadId": "<string>",
  "phoneNumber": "<string>",
  "toPhoneNumber": "<string>",
  "fromPhoneNumberId": "<string>",
  "fromPhoneNumber": "<string>",
  "callerId": "<string>",
  "selectionReason": "StickyConversation",
  "wasManuallyOverridden": true,
  "campaignId": "<string>",
  "sourceId": "<string>",
  "endedAt": "2023-11-07T05:31:56Z",
  "queuedAt": "2023-11-07T05:31:56Z",
  "ringingAt": "2023-11-07T05:31:56Z",
  "answeredAt": "2023-11-07T05:31:56Z",
  "durationSeconds": 123,
  "billingStatus": "<string>",
  "billableAmount": 123,
  "voicemailUrl": "<string>",
  "consoleEntries": [
    {
      "id": "<string>",
      "stage": "<string>",
      "status": "<string>",
      "message": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z"
    }
  ],
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

Authorizations

Authorization

string

header

required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

callId

string

required

The unique identifier of the call to end.

Response

Calls was successfully ended.

Describes a Leadping phone call, including participants, direction, provider state, timing, voicemail, and billing details.

status

enum<string>

Current lifecycle status for this phone call in the Leadping API.

Available options:

scheduled,

queued,

initiated,

ringing,

in_progress,

active,

completed,

ended,

busy,

no_answer,

failed,

canceled,

missed,

transferred,

voicemail,

blocked_billing,

blocked_phone_number_status,

blocked_configuration,

blocked_permission,

configuration_required

statusReason

null | string

Human-readable reason explaining the current status of this phone call.

direction

null | string

Communication direction for this phone call, such as inbound or outbound.

conversationId

null | string

Conversation ID that links this phone call to the Leadping inbox thread.

leadId

null | string

Lead ID associated with the call conversation or outreach attempt.

phoneNumber

string

Phone number used by this phone call for calls, SMS, lookup, or routing.

toPhoneNumber

null | string

Recipient phone number used for this communication.

fromPhoneNumberId

null | string

Sender phone number ID used for this outbound SMS or call.

fromPhoneNumber

null | string

Sender phone number used for this communication.

callerId

null | string

Caller ID phone number presented during the outbound call.

selectionReason

null | enum<string>

Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.

Available options:

StickyConversation,

LeadAssigned,

CampaignOrSource,

Preferred,

LocalArea,

HealthyPool,

FallbackDefault,

ManualOverride

wasManuallyOverridden

boolean

Indicates whether a user manually overrode Leadping's automatic number selection for this phone call.

campaignId

null | string

Messaging campaign identifier associated with this phone call.

sourceId

null | string

Lead source ID used for attribution and routing on this call.

endedAt

null | string<date-time>

UTC timestamp when the call ended.

queuedAt

null | string<date-time>

UTC timestamp when Leadping queued this phone call for processing.

ringingAt

null | string<date-time>

UTC timestamp when the call started ringing.

answeredAt

null | string<date-time>

UTC timestamp when the call was answered.

durationSeconds

null | integer<int32>

Call duration in seconds.

billingStatus

null | string

Billing state for this communication, charge, or transaction.

billableAmount

null | number<double>

Monetary amount billed for this Leadping communication or transaction.

voicemailUrl

null | string<uri>

URL for voicemail audio, when the call resulted in a voicemail.

consoleEntries

object[]

Ordered diagnostic entries recorded while Leadping processed this call.

Show child attributes

string

Stable unique identifier of the resource.

createdAt

string<date-time>

UTC timestamp when the resource was created.

modifiedAt

null | string<date-time>

UTC timestamp when the resource was last modified, or null when it has not been updated.

API Overview

Endpoints

End an active Leadping phone call

Authorizations

Path Parameters

Response