The Application Object
The Application object contains all configuration for call and message handling, including URL endpoints and HTTP methods.
Attributes
Application Attributes
| Parameter | Type | Description |
|---|---|---|
app_idoptional | string | Unique identifier for the application. |
app_nameoptional | string | Name of the application. |
answer_urloptional | string | URL called when call is answered. Vobiz requests this URL for valid Vobiz XML elements to control call flow. |
answer_methodoptional | string | HTTP method for answer_url (GET or POST). |
hangup_urloptional | string | URL called when call ends. Useful for call analytics and cleanup operations. |
hangup_methodoptional | string | HTTP method for hangup_url (GET or POST). |
fallback_answer_urloptional | string | Backup URL if answer_url fails or returns invalid XML. |
fallback_methodoptional | string | HTTP method for fallback URL (GET or POST). |
message_urloptional | string | URL for SMS message callbacks. Vobiz expects HTTP 200 status code. |
message_methodoptional | string | HTTP method for message_url (GET or POST). |
default_number_appoptional | boolean | Default app for phone numbers. If true, newly created numbers without app_id use this application. |
default_endpoint_appoptional | boolean | Default app for SIP endpoints. If true, newly created endpoints without app_id use this application. |
sub_accountoptional | string | Sub-account auth_id (null for main account). |
resource_urioptional | string | API resource URI. |
application_typeoptional | string | The type of application (e.g., "voice", "messaging"). |
default_appoptional | boolean | Whether this is the default application for the account. |
enabledoptional | boolean | Whether the application is enabled. |
log_incoming_messageoptional | boolean | Whether incoming messages are logged. |
public_urioptional | boolean | Whether the application has a public URI. |
sip_transfer_methodoptional | string | HTTP method used for SIP transfer callbacks. |
sip_transfer_urloptional | string | URL notified during a SIP transfer. |
sip_urioptional | string | SIP URI associated with the application. |
created_atoptional | string (ISO 8601) | Creation timestamp. |
updated_atoptional | string (ISO 8601) | Last update timestamp. |
Example Application Object
JSON
{
"api_id": "{api_id}",
"app_id": "12345678",
"app_name": "My Voice Application",
"application_type": "voice",
"enabled": true,
"default_app": false,
"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",
"log_incoming_message": true,
"public_uri": false,
"sip_transfer_method": "POST",
"sip_transfer_url": "https://example.com/sip-transfer",
"sip_uri": "sip:12345678@vobiz.ai",
"default_number_app": false,
"default_endpoint_app": false,
"sub_account": null,
"resource_uri": "/v1/Account/{auth_id}/Application/12345678/",
"created_at": "2025-10-28T10:30:00Z",
"updated_at": "2025-10-28T10:30:00Z"
}