Place a call

POST

calls

Place a call

curl --request POST \
  --url https://api.phone.wixzel.com/v1/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "to": "+14155550100",
  "agent_id": "6a96a3ead6e886d42462dd3e",
  "from_number_id": "6a96a3ead6e886d42462dd3e",
  "lead_id": "6a96a3ead6e886d42462dd3e",
  "lead_name": "<string>",
  "metadata": {}
}
'

import requests

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

payload = {
    "to": "+14155550100",
    "agent_id": "6a96a3ead6e886d42462dd3e",
    "from_number_id": "6a96a3ead6e886d42462dd3e",
    "lead_id": "6a96a3ead6e886d42462dd3e",
    "lead_name": "<string>",
    "metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    to: '+14155550100',
    agent_id: '6a96a3ead6e886d42462dd3e',
    from_number_id: '6a96a3ead6e886d42462dd3e',
    lead_id: '6a96a3ead6e886d42462dd3e',
    lead_name: '<string>',
    metadata: {}
  })
};

fetch('https://api.phone.wixzel.com/v1/calls', 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/calls",
  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',
    'agent_id' => '6a96a3ead6e886d42462dd3e',
    'from_number_id' => '6a96a3ead6e886d42462dd3e',
    'lead_id' => '6a96a3ead6e886d42462dd3e',
    'lead_name' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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/calls"

	payload := strings.NewReader("{\n  \"to\": \"+14155550100\",\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_name\": \"<string>\",\n  \"metadata\": {}\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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/calls")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"+14155550100\",\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_name\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"to\": \"+14155550100\",\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_name\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "id": "6a96a3ead6e886d42462dd3e",
  "object": "call",
  "session_id": "<string>",
  "status": "queued",
  "direction": "inbound",
  "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,
  "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; …",
  "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>"
  }
}

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

Headers

Idempotency-Key

string

required

A unique value per call attempt, e.g. a UUID.

Required string length: 1 - 255

Body

application/json

string

required

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

Example:

"+14155550100"

agent_id

string

required

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

Example:

"6a96a3ead6e886d42462dd3e"

from_number_id

string

Defaults to the agent's outbound number.

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

Example:

"6a96a3ead6e886d42462dd3e"

lead_id

string

Existing lead to attribute the call to. One is created if omitted.

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

Example:

"6a96a3ead6e886d42462dd3e"

lead_name

string

Maximum string length: 200

metadata

object

Echoed back on the call and in webhooks. Not sent to the model.

Show child attributes

Response

The call, queued for dialling

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

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

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; …"

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"

⌘I

Place a call

curl --request POST \
  --url https://api.phone.wixzel.com/v1/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "to": "+14155550100",
  "agent_id": "6a96a3ead6e886d42462dd3e",
  "from_number_id": "6a96a3ead6e886d42462dd3e",
  "lead_id": "6a96a3ead6e886d42462dd3e",
  "lead_name": "<string>",
  "metadata": {}
}
'

import requests

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

payload = {
    "to": "+14155550100",
    "agent_id": "6a96a3ead6e886d42462dd3e",
    "from_number_id": "6a96a3ead6e886d42462dd3e",
    "lead_id": "6a96a3ead6e886d42462dd3e",
    "lead_name": "<string>",
    "metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    to: '+14155550100',
    agent_id: '6a96a3ead6e886d42462dd3e',
    from_number_id: '6a96a3ead6e886d42462dd3e',
    lead_id: '6a96a3ead6e886d42462dd3e',
    lead_name: '<string>',
    metadata: {}
  })
};

fetch('https://api.phone.wixzel.com/v1/calls', 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/calls",
  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',
    'agent_id' => '6a96a3ead6e886d42462dd3e',
    'from_number_id' => '6a96a3ead6e886d42462dd3e',
    'lead_id' => '6a96a3ead6e886d42462dd3e',
    'lead_name' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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/calls"

	payload := strings.NewReader("{\n  \"to\": \"+14155550100\",\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_name\": \"<string>\",\n  \"metadata\": {}\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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/calls")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"+14155550100\",\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_name\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"to\": \"+14155550100\",\n  \"agent_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"from_number_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_id\": \"6a96a3ead6e886d42462dd3e\",\n  \"lead_name\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "id": "6a96a3ead6e886d42462dd3e",
  "object": "call",
  "session_id": "<string>",
  "status": "queued",
  "direction": "inbound",
  "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,
  "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; …",
  "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>"
  }
}

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

Authorizations

Headers

Body

Response