Agents

Place a test call

Ring a number and have the agent speak one phrase, then hang up. A probe rather than a conversation: it answers “is my trunk configured and does this agent sound right” in a few seconds, without anyone having to hold a conversation with it. For a real conversation use POST /v1/calls.

It rings a real phone over your real carrier and it spends real credit — the meter runs on a test call exactly as on any other, so it needs calls:write and an Idempotency-Key.

Human transfer is deliberately not offered during a test call, so this cannot be used to check that a transfer destination answers.

POST

agents

{id}

test-call

Place a test call

curl --request POST \
  --url https://api.voice.wixzel.com/v1/agents/{id}/test-call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "+14155550100",
  "from_number_id": "6a96a3ead6e886d42462dd3e",
  "phrase": "This is a test call from Wixzel Voice. Goodbye."
}
'

import requests

url = "https://api.voice.wixzel.com/v1/agents/{id}/test-call"

payload = {
    "to": "+14155550100",
    "from_number_id": "6a96a3ead6e886d42462dd3e",
    "phrase": "This is a test call from Wixzel Voice. Goodbye."
}
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({
    to: '+14155550100',
    from_number_id: '6a96a3ead6e886d42462dd3e',
    phrase: 'This is a test call from Wixzel Voice. Goodbye.'
  })
};

fetch('https://api.voice.wixzel.com/v1/agents/{id}/test-call', 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.voice.wixzel.com/v1/agents/{id}/test-call",
  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([
    'to' => '+14155550100',
    'from_number_id' => '6a96a3ead6e886d42462dd3e',
    'phrase' => 'This is a test call from Wixzel Voice. Goodbye.'
  ]),
  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.voice.wixzel.com/v1/agents/{id}/test-call"

	payload := strings.NewReader("{\n  \"to\": \"+14155550100\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"phrase\": \"This is a test call from Wixzel Voice. Goodbye.\"\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.voice.wixzel.com/v1/agents/{id}/test-call")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"+14155550100\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"phrase\": \"This is a test call from Wixzel Voice. Goodbye.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.voice.wixzel.com/v1/agents/{id}/test-call")

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  \"to\": \"+14155550100\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"phrase\": \"This is a test call from Wixzel Voice. Goodbye.\"\n}"

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

{
  "id": "6a96a3ead6e886d42462dd3e",
  "object": "call",
  "session_id": "<string>",
  "status": "queued",
  "direction": "inbound",
  "channel": "phone",
  "agent_id": "6a96a3ead6e886d42462dd3e",
  "lead_id": "6a96a3ead6e886d42462dd3e",
  "campaign_id": "6a96a3ead6e886d42462dd3e",
  "from": "<string>",
  "to": "<string>",
  "duration_seconds": 123,
  "engine": "<string>",
  "recording_url": "<string>",
  "summary": "<string>",
  "cost_micros": 194000,
  "metadata": {},
  "failure_code": 21,
  "failure_reason": "The provider rejected the call outright (403/407). In order of likelihood: your carrier account is suspended, closed, or out of balance; …",
  "caller": {
    "id": "6a96a3ead6e886d42462dd3e",
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "verified_by": "google",
    "location": {
      "city": "<string>",
      "region": "<string>",
      "country": "IN"
    },
    "platform": {
      "source": "share_link",
      "browser": "Chrome",
      "os": "Android 14",
      "device": "mobile"
    },
    "page_url": "<string>",
    "blocked": true
  },
  "started_at": "2026-09-01T12:00:00.000Z",
  "ended_at": "2026-09-01T12:00:00.000Z"
}

