Set sender number override

curl --request POST \
  --url https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromPhoneNumberId": "<string>",
  "selection": {
    "conversationId": "<string>",
    "leadId": "<string>",
    "recipientPhoneNumber": "<string>",
    "campaignId": "<string>",
    "sourceId": "<string>",
    "teamId": "<string>"
  }
}
'

import requests

url = "https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override"

payload = {
    "fromPhoneNumberId": "<string>",
    "selection": {
        "conversationId": "<string>",
        "leadId": "<string>",
        "recipientPhoneNumber": "<string>",
        "campaignId": "<string>",
        "sourceId": "<string>",
        "teamId": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"fromPhoneNumberId\": \"<string>\",\n  \"selection\": {\n    \"conversationId\": \"<string>\",\n    \"leadId\": \"<string>\",\n    \"recipientPhoneNumber\": \"<string>\",\n    \"campaignId\": \"<string>\",\n    \"sourceId\": \"<string>\",\n    \"teamId\": \"<string>\"\n  }\n}", false);
var response = await client.PostAsync(request);

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

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fromPhoneNumberId\": \"<string>\",\n  \"selection\": {\n    \"conversationId\": \"<string>\",\n    \"leadId\": \"<string>\",\n    \"recipientPhoneNumber\": \"<string>\",\n    \"campaignId\": \"<string>\",\n    \"sourceId\": \"<string>\",\n    \"teamId\": \"<string>\"\n  }\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fromPhoneNumberId: '<string>',
    selection: {
      conversationId: '<string>',
      leadId: '<string>',
      recipientPhoneNumber: '<string>',
      campaignId: '<string>',
      sourceId: '<string>',
      teamId: '<string>'
    }
  })
};

fetch('https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override"

	payload := strings.NewReader("{\n  \"fromPhoneNumberId\": \"<string>\",\n  \"selection\": {\n    \"conversationId\": \"<string>\",\n    \"leadId\": \"<string>\",\n    \"recipientPhoneNumber\": \"<string>\",\n    \"campaignId\": \"<string>\",\n    \"sourceId\": \"<string>\",\n    \"teamId\": \"<string>\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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-numbers/outgoing/conversation/{conversationId}/override",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fromPhoneNumberId' => '<string>',
    'selection' => [
        'conversationId' => '<string>',
        'leadId' => '<string>',
        'recipientPhoneNumber' => '<string>',
        'campaignId' => '<string>',
        'sourceId' => '<string>',
        'teamId' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "canSend": true,
  "setupMessage": "<string>",
  "phoneNumberId": "<string>",
  "number": "<string>",
  "displayNumber": "<string>",
  "healthStatus": "Not Evaluated",
  "healthLabel": "<string>",
  "healthWarning": "<string>",
  "selectionReason": "StickyConversation",
  "reasonLabel": "<string>",
  "wasManuallyOverridden": true,
  "campaignId": "<string>",
  "sourceId": "<string>",
  "eligibleNumbers": [
    {
      "phoneNumberId": "<string>",
      "number": "<string>",
      "displayNumber": "<string>",
      "healthStatus": "Not Evaluated",
      "healthLabel": "<string>",
      "healthWarning": "<string>",
      "canSend": true,
      "selectionReason": "StickyConversation",
      "reasonLabel": "<string>",
      "label": "<string>",
      "campaignId": "<string>",
      "sourceId": "<string>",
      "teamId": "<string>",
      "isSelected": true
    }
  ]
}

{
  "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": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

POST

phone-numbers

outgoing

conversation

{conversationId}

override

Set sender number override

curl --request POST \
  --url https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromPhoneNumberId": "<string>",
  "selection": {
    "conversationId": "<string>",
    "leadId": "<string>",
    "recipientPhoneNumber": "<string>",
    "campaignId": "<string>",
    "sourceId": "<string>",
    "teamId": "<string>"
  }
}
'

import requests

url = "https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override"

payload = {
    "fromPhoneNumberId": "<string>",
    "selection": {
        "conversationId": "<string>",
        "leadId": "<string>",
        "recipientPhoneNumber": "<string>",
        "campaignId": "<string>",
        "sourceId": "<string>",
        "teamId": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"fromPhoneNumberId\": \"<string>\",\n  \"selection\": {\n    \"conversationId\": \"<string>\",\n    \"leadId\": \"<string>\",\n    \"recipientPhoneNumber\": \"<string>\",\n    \"campaignId\": \"<string>\",\n    \"sourceId\": \"<string>\",\n    \"teamId\": \"<string>\"\n  }\n}", false);
var response = await client.PostAsync(request);

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

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fromPhoneNumberId\": \"<string>\",\n  \"selection\": {\n    \"conversationId\": \"<string>\",\n    \"leadId\": \"<string>\",\n    \"recipientPhoneNumber\": \"<string>\",\n    \"campaignId\": \"<string>\",\n    \"sourceId\": \"<string>\",\n    \"teamId\": \"<string>\"\n  }\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fromPhoneNumberId: '<string>',
    selection: {
      conversationId: '<string>',
      leadId: '<string>',
      recipientPhoneNumber: '<string>',
      campaignId: '<string>',
      sourceId: '<string>',
      teamId: '<string>'
    }
  })
};

