Numbers
List available numbers
GET
/
v1
/
numbers
/
available
curl --request GET \
--url https://api.fluents.ai/v1/numbers/available \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"number": "+1234567890",
"active": true,
"label": "My Phone Number",
"inbound_agent_name": "Agent Name",
"outbound_only": false,
"example_context": {},
"telephony_provider": "twilio",
"telephony_account_connection": {},
"description": "Business line for customer service",
"inbound_agent": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "My Agent",
"prompt": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"label": "My Prompt",
"description": "This is a description",
"content": "You are a helpful assistant...",
"context_endpoint": "https://api.example.com/context",
"collect_fields": [
"<string>"
],
"type": "prompt",
"tags": [
"tag1",
"tag2"
],
"prompt_template": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"required_context_keys": [
"tag1",
"tag2"
],
"label": "My Prompt"
}
},
"language": "en",
"actions": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"type": "action_transfer_call",
"label": "Transfer Call",
"description": "This is a description",
"config": {},
"action_trigger": {}
}
],
"voice": {},
"initial_message": "Hello, how can I help you today?",
"webhook": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"subscriptions": [
"event_message",
"event_action"
],
"url": "https://example.com/webhook",
"method": "POST",
"label": "My Webhook",
"description": "This is a description"
},
"interrupt_sensitivity": "low",
"context_endpoint": "https://api.example.com/context",
"noise_suppression": true,
"endpointing_sensitivity": "auto",
"ivr_navigation_mode": "default",
"conversation_speed": 0.5,
"initial_message_delay": 1000,
"openai_model_name_override": "gpt-4",
"ask_if_human_present_on_idle": true,
"openai_account_connection": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"label": "My Account Connection",
"description": "This is a description",
"type": "account_connection_twilio",
"credentials": {
"twilio_account_sid": "AC1234567890",
"twilio_auth_token": "1234567890"
},
"steering_pool": [
"+1234567890"
],
"account_supports_any_caller_id": false,
"config": {
"voicemail_detection": {}
}
},
"run_do_not_call_detection": true,
"llm_fallback": {},
"deepgram_keywords": {
"kansas": "10"
},
"idle_time_seconds": 10,
"llm_temperature": 0.5,
"enable_recording": true,
"provider": "openai",
"model": "gpt-4",
"label": "My Agent",
"description": "This is a description",
"transcriber": {},
"call_duration_sec": 10,
"max_idle_check_count": 10,
"max_aggregate_idle_check_count": 123,
"idle_after_interaction_seconds": 123,
"voicemail_message": "<string>"
}
}
],
"total": 10
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Response
200
application/json
The response is of type object
.
curl --request GET \
--url https://api.fluents.ai/v1/numbers/available \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"number": "+1234567890",
"active": true,
"label": "My Phone Number",
"inbound_agent_name": "Agent Name",
"outbound_only": false,
"example_context": {},
"telephony_provider": "twilio",
"telephony_account_connection": {},
"description": "Business line for customer service",
"inbound_agent": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "My Agent",
"prompt": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"label": "My Prompt",
"description": "This is a description",
"content": "You are a helpful assistant...",
"context_endpoint": "https://api.example.com/context",
"collect_fields": [
"<string>"
],
"type": "prompt",
"tags": [
"tag1",
"tag2"
],
"prompt_template": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"required_context_keys": [
"tag1",
"tag2"
],
"label": "My Prompt"
}
},
"language": "en",
"actions": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"type": "action_transfer_call",
"label": "Transfer Call",
"description": "This is a description",
"config": {},
"action_trigger": {}
}
],
"voice": {},
"initial_message": "Hello, how can I help you today?",
"webhook": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"subscriptions": [
"event_message",
"event_action"
],
"url": "https://example.com/webhook",
"method": "POST",
"label": "My Webhook",
"description": "This is a description"
},
"interrupt_sensitivity": "low",
"context_endpoint": "https://api.example.com/context",
"noise_suppression": true,
"endpointing_sensitivity": "auto",
"ivr_navigation_mode": "default",
"conversation_speed": 0.5,
"initial_message_delay": 1000,
"openai_model_name_override": "gpt-4",
"ask_if_human_present_on_idle": true,
"openai_account_connection": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"label": "My Account Connection",
"description": "This is a description",
"type": "account_connection_twilio",
"credentials": {
"twilio_account_sid": "AC1234567890",
"twilio_auth_token": "1234567890"
},
"steering_pool": [
"+1234567890"
],
"account_supports_any_caller_id": false,
"config": {
"voicemail_detection": {}
}
},
"run_do_not_call_detection": true,
"llm_fallback": {},
"deepgram_keywords": {
"kansas": "10"
},
"idle_time_seconds": 10,
"llm_temperature": 0.5,
"enable_recording": true,
"provider": "openai",
"model": "gpt-4",
"label": "My Agent",
"description": "This is a description",
"transcriber": {},
"call_duration_sec": 10,
"max_idle_check_count": 10,
"max_aggregate_idle_check_count": 123,
"idle_after_interaction_seconds": 123,
"voicemail_message": "<string>"
}
}
],
"total": 10
}