AgentPhone

Provision numbers, send SMS and iMessage, and place voice calls with AgentPhone

Usage Instructions

Give your workflow a phone. Provision SMS- and voice-enabled numbers, send messages and tapback reactions, place outbound voice calls, manage conversations and contacts, and track usage — all through a single AgentPhone API key.

Tools

`agentphone_create_call`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`agentId`	string	Yes	No description
`toNumber`	string	Yes	No description
`fromNumberId`	string	No	Phone number ID to use as caller ID. Must belong to the agent. If omitted, the agent's first assigned number is used.
`initialGreeting`	string	No	No description
`voice`	string	No	Voice ID override for this call (defaults to the agent's configured voice)
`systemPrompt`	string	No	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`agentId`	string	agentId output from the tool
`status`	string	status output from the tool
`toNumber`	string	toNumber output from the tool
`fromNumber`	string	fromNumber output from the tool
`phoneNumberId`	string	phoneNumberId output from the tool
`direction`	string	direction output from the tool
`startedAt`	string	startedAt output from the tool

`agentphone_create_contact`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`phoneNumber`	string	Yes	No description
`name`	string	Yes	Contact's full name
`email`	string	No	Contact's email address
`notes`	string	No	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`phoneNumber`	string	phoneNumber output from the tool
`name`	string	name output from the tool
`email`	string	email output from the tool
`notes`	string	notes output from the tool
`createdAt`	string	createdAt output from the tool
`updatedAt`	string	updatedAt output from the tool

`agentphone_create_number`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`country`	string	No	No description
`areaCode`	string	No	No description
`agentId`	string	No	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`phoneNumber`	string	phoneNumber output from the tool
`country`	string	country output from the tool
`status`	string	status output from the tool
`type`	string	type output from the tool
`agentId`	string	agentId output from the tool
`createdAt`	string	createdAt output from the tool

`agentphone_delete_contact`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`contactId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`deleted`	boolean	deleted output from the tool

`agentphone_get_call`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`callId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`agentId`	string	agentId output from the tool
`phoneNumberId`	string	phoneNumberId output from the tool
`phoneNumber`	string	phoneNumber output from the tool
`fromNumber`	string	fromNumber output from the tool
`toNumber`	string	toNumber output from the tool
`direction`	string	direction output from the tool
`status`	string	status output from the tool
`startedAt`	string	startedAt output from the tool
`endedAt`	string	endedAt output from the tool
`durationSeconds`	number	durationSeconds output from the tool
`lastTranscriptSnippet`	string	lastTranscriptSnippet output from the tool
`recordingUrl`	string	recordingUrl output from the tool
`recordingAvailable`	boolean	recordingAvailable output from the tool
`transcripts`	array	transcripts output from the tool
↳ `id`	string	id output from the tool
↳ `transcript`	string	transcript output from the tool
↳ `confidence`	number	confidence output from the tool
↳ `response`	string	response output from the tool
↳ `createdAt`	string	createdAt output from the tool

`agentphone_get_call_transcript`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`callId`	string	Yes	No description

Output

Parameter	Type	Description
`callId`	string	callId output from the tool
`transcript`	array	transcript output from the tool
↳ `role`	string	role output from the tool
↳ `content`	string	content output from the tool
↳ `createdAt`	string	createdAt output from the tool

`agentphone_get_contact`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`contactId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`phoneNumber`	string	phoneNumber output from the tool
`name`	string	name output from the tool
`email`	string	email output from the tool
`notes`	string	notes output from the tool
`createdAt`	string	createdAt output from the tool
`updatedAt`	string	updatedAt output from the tool

`agentphone_get_conversation`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`conversationId`	string	Yes	No description
`messageLimit`	number	No	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`agentId`	string	agentId output from the tool
`phoneNumberId`	string	phoneNumberId output from the tool
`phoneNumber`	string	phoneNumber output from the tool
`participant`	string	participant output from the tool
`lastMessageAt`	string	lastMessageAt output from the tool
`messageCount`	number	messageCount output from the tool
`metadata`	json	metadata output from the tool
`createdAt`	string	createdAt output from the tool
`messages`	array	messages output from the tool
↳ `id`	string	id output from the tool
↳ `body`	string	body output from the tool
↳ `fromNumber`	string	fromNumber output from the tool
↳ `toNumber`	string	toNumber output from the tool
↳ `direction`	string	direction output from the tool
↳ `channel`	string	channel output from the tool
↳ `mediaUrl`	string	mediaUrl output from the tool
↳ `receivedAt`	string	receivedAt output from the tool

`agentphone_get_conversation_messages`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`conversationId`	string	Yes	No description
`limit`	number	No	No description
`before`	string	No	No description
`after`	string	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
↳ `id`	string	id output from the tool
↳ `body`	string	body output from the tool
↳ `fromNumber`	string	fromNumber output from the tool
↳ `toNumber`	string	toNumber output from the tool
↳ `direction`	string	direction output from the tool
↳ `channel`	string	channel output from the tool
↳ `mediaUrl`	string	mediaUrl output from the tool
↳ `receivedAt`	string	receivedAt output from the tool
`hasMore`	boolean	hasMore output from the tool

`agentphone_get_number_messages`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`numberId`	string	Yes	No description
`limit`	number	No	No description
`before`	string	No	No description
`after`	string	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
↳ `id`	string	id output from the tool
↳ `from_`	string	from_ output from the tool
↳ `to`	string	to output from the tool
↳ `body`	string	body output from the tool
↳ `direction`	string	direction output from the tool
↳ `channel`	string	channel output from the tool
↳ `receivedAt`	string	receivedAt output from the tool
`hasMore`	boolean	hasMore output from the tool

`agentphone_get_usage`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description

Output

Parameter	Type	Description
`plan`	json	plan output from the tool
`numbers`	json	numbers output from the tool
`stats`	json	stats output from the tool
`periodStart`	string	periodStart output from the tool
`periodEnd`	string	periodEnd output from the tool

`agentphone_get_usage_daily`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`days`	number	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
↳ `date`	string	date output from the tool
↳ `messages`	number	messages output from the tool
↳ `calls`	number	calls output from the tool
↳ `webhooks`	number	webhooks output from the tool
`days`	number	days output from the tool

`agentphone_get_usage_monthly`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`months`	number	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
↳ `month`	string	month output from the tool
↳ `messages`	number	messages output from the tool
↳ `calls`	number	calls output from the tool
↳ `webhooks`	number	webhooks output from the tool
`months`	number	months output from the tool

`agentphone_list_calls`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`limit`	number	No	No description
`offset`	number	No	No description
`status`	string	No	No description
`direction`	string	No	No description
`type`	string	No	No description
`search`	string	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
↳ `id`	string	id output from the tool
↳ `agentId`	string	agentId output from the tool
↳ `phoneNumberId`	string	phoneNumberId output from the tool
↳ `phoneNumber`	string	phoneNumber output from the tool
↳ `fromNumber`	string	fromNumber output from the tool
↳ `toNumber`	string	toNumber output from the tool
↳ `direction`	string	direction output from the tool
↳ `status`	string	status output from the tool
↳ `startedAt`	string	startedAt output from the tool
↳ `endedAt`	string	endedAt output from the tool
↳ `durationSeconds`	number	durationSeconds output from the tool
↳ `lastTranscriptSnippet`	string	lastTranscriptSnippet output from the tool
↳ `recordingUrl`	string	recordingUrl output from the tool
↳ `recordingAvailable`	boolean	recordingAvailable output from the tool
`hasMore`	boolean	hasMore output from the tool
`total`	number	total output from the tool

`agentphone_list_contacts`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`limit`	number	No	No description
`offset`	number	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
↳ `id`	string	id output from the tool
↳ `phoneNumber`	string	phoneNumber output from the tool
↳ `name`	string	name output from the tool
↳ `email`	string	email output from the tool
↳ `notes`	string	notes output from the tool
↳ `createdAt`	string	createdAt output from the tool
↳ `updatedAt`	string	updatedAt output from the tool
`hasMore`	boolean	hasMore output from the tool
`total`	number	total output from the tool

`agentphone_list_conversations`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`limit`	number	No	No description
`offset`	number	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
↳ `id`	string	id output from the tool
↳ `agentId`	string	agentId output from the tool
↳ `phoneNumberId`	string	phoneNumberId output from the tool
↳ `phoneNumber`	string	phoneNumber output from the tool
↳ `participant`	string	participant output from the tool
↳ `lastMessageAt`	string	lastMessageAt output from the tool
↳ `lastMessagePreview`	string	lastMessagePreview output from the tool
↳ `messageCount`	number	messageCount output from the tool
↳ `metadata`	json	metadata output from the tool
↳ `createdAt`	string	createdAt output from the tool
`hasMore`	boolean	hasMore output from the tool
`total`	number	total output from the tool

`agentphone_list_numbers`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`limit`	number	No	No description
`offset`	number	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
↳ `id`	string	id output from the tool
↳ `phoneNumber`	string	phoneNumber output from the tool
↳ `country`	string	country output from the tool
↳ `status`	string	status output from the tool
↳ `type`	string	type output from the tool
↳ `agentId`	string	agentId output from the tool
↳ `createdAt`	string	createdAt output from the tool
`hasMore`	boolean	hasMore output from the tool
`total`	number	total output from the tool

`agentphone_react_to_message`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`messageId`	string	Yes	No description
`reaction`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`reactionType`	string	reactionType output from the tool
`messageId`	string	messageId output from the tool
`channel`	string	channel output from the tool

`agentphone_release_number`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`numberId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`released`	boolean	released output from the tool

`agentphone_send_message`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`agentId`	string	Yes	No description
`toNumber`	string	Yes	No description
`body`	string	Yes	No description
`mediaUrl`	string	No	No description
`numberId`	string	No	Phone number ID to send from. If omitted, the agent's first assigned number is used.

Output

Parameter	Type	Description
`id`	string	id output from the tool
`status`	string	status output from the tool
`channel`	string	channel output from the tool
`fromNumber`	string	fromNumber output from the tool
`toNumber`	string	toNumber output from the tool

`agentphone_update_contact`

Update a contact

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`contactId`	string	Yes	No description
`phoneNumber`	string	No	No description
`name`	string	No	No description
`email`	string	No	No description
`notes`	string	No	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`phoneNumber`	string	phoneNumber output from the tool
`name`	string	name output from the tool
`email`	string	email output from the tool
`notes`	string	notes output from the tool
`createdAt`	string	createdAt output from the tool
`updatedAt`	string	updatedAt output from the tool

`agentphone_update_conversation`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`conversationId`	string	Yes	No description
`metadata`	json	No	No description

Output

Parameter	Type	Description
`id`	string	id output from the tool
`agentId`	string	agentId output from the tool
`phoneNumberId`	string	phoneNumberId output from the tool
`phoneNumber`	string	phoneNumber output from the tool
`participant`	string	participant output from the tool
`lastMessageAt`	string	lastMessageAt output from the tool
`messageCount`	number	messageCount output from the tool
`metadata`	json	metadata output from the tool
`createdAt`	string	createdAt output from the tool
`messages`	array	messages output from the tool
↳ `id`	string	id output from the tool
↳ `body`	string	body output from the tool
↳ `fromNumber`	string	fromNumber output from the tool
↳ `toNumber`	string	toNumber output from the tool
↳ `direction`	string	direction output from the tool
↳ `channel`	string	channel output from the tool
↳ `mediaUrl`	string	mediaUrl output from the tool
↳ `receivedAt`	string	receivedAt output from the tool

Sur cette page

Commencez à construire aujourd’hui

Plus de 100 000 développeurs nous font confiance.

La plateforme SaaS pour créer des agents IA et piloter vos équipes agentiques.