fetch('https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.leadping.ai/phone-numbers/outgoing/conversation/{conversationId}/override"

	payload := strings.NewReader("{\n  \"fromPhoneNumberId\": \"<string>\",\n  \"selection\": {\n    \"conversationId\": \"<string>\",\n    \"leadId\": \"<string>\",\n    \"recipientPhoneNumber\": \"<string>\",\n    \"campaignId\": \"<string>\",\n    \"sourceId\": \"<string>\",\n    \"teamId\": \"<string>\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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-numbers/outgoing/conversation/{conversationId}/override",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fromPhoneNumberId' => '<string>',
    'selection' => [
        'conversationId' => '<string>',
        'leadId' => '<string>',
        'recipientPhoneNumber' => '<string>',
        'campaignId' => '<string>',
        'sourceId' => '<string>',
        'teamId' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "canSend": true,
  "setupMessage": "<string>",
  "phoneNumberId": "<string>",
  "number": "<string>",
  "displayNumber": "<string>",
  "healthStatus": "Not Evaluated",
  "healthLabel": "<string>",
  "healthWarning": "<string>",
  "selectionReason": "StickyConversation",
  "reasonLabel": "<string>",
  "wasManuallyOverridden": true,
  "campaignId": "<string>",
  "sourceId": "<string>",
  "eligibleNumbers": [
    {
      "phoneNumberId": "<string>",
      "number": "<string>",
      "displayNumber": "<string>",
      "healthStatus": "Not Evaluated",
      "healthLabel": "<string>",
      "healthWarning": "<string>",
      "canSend": true,
      "selectionReason": "StickyConversation",
      "reasonLabel": "<string>",
      "label": "<string>",
      "campaignId": "<string>",
      "sourceId": "<string>",
      "teamId": "<string>",
      "isSelected": true
    }
  ]
}

{
  "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": "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

conversationId

string

required

The conversation identifier.

Body

The outgoing number manual override request payload for the operation.

Defines the fields clients can send when working with outgoing number manual override.

fromPhoneNumberId

string

required

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

selection

object

required

Selected outgoing number and selection rationale returned by Leadping.

Show child attributes

Response

Returns the outgoing number selection response.

Describes outgoing number selection data returned by Leadping.

canSend

boolean

Indicates whether Leadping can send outbound messages using this outgoing number selection response.

setupMessage

null | string

Human-readable setup guidance shown for this outgoing number selection response.

phoneNumberId

null | string

Leadping phone number ID connected to this outgoing number selection response.

number

null | string

E.164 phone number exposed by this outgoing number selection response.

displayNumber

null | string

Human-readable phone number shown in Leadping UI and API responses.

healthStatus

null | enum<string>

Summarizes the severity of conditions affecting an organization's ability to send compliant SMS or MMS traffic.

Available options:

Not Evaluated,

Evaluating,

Healthy,

Needs Attention,

Blocked

healthLabel

null | string

Short label describing the health state for display in dashboards.

healthWarning

null | string

Warning text that explains a potential health or readiness issue.

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

reasonLabel

null | string

Human-readable label for the reason code on this outgoing number selection response.

wasManuallyOverridden

boolean

Indicates whether a user manually overrode Leadping's automatic number selection for this outgoing number selection response.

campaignId

null | string

Messaging campaign identifier associated with this outgoing number selection response.

sourceId

null | string

Lead source ID considered when Leadping selected the outgoing phone number.

eligibleNumbers

object[]

Phone numbers that are eligible to send the requested outbound message or call.

Show child attributes

API Overview

Endpoints

Set sender number override

Authorizations

Path Parameters

Body

Response