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

Authorization
string
header
required

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.