Start outbound call
curl --request POST \
--url https://api.helloannie.com/v1/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fromNumber": "+15551234567",
"toNumber": "+15559876543",
"patientInfo": {
"firstName": "Sarah",
"lastName": "Johnson",
"dateOfBirth": "1988-03-22",
"patientId": "PAT-10432"
},
"appointmentInfo": {
"startTime": "2025-03-10T15:00:00-06:00",
"endTime": "2025-03-10T15:30:00-06:00",
"appointmentTypeId": "apt-type-cleaning",
"appointmentDescription": "6-month routine cleaning and exam",
"appointmentId": "81260683"
},
"context": "Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM",
"voicemailMessage": "Hi, this is Annie from Bright Smile Dental. Please call us back."
}
'import requests
url = "https://api.helloannie.com/v1/calls"
payload = {
"fromNumber": "+15551234567",
"toNumber": "+15559876543",
"patientInfo": {
"firstName": "Sarah",
"lastName": "Johnson",
"dateOfBirth": "1988-03-22",
"patientId": "PAT-10432"
},
"appointmentInfo": {
"startTime": "2025-03-10T15:00:00-06:00",
"endTime": "2025-03-10T15:30:00-06:00",
"appointmentTypeId": "apt-type-cleaning",
"appointmentDescription": "6-month routine cleaning and exam",
"appointmentId": "81260683"
},
"context": "Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM",
"voicemailMessage": "Hi, this is Annie from Bright Smile Dental. Please call us back."
}
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: '+15551234567',
toNumber: '+15559876543',
patientInfo: {
firstName: 'Sarah',
lastName: 'Johnson',
dateOfBirth: '1988-03-22',
patientId: 'PAT-10432'
},
appointmentInfo: {
startTime: '2025-03-10T15:00:00-06:00',
endTime: '2025-03-10T15:30:00-06:00',
appointmentTypeId: 'apt-type-cleaning',
appointmentDescription: '6-month routine cleaning and exam',
appointmentId: '81260683'
},
context: 'Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM',
voicemailMessage: 'Hi, this is Annie from Bright Smile Dental. Please call us back.'
})
};
fetch('https://api.helloannie.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.helloannie.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([
'fromNumber' => '+15551234567',
'toNumber' => '+15559876543',
'patientInfo' => [
'firstName' => 'Sarah',
'lastName' => 'Johnson',
'dateOfBirth' => '1988-03-22',
'patientId' => 'PAT-10432'
],
'appointmentInfo' => [
'startTime' => '2025-03-10T15:00:00-06:00',
'endTime' => '2025-03-10T15:30:00-06:00',
'appointmentTypeId' => 'apt-type-cleaning',
'appointmentDescription' => '6-month routine cleaning and exam',
'appointmentId' => '81260683'
],
'context' => 'Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM',
'voicemailMessage' => 'Hi, this is Annie from Bright Smile Dental. Please call us back.'
]),
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.helloannie.com/v1/calls"
payload := strings.NewReader("{\n \"fromNumber\": \"+15551234567\",\n \"toNumber\": \"+15559876543\",\n \"patientInfo\": {\n \"firstName\": \"Sarah\",\n \"lastName\": \"Johnson\",\n \"dateOfBirth\": \"1988-03-22\",\n \"patientId\": \"PAT-10432\"\n },\n \"appointmentInfo\": {\n \"startTime\": \"2025-03-10T15:00:00-06:00\",\n \"endTime\": \"2025-03-10T15:30:00-06:00\",\n \"appointmentTypeId\": \"apt-type-cleaning\",\n \"appointmentDescription\": \"6-month routine cleaning and exam\",\n \"appointmentId\": \"81260683\"\n },\n \"context\": \"Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM\",\n \"voicemailMessage\": \"Hi, this is Annie from Bright Smile Dental. Please call us back.\"\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.helloannie.com/v1/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fromNumber\": \"+15551234567\",\n \"toNumber\": \"+15559876543\",\n \"patientInfo\": {\n \"firstName\": \"Sarah\",\n \"lastName\": \"Johnson\",\n \"dateOfBirth\": \"1988-03-22\",\n \"patientId\": \"PAT-10432\"\n },\n \"appointmentInfo\": {\n \"startTime\": \"2025-03-10T15:00:00-06:00\",\n \"endTime\": \"2025-03-10T15:30:00-06:00\",\n \"appointmentTypeId\": \"apt-type-cleaning\",\n \"appointmentDescription\": \"6-month routine cleaning and exam\",\n \"appointmentId\": \"81260683\"\n },\n \"context\": \"Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM\",\n \"voicemailMessage\": \"Hi, this is Annie from Bright Smile Dental. Please call us back.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloannie.com/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\": \"+15551234567\",\n \"toNumber\": \"+15559876543\",\n \"patientInfo\": {\n \"firstName\": \"Sarah\",\n \"lastName\": \"Johnson\",\n \"dateOfBirth\": \"1988-03-22\",\n \"patientId\": \"PAT-10432\"\n },\n \"appointmentInfo\": {\n \"startTime\": \"2025-03-10T15:00:00-06:00\",\n \"endTime\": \"2025-03-10T15:30:00-06:00\",\n \"appointmentTypeId\": \"apt-type-cleaning\",\n \"appointmentDescription\": \"6-month routine cleaning and exam\",\n \"appointmentId\": \"81260683\"\n },\n \"context\": \"Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM\",\n \"voicemailMessage\": \"Hi, this is Annie from Bright Smile Dental. Please call us back.\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}Calls
Start outbound call
Initiate an outbound call from an Annie phone number to a destination number. Calls are subject to legal hours (9 AM–8 PM org timezone) and per-number rate limits. Rate limits per destination number: max 6 calls per rolling 30 days, min 24 hours between attempts, 30-day cooldown after 3 consecutive failed attempts, and max 3 attempts per rolling 7 days. Set test: true for demo calls: test calls skip the per-number limits and do not count toward them. Numbers on the calling organization’s test phone number list are unlimited; other numbers are capped at 20 test calls per organization per UTC day. Calling hours apply to every call, including test calls. Returns a conversation ID for tracking the call.
POST
/
calls
Start outbound call
curl --request POST \
--url https://api.helloannie.com/v1/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fromNumber": "+15551234567",
"toNumber": "+15559876543",
"patientInfo": {
"firstName": "Sarah",
"lastName": "Johnson",
"dateOfBirth": "1988-03-22",
"patientId": "PAT-10432"
},
"appointmentInfo": {
"startTime": "2025-03-10T15:00:00-06:00",
"endTime": "2025-03-10T15:30:00-06:00",
"appointmentTypeId": "apt-type-cleaning",
"appointmentDescription": "6-month routine cleaning and exam",
"appointmentId": "81260683"
},
"context": "Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM",
"voicemailMessage": "Hi, this is Annie from Bright Smile Dental. Please call us back."
}
'import requests
url = "https://api.helloannie.com/v1/calls"
payload = {
"fromNumber": "+15551234567",
"toNumber": "+15559876543",
"patientInfo": {
"firstName": "Sarah",
"lastName": "Johnson",
"dateOfBirth": "1988-03-22",
"patientId": "PAT-10432"
},
"appointmentInfo": {
"startTime": "2025-03-10T15:00:00-06:00",
"endTime": "2025-03-10T15:30:00-06:00",
"appointmentTypeId": "apt-type-cleaning",
"appointmentDescription": "6-month routine cleaning and exam",
"appointmentId": "81260683"
},
"context": "Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM",
"voicemailMessage": "Hi, this is Annie from Bright Smile Dental. Please call us back."
}
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: '+15551234567',
toNumber: '+15559876543',
patientInfo: {
firstName: 'Sarah',
lastName: 'Johnson',
dateOfBirth: '1988-03-22',
patientId: 'PAT-10432'
},
appointmentInfo: {
startTime: '2025-03-10T15:00:00-06:00',
endTime: '2025-03-10T15:30:00-06:00',
appointmentTypeId: 'apt-type-cleaning',
appointmentDescription: '6-month routine cleaning and exam',
appointmentId: '81260683'
},
context: 'Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM',
voicemailMessage: 'Hi, this is Annie from Bright Smile Dental. Please call us back.'
})
};
fetch('https://api.helloannie.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.helloannie.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([
'fromNumber' => '+15551234567',
'toNumber' => '+15559876543',
'patientInfo' => [
'firstName' => 'Sarah',
'lastName' => 'Johnson',
'dateOfBirth' => '1988-03-22',
'patientId' => 'PAT-10432'
],
'appointmentInfo' => [
'startTime' => '2025-03-10T15:00:00-06:00',
'endTime' => '2025-03-10T15:30:00-06:00',
'appointmentTypeId' => 'apt-type-cleaning',
'appointmentDescription' => '6-month routine cleaning and exam',
'appointmentId' => '81260683'
],
'context' => 'Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM',
'voicemailMessage' => 'Hi, this is Annie from Bright Smile Dental. Please call us back.'
]),
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.helloannie.com/v1/calls"
payload := strings.NewReader("{\n \"fromNumber\": \"+15551234567\",\n \"toNumber\": \"+15559876543\",\n \"patientInfo\": {\n \"firstName\": \"Sarah\",\n \"lastName\": \"Johnson\",\n \"dateOfBirth\": \"1988-03-22\",\n \"patientId\": \"PAT-10432\"\n },\n \"appointmentInfo\": {\n \"startTime\": \"2025-03-10T15:00:00-06:00\",\n \"endTime\": \"2025-03-10T15:30:00-06:00\",\n \"appointmentTypeId\": \"apt-type-cleaning\",\n \"appointmentDescription\": \"6-month routine cleaning and exam\",\n \"appointmentId\": \"81260683\"\n },\n \"context\": \"Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM\",\n \"voicemailMessage\": \"Hi, this is Annie from Bright Smile Dental. Please call us back.\"\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.helloannie.com/v1/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fromNumber\": \"+15551234567\",\n \"toNumber\": \"+15559876543\",\n \"patientInfo\": {\n \"firstName\": \"Sarah\",\n \"lastName\": \"Johnson\",\n \"dateOfBirth\": \"1988-03-22\",\n \"patientId\": \"PAT-10432\"\n },\n \"appointmentInfo\": {\n \"startTime\": \"2025-03-10T15:00:00-06:00\",\n \"endTime\": \"2025-03-10T15:30:00-06:00\",\n \"appointmentTypeId\": \"apt-type-cleaning\",\n \"appointmentDescription\": \"6-month routine cleaning and exam\",\n \"appointmentId\": \"81260683\"\n },\n \"context\": \"Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM\",\n \"voicemailMessage\": \"Hi, this is Annie from Bright Smile Dental. Please call us back.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloannie.com/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\": \"+15551234567\",\n \"toNumber\": \"+15559876543\",\n \"patientInfo\": {\n \"firstName\": \"Sarah\",\n \"lastName\": \"Johnson\",\n \"dateOfBirth\": \"1988-03-22\",\n \"patientId\": \"PAT-10432\"\n },\n \"appointmentInfo\": {\n \"startTime\": \"2025-03-10T15:00:00-06:00\",\n \"endTime\": \"2025-03-10T15:30:00-06:00\",\n \"appointmentTypeId\": \"apt-type-cleaning\",\n \"appointmentDescription\": \"6-month routine cleaning and exam\",\n \"appointmentId\": \"81260683\"\n },\n \"context\": \"Confirming upcoming cleaning appointment scheduled for March 10th at 3:00 PM\",\n \"voicemailMessage\": \"Hi, this is Annie from Bright Smile Dental. Please call us back.\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}{
"success": false,
"data": {},
"message": "<string>"
}Authorizations
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Request body for starting an outbound call
Appointment information for context during the call
Show child attributes
Show child attributes
Example:
{
"startTime": "2025-03-10T15:00:00-06:00",
"endTime": "2025-03-10T15:30:00-06:00",
"appointmentTypeId": "apt-type-cleaning",
"appointmentDescription": "6-month routine cleaning and exam",
"appointmentId": "81260683"
}
Mark this as a demo call. Test calls skip per-number limits, so you can call the same number again. Numbers on the calling organization's test phone number list are unlimited; other numbers are capped at 20 test calls per UTC day for the calling organization. Every call, including test calls, must be placed within calling hours. Test calls do not count toward per-number limits for later calls.
Example:
true