Skip to main content
POST
Link Bot to Phone Number

Authorizations

Authorization
string
header
required

API key authentication. Include your secret API key (omic_...) in the Authorization header as: Authorization: Bearer <your-api-key>. The public key (omic_pub_...) is only accepted by the endpoints the browser widgets call (/whoami, /test-call, /workflow-test-call, and the chat endpoints); every other endpoint rejects it with 403 This endpoint requires a private 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