Skip to main content
POST
/
phone-numbers
/
verified-caller-ids
Start caller ID verification
curl --request POST \
  --url https://api.helloannie.com/v1/phone-numbers/verified-caller-ids \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "friendlyName": "<string>"
}
'
import requests

url = "https://api.helloannie.com/v1/phone-numbers/verified-caller-ids"

payload = {
"phoneNumber": "<string>",
"friendlyName": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({phoneNumber: '<string>', friendlyName: '<string>'})
};

fetch('https://api.helloannie.com/v1/phone-numbers/verified-caller-ids', 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/phone-numbers/verified-caller-ids",
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([
'phoneNumber' => '<string>',
'friendlyName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/phone-numbers/verified-caller-ids"

payload := strings.NewReader("{\n \"phoneNumber\": \"<string>\",\n \"friendlyName\": \"<string>\"\n}")

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

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/phone-numbers/verified-caller-ids")
.header("Content-Type", "application/json")
.body("{\n \"phoneNumber\": \"<string>\",\n \"friendlyName\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.helloannie.com/v1/phone-numbers/verified-caller-ids")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"phoneNumber\": \"<string>\",\n \"friendlyName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "verifiedCallerId": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phoneNumber": "<string>",
      "friendlyName": "<string>",
      "status": "PENDING",
      "verificationStartedAt": "2023-11-07T05:31:56Z",
      "verifiedAt": "2023-11-07T05:31:56Z"
    },
    "validationCode": "<string>"
  },
  "message": "<string>"
}
{
"success": false,
"data": {},
"message": "<string>"
}
{
"success": false,
"data": {},
"message": "<string>"
}

Body

Payload to start phone number verification via Twilio

phoneNumber
string
required

Phone number to verify in E.164 format (+1XXXXXXXXXX)

friendlyName
string
required

Friendly name displayed by carriers when using this caller ID. Maximum 64 characters.

Required string length: 1 - 64

Response

Response after starting verification. Includes validation code to enter during the Twilio call.

success
enum<boolean>
required
Available options:
true
data
object
required
message
string
required