Contacts
Sessions
AI Phone Agents
AI Email
AI WhatsApp
AI Outbound Sequencing
AI Training
Customer Insights
Groups (teams)
Webhooks
AI Phone Agents
Create an AI phone agent
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.
POST
/
phone
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": {
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
{
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
{
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
"<any>"
]
}
]
}
]
},
"use_org_knowledgebase": true
}'
{
"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": {
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
{
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
{
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
"<any>"
]
}
]
}
]
},
"use_org_knowledgebase": true
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201
application/json
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": {
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
{
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
{
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
"<any>"
]
}
]
}
]
},
"use_org_knowledgebase": true
}'
{
"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": {
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
{
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
{
"id": "<string>",
"type": "root",
"content": "<string>",
"connectionType": "true",
"position": {
"x": 123,
"y": 123
},
"children": [
"<any>"
]
}
]
}
]
},
"use_org_knowledgebase": true
}
Assistant
Responses are generated using AI and may contain mistakes.