Assign a BYO phone number
curl --request POST \
--url 'https://api.vida.dev/api/v2/phoneNumber/byo/assign?token=' \
--header 'Content-Type: application/json' \
--data '
{
"number": "+12145551234",
"providerId": "Bird",
"channelId": "614208aa-1234"
}
'import requests
url = "https://api.vida.dev/api/v2/phoneNumber/byo/assign?token="
payload = {
"number": "+12145551234",
"providerId": "Bird",
"channelId": "614208aa-1234"
}
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({number: '+12145551234', providerId: 'Bird', channelId: '614208aa-1234'})
};
fetch('https://api.vida.dev/api/v2/phoneNumber/byo/assign?token=', 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.vida.dev/api/v2/phoneNumber/byo/assign?token=",
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([
'number' => '+12145551234',
'providerId' => 'Bird',
'channelId' => '614208aa-1234'
]),
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.vida.dev/api/v2/phoneNumber/byo/assign?token="
payload := strings.NewReader("{\n \"number\": \"+12145551234\",\n \"providerId\": \"Bird\",\n \"channelId\": \"614208aa-1234\"\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.vida.dev/api/v2/phoneNumber/byo/assign?token=")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"+12145551234\",\n \"providerId\": \"Bird\",\n \"channelId\": \"614208aa-1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/phoneNumber/byo/assign?token=")
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 \"number\": \"+12145551234\",\n \"providerId\": \"Bird\",\n \"channelId\": \"614208aa-1234\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Success"
}{
"success": false,
"message": "A descriptive error message"
}Phone Numbers
Assign a BYO phone number
Assign a phone number you are supplying yourself to an agent. Requires reseller account.
POST
/
api
/
v2
/
phoneNumber
/
byo
/
assign
Assign a BYO phone number
curl --request POST \
--url 'https://api.vida.dev/api/v2/phoneNumber/byo/assign?token=' \
--header 'Content-Type: application/json' \
--data '
{
"number": "+12145551234",
"providerId": "Bird",
"channelId": "614208aa-1234"
}
'import requests
url = "https://api.vida.dev/api/v2/phoneNumber/byo/assign?token="
payload = {
"number": "+12145551234",
"providerId": "Bird",
"channelId": "614208aa-1234"
}
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({number: '+12145551234', providerId: 'Bird', channelId: '614208aa-1234'})
};
fetch('https://api.vida.dev/api/v2/phoneNumber/byo/assign?token=', 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.vida.dev/api/v2/phoneNumber/byo/assign?token=",
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([
'number' => '+12145551234',
'providerId' => 'Bird',
'channelId' => '614208aa-1234'
]),
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.vida.dev/api/v2/phoneNumber/byo/assign?token="
payload := strings.NewReader("{\n \"number\": \"+12145551234\",\n \"providerId\": \"Bird\",\n \"channelId\": \"614208aa-1234\"\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.vida.dev/api/v2/phoneNumber/byo/assign?token=")
.header("Content-Type", "application/json")
.body("{\n \"number\": \"+12145551234\",\n \"providerId\": \"Bird\",\n \"channelId\": \"614208aa-1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/phoneNumber/byo/assign?token=")
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 \"number\": \"+12145551234\",\n \"providerId\": \"Bird\",\n \"channelId\": \"614208aa-1234\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Success"
}{
"success": false,
"message": "A descriptive error message"
}Authorizations
Vida API Token
Body
application/json
Phone Number to assign to your account
Example:
"+12145551234"
Numbering provider to assign the number through (e.g. Bird). Defaults to the account's configured provider.
Example:
"Bird"
For Bird BYO: the id of the existing SMS channel for this number.
Example:
"614208aa-1234"