Skip to main content
POST
/
v1
/
phone-numbers
/
link-agent
Link Bot to Phone Number
curl --request POST \
  --url https://api.openmic.ai/v1/phone-numbers/link-agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number_id": "ybhb8wzi487w02m2bc7dh0ev",
  "agent_id": "bvrg8wzi487w02m2bc7dh0ev",
  "direction": "both"
}
'
import requests

url = "https://api.openmic.ai/v1/phone-numbers/link-agent"

payload = {
"phone_number_id": "ybhb8wzi487w02m2bc7dh0ev",
"agent_id": "bvrg8wzi487w02m2bc7dh0ev",
"direction": "both"
}
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({
phone_number_id: 'ybhb8wzi487w02m2bc7dh0ev',
agent_id: 'bvrg8wzi487w02m2bc7dh0ev',
direction: 'both'
})
};

fetch('https://api.openmic.ai/v1/phone-numbers/link-agent', 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.openmic.ai/v1/phone-numbers/link-agent",
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_number_id' => 'ybhb8wzi487w02m2bc7dh0ev',
'agent_id' => 'bvrg8wzi487w02m2bc7dh0ev',
'direction' => 'both'
]),
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.openmic.ai/v1/phone-numbers/link-agent"

payload := strings.NewReader("{\n \"phone_number_id\": \"ybhb8wzi487w02m2bc7dh0ev\",\n \"agent_id\": \"bvrg8wzi487w02m2bc7dh0ev\",\n \"direction\": \"both\"\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.openmic.ai/v1/phone-numbers/link-agent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number_id\": \"ybhb8wzi487w02m2bc7dh0ev\",\n \"agent_id\": \"bvrg8wzi487w02m2bc7dh0ev\",\n \"direction\": \"both\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.openmic.ai/v1/phone-numbers/link-agent")

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 \"phone_number_id\": \"ybhb8wzi487w02m2bc7dh0ev\",\n \"agent_id\": \"bvrg8wzi487w02m2bc7dh0ev\",\n \"direction\": \"both\"\n}"

response = http.request(request)
puts response.read_body
{
  "phone_number_id": "ybhb8wzi487w02m2bc7dh0ev",
  "phone_number": "+15551112222",
  "inbound_agent_id": "bvrg8wzi487w02m2bc7dh0ev",
  "outbound_agent_id": "bvrg8wzi487w02m2bc7dh0ev",
  "message": "Bot linked successfully for inbound and outbound calls."
}
{
"error": "Invalid direction specified. Must be one of 'inbound', 'outbound', 'both'."
}
{
"error": "Unauthorized",
"message": "Invalid or expired API key"
}
{
"error": "The specified phone number or bot was not found."
}
{
"error": "An unexpected error occurred. Please try again later."
}

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as: Authorization: Bearer <your-api-key>

Body

application/json

Bot linking details

phone_number_id
string
required

Unique identifier of the phone number

agent_id
string
required

Bot ID to link

direction
enum<string>
required

Direction for the bot assignment

Available options:
inbound,
outbound,
both

Response

Bot linked to phone number successfully

phone_number_id
string
required

Unique identifier of the phone number

phone_number
string
required

Phone number in E.164 format

message
string
required

Success message

inbound_agent_id
string

Bot ID for inbound calls

outbound_agent_id
string

Bot ID for outbound calls