Skip to main content
POST
/
h
/
v2
/
phone-numbers
/
link-agent
Link an agent to a phone number
curl --request POST \
  --url https://api.openmic.ai/h/v2/phone-numbers/link-agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number_id": "pn_abc123",
  "agent_uid": "agent_abc123",
  "direction": "inbound"
}
'
{
  "id": "<string>",
  "phone_number": "<string>",
  "name": "<string>",
  "inbound_agent_uid": "<string>",
  "outbound_agent_uid": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Body

application/json
​
phone_number_id
string
required
​
agent_uid
string
required
​
direction
enum<string>
required
Available options:
inbound,
outbound,
both

Response

Updated phone number.

​
id
string
required
​
phone_number
string
required
​
name
string
​
inbound_agent_uid
string
​
outbound_agent_uid
string
​
created_at
string<date-time>
​
updated_at
string<date-time>