Create an Application

POSThttps://api.vobiz.ai/api/v1/Account/{authID}/Application/

Creates an Application with webhook URLs for call handling. Creating an application is usually a first step, after which you attach the application to either a number or an endpoint.

Authentication Required:

• X-Auth-ID: Your account ID (e.g., {Auth_ID})
• X-Auth-Token: Your account Auth Token

Parameters

Request Parameters

Parameter	Type	Description
`answer_url`required	string	The URL fetched when a call executes this application.
`app_name`required	string	The name of your application. Allowed Values: Alphabets (upper case and lower case), Numbers (0-9), Only 2 special characters, i.e. "-" (hyphen) and "_" (underscore)
`answer_method`optional	string	The method used to call the answer_url. Defaults to POST.
`hangup_url`optional	string	The URL notified when the call hangs up. Defaults to answer_url.
`hangup_method`optional	string	The method used to call the hangup_url. Defaults to POST.
`fallback_answer_url`optional	string	Invoked by Vobiz only if answer_url is unavailable or the XML response is invalid. Should contain an XML response.
`fallback_method`optional	string	The method used to call the fallback_answer_url. Defaults to POST.
`message_url`optional	string	The URL notified when an inbound message is received. Defaults not set.
`message_method`optional	string	The method used to call the message_url. Defaults to POST.
`default_number_app`optional	boolean	If set to true, this parameter ensures that newly created numbers that don't have an app_id point to this application.
`default_endpoint_app`optional	boolean	If set to true, this parameter ensures that newly created endpoints that don't have an app_id point to this application.
`subaccount`optional	string	ID of the subaccount that this application is associated with.
`application_type`optional	string	The type of application (e.g., "voice", "messaging").
`default_app`optional	boolean	Whether this is the default application for the account.
`enabled`optional	boolean	Whether the application is enabled. Defaults to true.
`log_incoming_messages`optional	boolean	If set to false, the content of incoming messages to Vobiz phone numbers associated with this application are not logged in Vobiz systems. Defaults to true when not specified.
`public_uri`optional	boolean	Whether the application has a public URI.
`sip_transfer_method`optional	string	HTTP method used for SIP transfer callbacks.
`sip_transfer_url`optional	string	URL notified during a SIP transfer.
`sip_uri`optional	string	SIP URI associated with the application.

Request Body

JSON

{
  "app_name": "My Voice Application",
  "answer_url": "https://example.com/answer",
  "answer_method": "POST",
  "hangup_url": "https://example.com/hangup",
  "hangup_method": "POST",
  "fallback_answer_url": "https://example.com/fallback",
  "fallback_method": "POST",
  "message_url": "https://example.com/message",
  "message_method": "POST",
  "default_number_app": false,
  "default_endpoint_app": false,
  "sub_account": null
}

Response Examples

Success Response (201 Created)

{
  "api_id": "{api_id}",
  "message": "created",
  "app_id": "12345678",
  "application_type": "voice",
  "enabled": true,
  "default_app": false,
  "resource_uri": "/v1/Account/{auth_id}/Application/12345678/"
}

Error Response (400 Bad Request)

{
  "error": "invalid request parameters",
  "details": {
    "app_name": "This field is required",
    "answer_url": "Enter a valid URL"
  }
}

cURL Example

cURL

curl -X POST https://api.vobiz.ai/api/v1/Account/{Auth_ID}/Application/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app_name": "My IVR System",
    "answer_url": "https://myapp.com/ivr/answer",
    "answer_method": "POST"
  }'

The Application Object

Retrieve an Application