Change Batch Call Phone Number

PATCH

batch-calls

{id}

phone-number

curl --request PATCH \
  --url https://api.dialnexa.com/v1/batch-calls/{id}/phone-number \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number_id": "phn_abc123"
}
'

import requests

url = "https://api.dialnexa.com/v1/batch-calls/{id}/phone-number"

payload = { "phone_number_id": "phn_abc123" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phone_number_id: 'phn_abc123'})
};

fetch('https://api.dialnexa.com/v1/batch-calls/{id}/phone-number', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/batch-calls/{id}/phone-number",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'phone_number_id' => 'phn_abc123'
  ]),
  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;
}

package main

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

func main() {

	url := "https://api.dialnexa.com/v1/batch-calls/{id}/phone-number"

	payload := strings.NewReader("{\n  \"phone_number_id\": \"phn_abc123\"\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

HttpResponse<String> response = Unirest.patch("https://api.dialnexa.com/v1/batch-calls/{id}/phone-number")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone_number_id\": \"phn_abc123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/batch-calls/{id}/phone-number")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone_number_id\": \"phn_abc123\"\n}"

response = http.request(request)
puts response.read_body

{}

Changes state - verify before retry Change Batch Call Phone Number switches the From number for a draft, scheduled, or paused batch. Undialed calls and parked retries use the new number. Calls already placed keep their original number, and the batch keeps its agent version and status.

Before you begin

Find the batch ID with List Batch Calls.
Choose a phn_ ID from the batch agent’s outbound list in List Agent Phone Numbers.
If the batch is running or waiting, pause it and wait for its calls in progress to finish. Completed, cancelled or deleted batches cannot change numbers.

Change Batch Call Phone Number request

curl -X PATCH "https://api.dialnexa.com/v1/batch-calls/batch_abc123/phone-number" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone_number_id": "phn_abc123"}'

The number must already be linked to the same agent for outbound calls. This request does not attach a number, change the batch’s agent, or resume a paused batch.

Verify the result

HTTP 200 confirms the change. The API-key response is an empty object; it does not include the dashboard’s campaign control result. Reopen the batch’s Change number dialog and confirm the selected number is marked Current. After you resume the batch, inspect subsequent calls with List Calls and batch_call_id to verify their phone_number_id. If the request times out, verify the saved selection before retrying. Repeating the same number does not create a batch or place calls, but the request can be refused if the batch has started or completed since the first request.

Errors and recovery

Status	Code	Recovery
`400`	`PHONE_NUMBER_NOT_LINKED`	Attach the number to this agent for outbound calls, or choose one already linked.
`400`	`BATCH_TERMINAL`	Completed, cancelled or deleted batches cannot change numbers. Prepare a new batch when another run is needed.
`400`	none	Supply a non-empty string for `phone_number_id`.
`404`	none	Check the batch ID and workspace.
`409`	`BATCH_NOT_PAUSED`	Pause a running or waiting batch before changing its number.
`409`	`BATCH_HAS_LIVE_CALLS`	Wait for the paused batch’s calls in progress to finish. `data.live_calls` gives the count.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Batch ID from List Batch Calls.

Example:

"batch_abc123"

Body

application/json

phone_number_id

string

required

One of the batch agent's outbound phone number IDs.

Example:

"phn_abc123"

Response

The number was changed. API-key callers receive an empty object because the response projection omits the control result.

The response is of type object.

Change Batch Call Phone Number

curl --request PATCH \
  --url https://api.dialnexa.com/v1/batch-calls/{id}/phone-number \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number_id": "phn_abc123"
}
'

import requests

url = "https://api.dialnexa.com/v1/batch-calls/{id}/phone-number"

payload = { "phone_number_id": "phn_abc123" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phone_number_id: 'phn_abc123'})
};

fetch('https://api.dialnexa.com/v1/batch-calls/{id}/phone-number', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/batch-calls/{id}/phone-number",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'phone_number_id' => 'phn_abc123'
  ]),
  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;
}

package main

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

func main() {

	url := "https://api.dialnexa.com/v1/batch-calls/{id}/phone-number"

	payload := strings.NewReader("{\n  \"phone_number_id\": \"phn_abc123\"\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

HttpResponse<String> response = Unirest.patch("https://api.dialnexa.com/v1/batch-calls/{id}/phone-number")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone_number_id\": \"phn_abc123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/batch-calls/{id}/phone-number")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone_number_id\": \"phn_abc123\"\n}"

response = http.request(request)
puts response.read_body

{}

Overview

Endpoints

Before you begin

Change Batch Call Phone Number request

Verify the result

Errors and recovery

Authorizations

Path Parameters

Body

Response

​Before you begin

​Change Batch Call Phone Number request

​Verify the result

​Errors and recovery

​Related endpoints

Authorizations

Path Parameters

Body

Response

Before you begin

Change Batch Call Phone Number request

Verify the result

Errors and recovery

Related endpoints