Create Phone Call
curl --request POST \
--url https://api.voiceos.io/conversations/create_phone_call \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"from_number": "<string>",
"to_number": "<string>",
"agent_id": "<string>",
"agent_config": {
"initial_message": "<string>",
"prompt": "<string>",
"voice": {
"provider": "playht",
"credential_id": "<string>",
"model": "susan",
"speed": 1,
"temperature": 1,
"text_guidance": 1.5,
"style_guidance": 15.5
},
"language_model": {
"provider": "openai",
"credential_id": "<string>",
"model": "gpt-3.5-turbo",
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
}
}
],
"temperature": 0,
"max_tokens": 300
},
"transcriber": {
"provider": "deepgram",
"credential_id": "<string>",
"model": "nova-2",
"language": "en",
"keywords": []
},
"max_duration_seconds": 600,
"webhooks": [
{
"events": [
"phone_call:connection_requested"
],
"filter": "<string>",
"url": "<string>",
"method": "GET",
"headers": {}
}
],
"hooks": [
{
"events": [
"phone_call:connection_requested"
],
"filter": "<string>",
"instructions": [
{
"instruction": "hang_up"
}
]
}
],
"metadata": {}
}
}'{
"uri": "<string>",
"type": "inbound_phone_call",
"account_id": "<string>",
"status": "started",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"agent_config": {
"initial_message": "<string>",
"prompt": "<string>",
"voice": {
"provider": "playht",
"credential_id": "<string>",
"model": "susan",
"speed": 1,
"temperature": 1,
"text_guidance": 1.5,
"style_guidance": 15.5
},
"language_model": {
"provider": "openai",
"credential_id": "<string>",
"model": "gpt-3.5-turbo",
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
}
}
],
"temperature": 0,
"max_tokens": 300
},
"transcriber": {
"provider": "deepgram",
"credential_id": "<string>",
"model": "nova-2",
"language": "en",
"keywords": []
},
"max_duration_seconds": 600,
"webhooks": [
{
"events": [
"phone_call:connection_requested"
],
"filter": "<string>",
"url": "<string>",
"method": "GET",
"headers": {}
}
],
"hooks": [
{
"events": [
"phone_call:connection_requested"
],
"filter": "<string>",
"instructions": [
{
"instruction": "hang_up"
}
]
}
],
"metadata": {}
},
"agent_id": "<string>",
"messages": [],
"phone_call": {
"provider": "twilio",
"to_number": "<string>",
"from_number": "<string>"
},
"ended_reason": "agent_ended",
"cost_breakdown": {
"total": 123,
"voice": {
"provider": "azure",
"cost": 123,
"characters": 123
},
"transcriber": {
"provider": "deepgram",
"cost": 123,
"seconds": 123
},
"language_model": {
"provider": "openai",
"cost": 123,
"input_tokens": 123,
"output_tokens": 123
},
"telephony": {
"provider": "twilio",
"cost": 123,
"seconds": 123
},
"agent": {
"provider": "voiceos",
"cost": 123,
"seconds": 123
}
},
"id": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The phone number associated with the account from which the call will be made.
The phone number to call including the country code.
The agent id to use for the conversation. If null, the agent configuration will be used.
The agent configuration to use for the conversation. If null, the agent id will be used.
The initial message that the agent will say. If null, the agent will wait for the user to speak first.
The prompt of the agent.
The voice provider.
playht The credential id to use for the provider. If null, we include the provider cost in the conversation.
The playht model to use.
susan, william, phoebe, arthur, ayla, dylan, madelyn, oliver, sophia Control how fast the generated audio should be. A number greater than 0 and less than or equal to 5.0
0 <= x <= 5A floating point number between 0, inclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used.
0 <= x <= 2A number between 1 and 2. This number influences how closely the generated speech adheres to the input text.
1 <= x <= 2A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.
1 <= x <= 30The language model provider.
openai The credential id to use for the provider. If null, we include the provider cost in the conversation.
The OpenAI language model to use.
gpt-3.5-turbo, gpt-3.5-turbo-0125, gpt-3.5-turbo-1106, gpt-3.5-turbo-16k, gpt-3.5-turbo-0613, gpt-4-turbo, gpt-4-turbo-2024-04-09, gpt-4-turbo-preview, gpt-4-0125-preview, gpt-4-1106-preview, gpt-4-0613, gpt-4, gpt-4o The list of OpenAI tools.
The function definition to be called.
This is the name of the function to be called. Must be less than 64 characters (a-z, A-Z, 0-9, including underscores).
The description of the OpenAI function call.
The parameters of the OpenAI function call.
This is the type of OpenAI Tool.
function The temperature of the model. Default is 0 for optimized caching performance.
0 <= x <= 2The maximum number of tokens to generate for an each response from the agent. Default is 300.
The transcriber provider.
deepgram The credential id to use for the provider. If null, we include the provider cost in the conversation.
The deepgram model to use.
nova-2, nova-2-general, nova-2-meeting, nova-2-phonecall, nova-2-finance, nova-2-voicemail, nova-2-medical, nova-2-drivethru, nova-2-automotive, nova-2-conversationalai The selected language for the transcription.
en, fr, es, de, it, nl, pt, ru, ja, cs, da, el, hi, id, ko, no, pl, sv, tr, uk Specific keywords you want to detect in the transcription. This is useful to correctly understand product or company names.
The maximum conversation duration in seconds. If null, the conversation can be of any duration. The default value is 10 min.
The webhooks of the agent. These are used for real-time conversation events such as function_calls, messages and much more.
The url of the webhook. Where the requests will be sent.
The method of the webhook.
GET, POST An enumeration.
phone_call:connection_requested, phone_call:rejected, phone_call:accepted, function_call:triggered, conversation:started, conversation:ended, conversation:duration, speech:started, speech:ended, message:sent, message:generated The hooks of the agent. These are used for real-time conversation events such as function_calls, messages and much more.
hang_up An enumeration.
phone_call:connection_requested, phone_call:rejected, phone_call:accepted, function_call:triggered, conversation:started, conversation:ended, conversation:duration, speech:started, speech:ended, message:sent, message:generated Response
The uri of the conversation.
The type of conversation.
inbound_phone_call, outbound_phone_call, web_call The account id associated with of the conversation.
The status of the conversation.
started, ended, queued The agent configuration used for the conversation.
The initial message that the agent will say. If null, the agent will wait for the user to speak first.
The prompt of the agent.
The voice provider.
playht The credential id to use for the provider. If null, we include the provider cost in the conversation.
The playht model to use.
susan, william, phoebe, arthur, ayla, dylan, madelyn, oliver, sophia Control how fast the generated audio should be. A number greater than 0 and less than or equal to 5.0
0 <= x <= 5A floating point number between 0, inclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used.
0 <= x <= 2A number between 1 and 2. This number influences how closely the generated speech adheres to the input text.
1 <= x <= 2A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.
1 <= x <= 30The language model provider.
openai The credential id to use for the provider. If null, we include the provider cost in the conversation.
The OpenAI language model to use.
gpt-3.5-turbo, gpt-3.5-turbo-0125, gpt-3.5-turbo-1106, gpt-3.5-turbo-16k, gpt-3.5-turbo-0613, gpt-4-turbo, gpt-4-turbo-2024-04-09, gpt-4-turbo-preview, gpt-4-0125-preview, gpt-4-1106-preview, gpt-4-0613, gpt-4, gpt-4o The list of OpenAI tools.
The function definition to be called.
This is the name of the function to be called. Must be less than 64 characters (a-z, A-Z, 0-9, including underscores).
The description of the OpenAI function call.
The parameters of the OpenAI function call.
This is the type of OpenAI Tool.
function The temperature of the model. Default is 0 for optimized caching performance.
0 <= x <= 2The maximum number of tokens to generate for an each response from the agent. Default is 300.
The transcriber provider.
deepgram The credential id to use for the provider. If null, we include the provider cost in the conversation.
The deepgram model to use.
nova-2, nova-2-general, nova-2-meeting, nova-2-phonecall, nova-2-finance, nova-2-voicemail, nova-2-medical, nova-2-drivethru, nova-2-automotive, nova-2-conversationalai The selected language for the transcription.
en, fr, es, de, it, nl, pt, ru, ja, cs, da, el, hi, id, ko, no, pl, sv, tr, uk Specific keywords you want to detect in the transcription. This is useful to correctly understand product or company names.
The maximum conversation duration in seconds. If null, the conversation can be of any duration. The default value is 10 min.
The webhooks of the agent. These are used for real-time conversation events such as function_calls, messages and much more.
The url of the webhook. Where the requests will be sent.
The method of the webhook.
GET, POST An enumeration.
phone_call:connection_requested, phone_call:rejected, phone_call:accepted, function_call:triggered, conversation:started, conversation:ended, conversation:duration, speech:started, speech:ended, message:sent, message:generated The hooks of the agent. These are used for real-time conversation events such as function_calls, messages and much more.
hang_up An enumeration.
phone_call:connection_requested, phone_call:rejected, phone_call:accepted, function_call:triggered, conversation:started, conversation:ended, conversation:duration, speech:started, speech:ended, message:sent, message:generated The id of the conversation.
The start time of the conversation.
The end time of the conversation. Returns null if the conversation is has not ended.
The id of the agent used in the conversation. Returns null if the conversation did not use an existing agent.
The phone call details of the conversation. Returns null if the conversation was over web.
The reasons the conversation ended.
agent_ended, user_ended, unknown The cost breakdown of the conversation.
The total cost of the conversation (USD).
The voice cost.
The provider of the synthetizer.
azure, elevenlabs, rimeai, deepgram, playht The cost for the voice usage (USD).
The number of characters used for the voice.
The transcriber cost.
The provider of the transcriber.
deepgram, azure The cost for the transcriber usage (USD).
The number of seconds used for the transcriber.
The language model cost.
The provider of the language model.
openai, google The cost for the language model usage (USD).
The number of input tokens used for the language model.
The number of output tokens used for the language model.
The cost of the agent.
The telephony cost. Returns null if the conversation was over web.
The provider of the phone number used.
twilio The cost for the telephony usage. Returns zero, if the phone number was imported.
The number of seconds used for the telephony.
curl --request POST \
--url https://api.voiceos.io/conversations/create_phone_call \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"from_number": "<string>",
"to_number": "<string>",
"agent_id": "<string>",
"agent_config": {
"initial_message": "<string>",
"prompt": "<string>",
"voice": {
"provider": "playht",
"credential_id": "<string>",
"model": "susan",
"speed": 1,
"temperature": 1,
"text_guidance": 1.5,
"style_guidance": 15.5
},
"language_model": {
"provider": "openai",
"credential_id": "<string>",
"model": "gpt-3.5-turbo",
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
}
}
],
"temperature": 0,
"max_tokens": 300
},
"transcriber": {
"provider": "deepgram",
"credential_id": "<string>",
"model": "nova-2",
"language": "en",
"keywords": []
},
"max_duration_seconds": 600,
"webhooks": [
{
"events": [
"phone_call:connection_requested"
],
"filter": "<string>",
"url": "<string>",
"method": "GET",
"headers": {}
}
],
"hooks": [
{
"events": [
"phone_call:connection_requested"
],
"filter": "<string>",
"instructions": [
{
"instruction": "hang_up"
}
]
}
],
"metadata": {}
}
}'{
"uri": "<string>",
"type": "inbound_phone_call",
"account_id": "<string>",
"status": "started",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"agent_config": {
"initial_message": "<string>",
"prompt": "<string>",
"voice": {
"provider": "playht",
"credential_id": "<string>",
"model": "susan",
"speed": 1,
"temperature": 1,
"text_guidance": 1.5,
"style_guidance": 15.5
},
"language_model": {
"provider": "openai",
"credential_id": "<string>",
"model": "gpt-3.5-turbo",
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
}
}
],
"temperature": 0,
"max_tokens": 300
},
"transcriber": {
"provider": "deepgram",
"credential_id": "<string>",
"model": "nova-2",
"language": "en",
"keywords": []
},
"max_duration_seconds": 600,
"webhooks": [
{
"events": [
"phone_call:connection_requested"
],
"filter": "<string>",
"url": "<string>",
"method": "GET",
"headers": {}
}
],
"hooks": [
{
"events": [
"phone_call:connection_requested"
],
"filter": "<string>",
"instructions": [
{
"instruction": "hang_up"
}
]
}
],
"metadata": {}
},
"agent_id": "<string>",
"messages": [],
"phone_call": {
"provider": "twilio",
"to_number": "<string>",
"from_number": "<string>"
},
"ended_reason": "agent_ended",
"cost_breakdown": {
"total": 123,
"voice": {
"provider": "azure",
"cost": 123,
"characters": 123
},
"transcriber": {
"provider": "deepgram",
"cost": 123,
"seconds": 123
},
"language_model": {
"provider": "openai",
"cost": 123,
"input_tokens": 123,
"output_tokens": 123
},
"telephony": {
"provider": "twilio",
"cost": 123,
"seconds": 123
},
"agent": {
"provider": "voiceos",
"cost": 123,
"seconds": 123
}
},
"id": "<string>"
}