Create a Web Call - DialNexa Documentation

POST

webcall

Create and initiate a webcall session

curl --request POST \
  --url https://api.dialnexa.com/webcall \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "+1234567890",
  "agent_id": "ag_12345678901234",
  "metadata": {
    "customer_name": "John Doe",
    "customer_email": "[email protected]",
    "lead_source": "website",
    "priority": "high"
  },
  "agent_version_number": 2
}
'

import requests

url = "https://api.dialnexa.com/webcall"

payload = {
    "phone_number": "+1234567890",
    "agent_id": "ag_12345678901234",
    "metadata": {
        "customer_name": "John Doe",
        "customer_email": "[email protected]",
        "lead_source": "website",
        "priority": "high"
    },
    "agent_version_number": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    phone_number: '+1234567890',
    agent_id: 'ag_12345678901234',
    metadata: {
      customer_name: 'John Doe',
      customer_email: '[email protected]',
      lead_source: 'website',
      priority: 'high'
    },
    agent_version_number: 2
  })
};

fetch('https://api.dialnexa.com/webcall', 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/webcall",
  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([
    'phone_number' => '+1234567890',
    'agent_id' => 'ag_12345678901234',
    'metadata' => [
        'customer_name' => 'John Doe',
        'customer_email' => '[email protected]',
        'lead_source' => 'website',
        'priority' => 'high'
    ],
    'agent_version_number' => 2
  ]),
  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/webcall"

	payload := strings.NewReader("{\n  \"phone_number\": \"+1234567890\",\n  \"agent_id\": \"ag_12345678901234\",\n  \"metadata\": {\n    \"customer_name\": \"John Doe\",\n    \"customer_email\": \"[email protected]\",\n    \"lead_source\": \"website\",\n    \"priority\": \"high\"\n  },\n  \"agent_version_number\": 2\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))

}

HttpResponse<String> response = Unirest.post("https://api.dialnexa.com/webcall")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone_number\": \"+1234567890\",\n  \"agent_id\": \"ag_12345678901234\",\n  \"metadata\": {\n    \"customer_name\": \"John Doe\",\n    \"customer_email\": \"[email protected]\",\n    \"lead_source\": \"website\",\n    \"priority\": \"high\"\n  },\n  \"agent_version_number\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/webcall")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone_number\": \"+1234567890\",\n  \"agent_id\": \"ag_12345678901234\",\n  \"metadata\": {\n    \"customer_name\": \"John Doe\",\n    \"customer_email\": \"[email protected]\",\n    \"lead_source\": \"website\",\n    \"priority\": \"high\"\n  },\n  \"agent_version_number\": 2\n}"

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

{
  "session_id": "mf0x4riongyz6h",
  "agent_id": "0e709fd2-8339-46fa-8e28-ca8c66e00f43",
  "call_id": "mf0x4riongyz6h",
  "state": "created",
  "websocket_url": "/webcall/ws/mf0x4riongyz6h",
  "message": "Webcall session created successfully"
}

Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. A public v1 replacement is not currently listed in the v1 reference. This endpoint remains available for existing integrations until then.

Creates a browser-based web call session for an agent. The v1 path is /webcalls. Legacy unversioned /webcall integrations can continue during the transition window, but new v1 integrations should use /webcalls.

When to use this

Website embeds: let a visitor start a voice conversation from a page.
Product demos: launch a temporary web call without dialing a phone number.
Support flows: collect web visitor context and pass it to the agent as metadata.

Terminate a Web Call: end an active web call session.
Create an Outbound Call: create a phone-based outbound call.

Authorizations

Authorization

string

header

required

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

Headers

X-API-Key

string

API key for authentication (alternative to JWT token)

Body

application/json

phone_number

string

required

Phone number to call (must include country code). Format: +[country code][phone number]

Example:

"+1234567890"

agent_id

string

required

Agent ID to use for the call. Must belong to the authenticated organization.

Example:

"ag_12345678901234"

metadata

object

required

Metadata for the call including customer information and any additional context. This data will be available during the call for personalization.

Example:

