Register an org phone number
POST
/
v1
/
communication
/
phone-numbers
Register an org phone number
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/communication/phone-numbers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"phone_e164": "<string>",
"vendor": "twilio",
"capabilities": [],
"vendor_metadata": {},
"integration_connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/communication/phone-numbers"
payload = {
"phone_e164": "<string>",
"vendor": "twilio",
"capabilities": [],
"vendor_metadata": {},
"integration_connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone_e164: '<string>',
vendor: 'twilio',
capabilities: [],
vendor_metadata: {},
integration_connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api-sandbox.featherhq.com/v1/communication/phone-numbers', 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-sandbox.featherhq.com/v1/communication/phone-numbers",
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([
'phone_e164' => '<string>',
'vendor' => 'twilio',
'capabilities' => [
],
'vendor_metadata' => [
],
'integration_connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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-sandbox.featherhq.com/v1/communication/phone-numbers"
payload := strings.NewReader("{\n \"phone_e164\": \"<string>\",\n \"vendor\": \"twilio\",\n \"capabilities\": [],\n \"vendor_metadata\": {},\n \"integration_connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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-sandbox.featherhq.com/v1/communication/phone-numbers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone_e164\": \"<string>\",\n \"vendor\": \"twilio\",\n \"capabilities\": [],\n \"vendor_metadata\": {},\n \"integration_connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/communication/phone-numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_e164\": \"<string>\",\n \"vendor\": \"twilio\",\n \"capabilities\": [],\n \"vendor_metadata\": {},\n \"integration_connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone_e164": "<string>",
"vendor": "twilio",
"vendor_mode": "platform",
"capabilities": [
"sms"
],
"vendor_metadata": {},
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"retired_at": "2023-11-07T05:31:56Z",
"retired_by": "<string>",
"restored_at": "2023-11-07T05:31:56Z",
"restored_by": "<string>"
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
Required string length:
2 - 20Available options:
twilio Available options:
platform, byo Available options:
sms, voice BYOT only. Pin the new Sender to a specific connected Twilio integration. Required when the org has more than one connected Twilio integration; when omitted, the service auto-discovers the org's single connected integration and 422s on ambiguity.
Response
Successful Response
Available options:
twilio Available options:
platform, byo Available options:
sms, voice Available options:
active, paused, retired Was this page helpful?
⌘I
Register an org phone number
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/communication/phone-numbers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"phone_e164": "<string>",
"vendor": "twilio",
"capabilities": [],
"vendor_metadata": {},
"integration_connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/communication/phone-numbers"
payload = {
"phone_e164": "<string>",
"vendor": "twilio",
"capabilities": [],
"vendor_metadata": {},
"integration_connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone_e164: '<string>',
vendor: 'twilio',
capabilities: [],
vendor_metadata: {},
integration_connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api-sandbox.featherhq.com/v1/communication/phone-numbers', 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-sandbox.featherhq.com/v1/communication/phone-numbers",
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([
'phone_e164' => '<string>',
'vendor' => 'twilio',
'capabilities' => [
],
'vendor_metadata' => [
],
'integration_connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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-sandbox.featherhq.com/v1/communication/phone-numbers"
payload := strings.NewReader("{\n \"phone_e164\": \"<string>\",\n \"vendor\": \"twilio\",\n \"capabilities\": [],\n \"vendor_metadata\": {},\n \"integration_connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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-sandbox.featherhq.com/v1/communication/phone-numbers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone_e164\": \"<string>\",\n \"vendor\": \"twilio\",\n \"capabilities\": [],\n \"vendor_metadata\": {},\n \"integration_connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/communication/phone-numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_e164\": \"<string>\",\n \"vendor\": \"twilio\",\n \"capabilities\": [],\n \"vendor_metadata\": {},\n \"integration_connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone_e164": "<string>",
"vendor": "twilio",
"vendor_mode": "platform",
"capabilities": [
"sms"
],
"vendor_metadata": {},
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"retired_at": "2023-11-07T05:31:56Z",
"retired_by": "<string>",
"restored_at": "2023-11-07T05:31:56Z",
"restored_by": "<string>"
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}