Add Custom Phone Number

Adds a custom phone number to an agent. The user must configure their SIP trunk to point to Phonic's SIP server.

Authentication

AuthorizationBearer

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Bearer authentication header of the form `Bearer <PHONIC_API_KEY>`. Manage your API keys [here](https://phonic.co/api-keys).

Path parameters

nameOrIdstringRequired

The name or the ID of the agent.

Headers

Query parameters

projectstringOptionalDefaults to main

The name of the project containing the agent. Only used when nameOrId is a name.

Request

This endpoint expects an object.

phone_numberstringRequired

The E.164 formatted phone number to add (e.g., “+15551234567”).

configuration_endpointobject or nullOptional

When not null, the agent will call this endpoint to get configuration options for calls on this phone number.

sipobjectOptional

SIP trunk settings for this phone number, applied to both its inbound trunk and the trunk created for each outbound call. Set at creation; remove and re-add the number to change them.

Response

Success response

successboolean

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

1	from phonic import Phonic
2
3	client = Phonic(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.agents.add_custom_phone_number(
8	name_or_id="nameOrId",
9	project="main",
10	sip_address="X-Sip-Address",
11	sip_auth_username="X-Sip-Auth-Username",
12	sip_auth_password="X-Sip-Auth-Password",
13	)