Map agent or workflow to a phone line

curl --request POST \
  --url https://api.kupe.in/api/v1/phone/mapping \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent_id": "00000000-0000-0000-0000-000000000001",
  "phone_number_id": "00000000-0000-0000-0000-000000000002"
}
'

{}

Incoming calls

Map agent or workflow to a phone line

Full URL: POST https://api.kupe.in/api/v1/phone/mapping

Attaches an agent (or workflow) to a phone_numbers row so inbound PSTN on that line reaches the correct assistant. Phone numbers should be provisioned in E.164 where possible (e.g. +91xxxxxxxxxx for India, +1xxxxxxxxxx for the US).

Send exactly one of agent_id or workflow_id.

Authentication: Use x-api-key or Bearer JWT. webhook_url, config_source, and user_id are optional; when omitted they are set by the server from deployment config and the authenticated principal (see schema AgentPhoneMappingRequest).

Response payload: webhook_url and config_source are internal implementation details and are not returned by this endpoint.

POST

api

phone

mapping

Map agent or workflow to a phone line

curl --request POST \
  --url https://api.kupe.in/api/v1/phone/mapping \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent_id": "00000000-0000-0000-0000-000000000001",
  "phone_number_id": "00000000-0000-0000-0000-000000000002"
}
'

{}

Authorizations

x-api-key

string

header

default:YOUR_KUPE_API_KEY

required

Kupe dashboard API key for your user.

Body

application/json

Link exactly one of agent_id or workflow_id to a phone_number_id. Server-managed fields: When you authenticate with Bearer or x-api-key, you do not need to send webhook_url, config_source, or user_id. The API derives the inbound voice webhook from the deployment base URL, defaults the config source for standard PSTN/Twilio lines, and uses the authenticated user for ownership checks against the phone row. (Optional body overrides remain supported for internal or legacy clients.)

phone_number_id

string<uuid>

required

agent_id

string<uuid> | null

workflow_id

string<uuid> | null

Response

Mapping created

The response is of type object.

Get all phone numbers Initiate outbound call