{
  "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 Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Path Parameters

string

required

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

Example:

"6a96a3ead6e886d42462dd3e"

Body

application/json

string

required

The number to ring. A real call to a real phone.

Pattern: ^\+[1-9]\d{6,14}$

Example:

"+14155550100"

from_number_id

string

Defaults to the agent's own outbound number.

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

Example:

"6a96a3ead6e886d42462dd3e"

phrase

string

What to say. Defaults to the agent's opening message, which is usually what you want to hear.

Required string length: 1 - 300

Example:

"This is a test call from Wixzel Voice. Goodbye."

Response

The test call, queued

string

required

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

Example:

"6a96a3ead6e886d42462dd3e"

object

enum<string>

required

Available options:

call

session_id

string

required

Stable id for this call across logs, usage and webhooks.

status

enum<string>

required

Available options:

queued,

ringing,

in-progress,

completed,

failed,

busy,

no-answer,

canceled

direction

enum<string>

required

Available options:

inbound,

outbound

channel

enum<string>

required

phone for a call over your SIP trunk; web for a realtime session from a browser or app (POST /v1/realtime/sessions); meeting for an agent in a Zoom, Google Meet or Teams meeting (POST /v1/meetings). Web sessions are inbound; their from is the caller's name or contact when known.

Available options:

phone,

web,

meeting

agent_id

string | null

required

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

Example:

"6a96a3ead6e886d42462dd3e"

lead_id

string | null

required

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

Example:

"6a96a3ead6e886d42462dd3e"

campaign_id

string | null

required

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

Example:

"6a96a3ead6e886d42462dd3e"

from

string | null

required

string | null

required

duration_seconds

integer | null

required

engine

string | null

required

recording_url

string | null

required

summary

string | null

required

cost_micros

integer | null

required

Micro-USD. 1_000_000 = $1.00.

Example:

194000

metadata

object | null

required

Whatever you attached to POST /v1/calls, returned verbatim. Null if you attached none.

Show child attributes

failure_code

integer | null

required

Q.850 hangup cause from the carrier, or null if the call connected. Branch on this rather than on failure_reason, which is prose and may be reworded. 17 busy, 19 no answer, 21 rejected by the carrier, 34 congestion, 102 timeout.

Example:

21

failure_reason

string | null

required

What to actually do about the failure, in plain language. Null if the call connected.

Example:

"The provider rejected the call outright (403/407). In order of likelihood: your carrier account is suspended, closed, or out of balance; …"

caller

object | null

required

Who called: for inbound phone calls and calls through an agent's mascot (share link, website widget, app). Null for outbound calls and API sessions.

Show child attributes

started_at

string<date-time> | null

required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

ended_at

string<date-time> | null

required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

Place a test call

curl --request POST \
  --url https://api.voice.wixzel.com/v1/agents/{id}/test-call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "+14155550100",
  "from_number_id": "6a96a3ead6e886d42462dd3e",
  "phrase": "This is a test call from Wixzel Voice. Goodbye."
}
'

import requests

url = "https://api.voice.wixzel.com/v1/agents/{id}/test-call"

payload = {
    "to": "+14155550100",
    "from_number_id": "6a96a3ead6e886d42462dd3e",
    "phrase": "This is a test call from Wixzel Voice. Goodbye."
}
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({
    to: '+14155550100',
    from_number_id: '6a96a3ead6e886d42462dd3e',
    phrase: 'This is a test call from Wixzel Voice. Goodbye.'
  })
};

fetch('https://api.voice.wixzel.com/v1/agents/{id}/test-call', 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.voice.wixzel.com/v1/agents/{id}/test-call",
  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([
    'to' => '+14155550100',
    'from_number_id' => '6a96a3ead6e886d42462dd3e',
    'phrase' => 'This is a test call from Wixzel Voice. Goodbye.'
  ]),
  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.voice.wixzel.com/v1/agents/{id}/test-call"

	payload := strings.NewReader("{\n  \"to\": \"+14155550100\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"phrase\": \"This is a test call from Wixzel Voice. Goodbye.\"\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.voice.wixzel.com/v1/agents/{id}/test-call")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"+14155550100\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"phrase\": \"This is a test call from Wixzel Voice. Goodbye.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.voice.wixzel.com/v1/agents/{id}/test-call")

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  \"to\": \"+14155550100\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"phrase\": \"This is a test call from Wixzel Voice. Goodbye.\"\n}"

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

{
  "id": "6a96a3ead6e886d42462dd3e",
  "object": "call",
  "session_id": "<string>",
  "status": "queued",
  "direction": "inbound",
  "channel": "phone",
  "agent_id": "6a96a3ead6e886d42462dd3e",
  "lead_id": "6a96a3ead6e886d42462dd3e",
  "campaign_id": "6a96a3ead6e886d42462dd3e",
  "from": "<string>",
  "to": "<string>",
  "duration_seconds": 123,
  "engine": "<string>",
  "recording_url": "<string>",
  "summary": "<string>",
  "cost_micros": 194000,
  "metadata": {},
  "failure_code": 21,
  "failure_reason": "The provider rejected the call outright (403/407). In order of likelihood: your carrier account is suspended, closed, or out of balance; …",
  "caller": {
    "id": "6a96a3ead6e886d42462dd3e",
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "verified_by": "google",
    "location": {
      "city": "<string>",
      "region": "<string>",
      "country": "IN"
    },
    "platform": {
      "source": "share_link",
      "browser": "Chrome",
      "os": "Android 14",
      "device": "mobile"
    },
    "page_url": "<string>",
    "blocked": true
  },
  "started_at": "2026-09-01T12:00:00.000Z",
  "ended_at": "2026-09-01T12:00:00.000Z"
}

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

Carriers

Concepts

API reference

Place a test call

Authorizations

Path Parameters

Body

Response