Calls
Place or schedule a call
Place a phone call now or schedule it with an idempotent request.
POST
/
api
/
v1
/
calls
Place or schedule a phone call
curl --request POST \
--url https://us.api.hellotars.com/api/v1/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fromNumber": "<string>",
"toNumber": "<string>",
"agentId": "<string>",
"variables": {},
"metadata": {},
"customSipHeaders": {},
"ignoreE164Validation": false,
"destinationTimezone": "<string>",
"scheduledAt": 123,
"language": "<string>"
}
'import requests
url = "https://us.api.hellotars.com/api/v1/calls"
payload = {
"fromNumber": "<string>",
"toNumber": "<string>",
"agentId": "<string>",
"variables": {},
"metadata": {},
"customSipHeaders": {},
"ignoreE164Validation": False,
"destinationTimezone": "<string>",
"scheduledAt": 123,
"language": "<string>"
}
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({
fromNumber: '<string>',
toNumber: '<string>',
agentId: '<string>',
variables: {},
metadata: {},
customSipHeaders: {},
ignoreE164Validation: false,
destinationTimezone: '<string>',
scheduledAt: 123,
language: '<string>'
})
};
fetch('https://us.api.hellotars.com/api/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://us.api.hellotars.com/api/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([
'fromNumber' => '<string>',
'toNumber' => '<string>',
'agentId' => '<string>',
'variables' => [
],
'metadata' => [
],
'customSipHeaders' => [
],
'ignoreE164Validation' => false,
'destinationTimezone' => '<string>',
'scheduledAt' => 123,
'language' => '<string>'
]),
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://us.api.hellotars.com/api/v1/calls"
payload := strings.NewReader("{\n \"fromNumber\": \"<string>\",\n \"toNumber\": \"<string>\",\n \"agentId\": \"<string>\",\n \"variables\": {},\n \"metadata\": {},\n \"customSipHeaders\": {},\n \"ignoreE164Validation\": false,\n \"destinationTimezone\": \"<string>\",\n \"scheduledAt\": 123,\n \"language\": \"<string>\"\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://us.api.hellotars.com/api/v1/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fromNumber\": \"<string>\",\n \"toNumber\": \"<string>\",\n \"agentId\": \"<string>\",\n \"variables\": {},\n \"metadata\": {},\n \"customSipHeaders\": {},\n \"ignoreE164Validation\": false,\n \"destinationTimezone\": \"<string>\",\n \"scheduledAt\": 123,\n \"language\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.hellotars.com/api/v1/calls")
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 \"fromNumber\": \"<string>\",\n \"toNumber\": \"<string>\",\n \"agentId\": \"<string>\",\n \"variables\": {},\n \"metadata\": {},\n \"customSipHeaders\": {},\n \"ignoreE164Validation\": false,\n \"destinationTimezone\": \"<string>\",\n \"scheduledAt\": 123,\n \"language\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"callId": "<string>",
"status": "registered",
"scheduled": false,
"warnings": [
{
"code": "variable_coerced",
"path": "<string>"
}
]
}{
"scheduledCallId": "<string>",
"scheduled": null,
"scheduledAt": 123,
"warnings": [
{
"code": "variable_coerced",
"path": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}This capability is in beta. Behavior can change before general availability.
Related pages
Authorizations
Headers
Body
application/json
Place or schedule a phone call.
⌘I
Place or schedule a phone call
curl --request POST \
--url https://us.api.hellotars.com/api/v1/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fromNumber": "<string>",
"toNumber": "<string>",
"agentId": "<string>",
"variables": {},
"metadata": {},
"customSipHeaders": {},
"ignoreE164Validation": false,
"destinationTimezone": "<string>",
"scheduledAt": 123,
"language": "<string>"
}
'import requests
url = "https://us.api.hellotars.com/api/v1/calls"
payload = {
"fromNumber": "<string>",
"toNumber": "<string>",
"agentId": "<string>",
"variables": {},
"metadata": {},
"customSipHeaders": {},
"ignoreE164Validation": False,
"destinationTimezone": "<string>",
"scheduledAt": 123,
"language": "<string>"
}
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({
fromNumber: '<string>',
toNumber: '<string>',
agentId: '<string>',
variables: {},
metadata: {},
customSipHeaders: {},
ignoreE164Validation: false,
destinationTimezone: '<string>',
scheduledAt: 123,
language: '<string>'
})
};
fetch('https://us.api.hellotars.com/api/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://us.api.hellotars.com/api/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([
'fromNumber' => '<string>',
'toNumber' => '<string>',
'agentId' => '<string>',
'variables' => [
],
'metadata' => [
],
'customSipHeaders' => [
],
'ignoreE164Validation' => false,
'destinationTimezone' => '<string>',
'scheduledAt' => 123,
'language' => '<string>'
]),
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://us.api.hellotars.com/api/v1/calls"
payload := strings.NewReader("{\n \"fromNumber\": \"<string>\",\n \"toNumber\": \"<string>\",\n \"agentId\": \"<string>\",\n \"variables\": {},\n \"metadata\": {},\n \"customSipHeaders\": {},\n \"ignoreE164Validation\": false,\n \"destinationTimezone\": \"<string>\",\n \"scheduledAt\": 123,\n \"language\": \"<string>\"\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://us.api.hellotars.com/api/v1/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fromNumber\": \"<string>\",\n \"toNumber\": \"<string>\",\n \"agentId\": \"<string>\",\n \"variables\": {},\n \"metadata\": {},\n \"customSipHeaders\": {},\n \"ignoreE164Validation\": false,\n \"destinationTimezone\": \"<string>\",\n \"scheduledAt\": 123,\n \"language\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.hellotars.com/api/v1/calls")
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 \"fromNumber\": \"<string>\",\n \"toNumber\": \"<string>\",\n \"agentId\": \"<string>\",\n \"variables\": {},\n \"metadata\": {},\n \"customSipHeaders\": {},\n \"ignoreE164Validation\": false,\n \"destinationTimezone\": \"<string>\",\n \"scheduledAt\": 123,\n \"language\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"callId": "<string>",
"status": "registered",
"scheduled": false,
"warnings": [
{
"code": "variable_coerced",
"path": "<string>"
}
]
}{
"scheduledCallId": "<string>",
"scheduled": null,
"scheduledAt": 123,
"warnings": [
{
"code": "variable_coerced",
"path": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "invalid_json",
"retryable": true,
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"required": "<string>",
"region": "<string>",
"field": "email",
"contactId": "<string>",
"callId": "<string>",
"reason": "<string>"
}