Create Number | AgentPhone

Provision a new SMS-enabled phone number.

Check number limit (lifetime limit)
Search the account’s configured SMS provider for available numbers
Purchase the first available one
Configure messaging and voice routing
Store the number in our database

Provision a new SMS-enabled phone number. 1. Check number limit (lifetime limit) 2. Search the account's configured SMS provider for available numbers 3. Purchase the first available one 4. Configure messaging and voice routing 5. Store the number in our database

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

countrystringOptionalDefaults to US

areaCodestring or nullOptional

agentIdstring or nullOptional

Response

Successful Response

idstring

phoneNumberstring

countrystring

statusstring

createdAtdatetime

typestringDefaults to sms

agentIdstring or null

Errors

422

Unprocessable Entity Error

1	import { AgentPhoneClient } from "agentphone";
2
3	async function main() {
4	const client = new AgentPhoneClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.numbers.createNumber({});
8	}
9	main();

1	{
2	"id": "string",
3	"phoneNumber": "string",
4	"country": "string",
5	"status": "string",
6	"createdAt": "2024-01-15T09:30:00Z",
7	"type": "sms",
8	"agentId": "string"
9	}