curl --request GET \
--url https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration', 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://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"registration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"details": {
"legal_name": "<string>",
"business_type": "Co-operative",
"industry": "AGRICULTURE",
"registration_type": "EIN",
"registration_number": "<string>",
"website": "<string>",
"regions": [
"AFRICA"
],
"company_type": "private",
"stock_exchange": "",
"stock_ticker": "",
"brand_contact_email": "",
"volume": "low",
"use_case": "LOW_VOLUME",
"representative_first_name": "<string>",
"representative_last_name": "<string>",
"representative_email": "jsmith@example.com",
"representative_phone": "<string>",
"representative_title": "<string>",
"representative_position": "Director",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"campaign_description": "<string>",
"message_flow": "<string>",
"message_samples": [
"<string>"
],
"privacy_policy_url": "<string>",
"terms_url": "<string>",
"has_links": true,
"has_phone_numbers": true,
"age_gated": true,
"direct_lending": true,
"consent_confirmed": true
},
"phone_number_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"last_error": "<string>",
"paid_until": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"quote": {
"quote_ref": "<string>",
"setup_amount": 123,
"monthly_amount": 123,
"currency": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"number_status": "<string>"
}
}Get SMS registration
Read registration for a purchased active US local SMS-capable number in the active workspace. Requires phone_numbers:read.
curl --request GET \
--url https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration', 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://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/phone-numbers/{id}/sms-registration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"registration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"details": {
"legal_name": "<string>",
"business_type": "Co-operative",
"industry": "AGRICULTURE",
"registration_type": "EIN",
"registration_number": "<string>",
"website": "<string>",
"regions": [
"AFRICA"
],
"company_type": "private",
"stock_exchange": "",
"stock_ticker": "",
"brand_contact_email": "",
"volume": "low",
"use_case": "LOW_VOLUME",
"representative_first_name": "<string>",
"representative_last_name": "<string>",
"representative_email": "jsmith@example.com",
"representative_phone": "<string>",
"representative_title": "<string>",
"representative_position": "Director",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>",
"campaign_description": "<string>",
"message_flow": "<string>",
"message_samples": [
"<string>"
],
"privacy_policy_url": "<string>",
"terms_url": "<string>",
"has_links": true,
"has_phone_numbers": true,
"age_gated": true,
"direct_lending": true,
"consent_confirmed": true
},
"phone_number_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"last_error": "<string>",
"paid_until": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"quote": {
"quote_ref": "<string>",
"setup_amount": 123,
"monthly_amount": 123,
"currency": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"number_status": "<string>"
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.
Path Parameters
Response
Workspace registration, reviewed quote and status. Provider identifiers and internal billing details are omitted.
Show child attributes
Show child attributes