Create an AI phone agent. This phone number can be used to receive and make phone calls. For now, this API only supports US phone numbers. Email mo@open.cx for other countries.
curl --request POST \
--url https://api.open.cx/phone \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"type": "inbound",
"language": "<string>",
"accent": "<string>",
"handoff_phone_number": "<string>",
"speed": 1,
"interruptible": true,
"actionIds": [
"<string>"
],
"instructions": [
"<string>"
],
"data_collection_fields": [
"<string>"
],
"data_collection_webhook_url": "<string>",
"model": "oppie-vox",
"first_message": "<string>",
"voice_id": "<string>",
"flow": "<any>",
"use_org_knowledgebase": true,
"manual_mode": true,
"custom_llm": "<string>"
}'
{
"id": "<string>",
"org_id": "<string>",
"phone_number": "<string>",
"name": "<string>",
"type": "inbound",
"language": "<string>",
"accent": "<string>",
"handoff_phone_number": "<string>",
"speed": 123,
"interruptible": true,
"actionIds": [
"<string>"
],
"instructions": [
"<string>"
],
"data_collection_fields": [
"<string>"
],
"data_collection_webhook_url": "<string>",
"model": "oppie-vox",
"voice_id": "<string>",
"first_message": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"provider_external_id": "<string>",
"flow": "<any>",
"manual_mode": true,
"custom_llm": "<string>",
"use_org_knowledgebase": true
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.open.cx/phone \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"type": "inbound",
"language": "<string>",
"accent": "<string>",
"handoff_phone_number": "<string>",
"speed": 1,
"interruptible": true,
"actionIds": [
"<string>"
],
"instructions": [
"<string>"
],
"data_collection_fields": [
"<string>"
],
"data_collection_webhook_url": "<string>",
"model": "oppie-vox",
"first_message": "<string>",
"voice_id": "<string>",
"flow": "<any>",
"use_org_knowledgebase": true,
"manual_mode": true,
"custom_llm": "<string>"
}'
{
"id": "<string>",
"org_id": "<string>",
"phone_number": "<string>",
"name": "<string>",
"type": "inbound",
"language": "<string>",
"accent": "<string>",
"handoff_phone_number": "<string>",
"speed": 123,
"interruptible": true,
"actionIds": [
"<string>"
],
"instructions": [
"<string>"
],
"data_collection_fields": [
"<string>"
],
"data_collection_webhook_url": "<string>",
"model": "oppie-vox",
"voice_id": "<string>",
"first_message": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"provider_external_id": "<string>",
"flow": "<any>",
"manual_mode": true,
"custom_llm": "<string>",
"use_org_knowledgebase": true
}