Realtime

Create a realtime session

Mint a one-minute, single-use client_secret that lets a browser or app talk to one of your agents over wss://api.phone.wixzel.com/v1/realtime — no SIP trunk, no phone number. Call this from your server; the API key must never reach the client.

Nothing is charged here. When the socket connects, the session is admitted exactly like a call: it needs credit, counts toward your concurrent-call limit and the key’s spend limit, is billed at the same per-minute price as a phone call on the same engine, and appears in GET /v1/calls with channel: "web", followed by a callCompleted webhook.

Human transfer is not available on web sessions — there is no second line to hand the caller to.

POST

realtime

sessions

Create a realtime session

curl --request POST \
  --url https://api.phone.wixzel.com/v1/realtime/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "6a96a3ead6e886d42462dd3e",
  "lead_id": "6a96a3ead6e886d42462dd3e",
  "metadata": {},
  "max_duration_seconds": 600,
  "allowed_origins": [
    "https://app.example.com"
  ]
}
'

import requests

url = "https://api.phone.wixzel.com/v1/realtime/sessions"

payload = {
    "agent_id": "6a96a3ead6e886d42462dd3e",
    "lead_id": "6a96a3ead6e886d42462dd3e",
    "metadata": {},
    "max_duration_seconds": 600,
    "allowed_origins": ["https://app.example.com"]
}
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({
    agent_id: '6a96a3ead6e886d42462dd3e',
    lead_id: '6a96a3ead6e886d42462dd3e',
    metadata: {},
    max_duration_seconds: 600,
    allowed_origins: ['https://app.example.com']
  })
};

fetch('https://api.phone.wixzel.com/v1/realtime/sessions', 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.phone.wixzel.com/v1/realtime/sessions",
  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([
    'agent_id' => '6a96a3ead6e886d42462dd3e',
    'lead_id' => '6a96a3ead6e886d42462dd3e',
    'metadata' => [
        
    ],
    'max_duration_seconds' => 600,
    'allowed_origins' => [
        'https://app.example.com'
    ]
  ]),
  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.phone.wixzel.com/v1/realtime/sessions"

	payload := strings.NewReader("{\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"metadata\": {},\n  \"max_duration_seconds\": 600,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\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))

}

HttpResponse<String> response = Unirest.post("https://api.phone.wixzel.com/v1/realtime/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"metadata\": {},\n  \"max_duration_seconds\": 600,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.phone.wixzel.com/v1/realtime/sessions")

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  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"metadata\": {},\n  \"max_duration_seconds\": 600,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\n  ]\n}"

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

{
  "id": "rt-5b0c7c0e-9d1f-4c52-8a9e-2f0d3a4b6c7d",
  "object": "realtime_session",
  "client_secret": {
    "value": "<string>",
    "expires_at": "2026-09-01T12:00:00.000Z"
  },
  "url": "wss://api.phone.wixzel.com/v1/realtime",
  "agent_id": "6a96a3ead6e886d42462dd3e",
  "engine": "gemini_live",
  "max_duration_seconds": 123,
  "audio_format": "mulaw_8000"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your Wixzel Phone API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Body

application/json

agent_id

string

required

Pattern: ^[0-9a-f]{24}$

Example:

"6a96a3ead6e886d42462dd3e"

lead_id

string

Existing lead to attribute the session to — merge fields such as {{name}} resolve from it, and appointment booking uses its phone. Without one, merge fields resolve to nothing and the call has no lead.

Pattern: ^[0-9a-f]{24}$

Example:

"6a96a3ead6e886d42462dd3e"

metadata

object

Your own identifiers, kept verbatim on the resulting call and echoed in its callCompleted webhook. Flat, string to string. Never sent to the model.

Show child attributes

max_duration_seconds

integer

Hard cap on the conversation. Defaults to 600; at most 3600.

Required range: 10 <= x <= 3600

Example:

600

allowed_origins

string[]

When set, the socket is refused unless the browser's Origin is one of these. Recommended for browser use: it stops a secret copied out of your page being used from another site.

Maximum array length: 10

Maximum string length: 255

Pattern: ^https?:\/\/[a-z0-9.-]+(:\d{1,5})?$

Response

The session and its client secret

string

required

Becomes the session_id of the resulting call.

Example:

"rt-5b0c7c0e-9d1f-4c52-8a9e-2f0d3a4b6c7d"

object

enum<string>

required

Available options:

realtime_session

client_secret

object

required

Show child attributes

url

string

required

Example:

"wss://api.phone.wixzel.com/v1/realtime"

agent_id

string

required

Pattern: ^[0-9a-f]{24}$

Example:

"6a96a3ead6e886d42462dd3e"

engine

string

required

Example:

"gemini_live"

max_duration_seconds

integer

required

audio_format

enum<string>

required

Base64 G.711 µ-law, 8 kHz mono, both directions — what a phone line carries.

Available options:

mulaw_8000

⌘I

Create a realtime session

curl --request POST \
  --url https://api.phone.wixzel.com/v1/realtime/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "6a96a3ead6e886d42462dd3e",
  "lead_id": "6a96a3ead6e886d42462dd3e",
  "metadata": {},
  "max_duration_seconds": 600,
  "allowed_origins": [
    "https://app.example.com"
  ]
}
'

import requests

url = "https://api.phone.wixzel.com/v1/realtime/sessions"

payload = {
    "agent_id": "6a96a3ead6e886d42462dd3e",
    "lead_id": "6a96a3ead6e886d42462dd3e",
    "metadata": {},
    "max_duration_seconds": 600,
    "allowed_origins": ["https://app.example.com"]
}
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({
    agent_id: '6a96a3ead6e886d42462dd3e',
    lead_id: '6a96a3ead6e886d42462dd3e',
    metadata: {},
    max_duration_seconds: 600,
    allowed_origins: ['https://app.example.com']
  })
};

fetch('https://api.phone.wixzel.com/v1/realtime/sessions', 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.phone.wixzel.com/v1/realtime/sessions",
  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([
    'agent_id' => '6a96a3ead6e886d42462dd3e',
    'lead_id' => '6a96a3ead6e886d42462dd3e',
    'metadata' => [
        
    ],
    'max_duration_seconds' => 600,
    'allowed_origins' => [
        'https://app.example.com'
    ]
  ]),
  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.phone.wixzel.com/v1/realtime/sessions"

	payload := strings.NewReader("{\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"metadata\": {},\n  \"max_duration_seconds\": 600,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\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))

}

HttpResponse<String> response = Unirest.post("https://api.phone.wixzel.com/v1/realtime/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"metadata\": {},\n  \"max_duration_seconds\": 600,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.phone.wixzel.com/v1/realtime/sessions")

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  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"metadata\": {},\n  \"max_duration_seconds\": 600,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\n  ]\n}"

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

{
  "id": "rt-5b0c7c0e-9d1f-4c52-8a9e-2f0d3a4b6c7d",
  "object": "realtime_session",
  "client_secret": {
    "value": "<string>",
    "expires_at": "2026-09-01T12:00:00.000Z"
  },
  "url": "wss://api.phone.wixzel.com/v1/realtime",
  "agent_id": "6a96a3ead6e886d42462dd3e",
  "engine": "gemini_live",
  "max_duration_seconds": 123,
  "audio_format": "mulaw_8000"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

Getting started

Guides

Concepts

API reference

Create a realtime session

Authorizations

Body

Response