v1

latestOpenAPI 3.0.02026-07-145819.8 KB

Create an application

post/

Request body

namestring required

Application Name

Example request

{
  "capabilities": {
    "meetings": {
      "webhooks": {
        "recording_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "room_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "session_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "messages": {
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "leg_persistence_time": 5,
      "signed_callbacks": true,
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "verify": {
      "version": "v2",
      "webhooks": {
        "status_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "voice": {
      "conversation_ttl": 30,
      "payments": {
        "gateways": [
          {
            "credential": "26f2a89e-6fcd-11ed-a1eb-0242ac120002",
            "mode": "live",
            "type": "Stripe"
          }
        ]
      },
      "signed_callbacks": true,
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "connection_timeout": 500,
          "http_method": "POST",
          "socket_timeout": 3000
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "connection_timeout": 500,
          "http_method": "POST",
          "socket_timeout": 3000
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "connection_timeout": 500,
          "http_method": "POST",
          "socket_timeout": 3000
        }
      }
    }
  },
  "keys": {
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n"
  },
  "name": "Demo Application",
  "privacy": {
    "improve_ai": true
  }
}

Response

Success

idstring

The application's ID

namestring

Friendly identifier for your application. This is not unique

Example response

{
  "capabilities": {
    "meetings": {
      "webhooks": {
        "recording_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "room_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "session_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "messages": {
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "leg_persistence_time": 5,
      "signed_callbacks": true,
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "verify": {
      "version": "v2",
      "webhooks": {
        "status_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "voice": {
      "conversation_ttl": 30,
      "payments": {
        "gateways": [
          {
            "credential": "26f2a89e-6fcd-11ed-a1eb-0242ac120002",
            "mode": "live",
            "type": "Stripe"
          }
        ]
      },
      "signed_callbacks": true,
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "connection_timeout": 500,
          "http_method": "POST",
          "socket_timeout": 3000
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "connection_timeout": 500,
          "http_method": "POST",
          "socket_timeout": 3000
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "connection_timeout": 500,
          "http_method": "POST",
          "socket_timeout": 3000
        }
      }
    }
  },
  "id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
  "name": "My Application",
  "privacy": {
    "improve_ai": true
  },
  "keys": {
    "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFA\nASCBKcwggSjAgEAAoIBAQDEPpvi+3\nRH1efQ\\nkveWzZDrNNoEXmBw61w+O\n0u/N36tJnN5XnYecU64yHzu2ByEr0\n7iIvYbavFnADwl\\nHMTJwqDQakpa3\n8/SFRnTDq3zronvNZ6nOp7S6K7pcZ\nrw/CvrL6hXT1x7cGBZ4jPx\\nqhjqY\nuJPgZD7OVB69oYOV92vIIJ7JLYwqb\n-----END PRIVATE KEY-----\n",
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n"
  }
}