{
  "customer_name": "John Doe",
  "customer_email": "[email protected]",
  "lead_source": "website",
  "priority": "high"
}

agent_version_number

number

Specific agent version number to use (optional). If provided, must be a published version. If not provided, will use the latest published version.

Example:

2

Response

Webcall session created successfully

session_id

string

required

Unique session ID for the webcall. This is the call log ID that can be used to track the webcall session.

Example:

"mf0x4riongyz6h"

agent_id

string

required

Agent ID used for the webcall

Example:

"0e709fd2-8339-46fa-8e28-ca8c66e00f43"

call_id

string

required

Call ID from Nexa Speech API

Example:

"mf0x4riongyz6h"

state

string

required

Current state of the webcall session

Example:

"created"

websocket_url

string

required

WebSocket URL for connecting to the webcall session

Example:

"/webcall/ws/mf0x4riongyz6h"

message

string

required

Success message from the API

Example:

"Webcall session created successfully"

Terminate a Web CallTerminate an active DialNexa web call session.

Create and initiate a webcall session

curl --request POST \
  --url https://api.dialnexa.com/webcall \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "+1234567890",
  "agent_id": "ag_12345678901234",
  "metadata": {
    "customer_name": "John Doe",
    "customer_email": "[email protected]",
    "lead_source": "website",
    "priority": "high"
  },
  "agent_version_number": 2
}
'

import requests

url = "https://api.dialnexa.com/webcall"

payload = {
    "phone_number": "+1234567890",
    "agent_id": "ag_12345678901234",
    "metadata": {
        "customer_name": "John Doe",
        "customer_email": "[email protected]",
        "lead_source": "website",
        "priority": "high"
    },
    "agent_version_number": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    phone_number: '+1234567890',
    agent_id: 'ag_12345678901234',
    metadata: {
      customer_name: 'John Doe',
      customer_email: '[email protected]',
      lead_source: 'website',
      priority: 'high'
    },
    agent_version_number: 2
  })
};

fetch('https://api.dialnexa.com/webcall', 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/webcall",
  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([
    'phone_number' => '+1234567890',
    'agent_id' => 'ag_12345678901234',
    'metadata' => [
        'customer_name' => 'John Doe',
        'customer_email' => '[email protected]',
        'lead_source' => 'website',
        'priority' => 'high'
    ],
    'agent_version_number' => 2
  ]),
  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/webcall"

	payload := strings.NewReader("{\n  \"phone_number\": \"+1234567890\",\n  \"agent_id\": \"ag_12345678901234\",\n  \"metadata\": {\n    \"customer_name\": \"John Doe\",\n    \"customer_email\": \"[email protected]\",\n    \"lead_source\": \"website\",\n    \"priority\": \"high\"\n  },\n  \"agent_version_number\": 2\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))

}

HttpResponse<String> response = Unirest.post("https://api.dialnexa.com/webcall")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone_number\": \"+1234567890\",\n  \"agent_id\": \"ag_12345678901234\",\n  \"metadata\": {\n    \"customer_name\": \"John Doe\",\n    \"customer_email\": \"[email protected]\",\n    \"lead_source\": \"website\",\n    \"priority\": \"high\"\n  },\n  \"agent_version_number\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/webcall")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone_number\": \"+1234567890\",\n  \"agent_id\": \"ag_12345678901234\",\n  \"metadata\": {\n    \"customer_name\": \"John Doe\",\n    \"customer_email\": \"[email protected]\",\n    \"lead_source\": \"website\",\n    \"priority\": \"high\"\n  },\n  \"agent_version_number\": 2\n}"

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

{
  "session_id": "mf0x4riongyz6h",
  "agent_id": "0e709fd2-8339-46fa-8e28-ca8c66e00f43",
  "call_id": "mf0x4riongyz6h",
  "state": "created",
  "websocket_url": "/webcall/ws/mf0x4riongyz6h",
  "message": "Webcall session created successfully"
}

​When to use this

​Related endpoints

Authorizations

Headers

Body

Response

When to use this

Related endpoints