The Application Object

The Application object contains all configuration for call and message handling, including URL endpoints and HTTP methods.

Attributes

Application Attributes

NameTypeDescription
app_id
stringUnique identifier for the application.
app_name
stringName of the application.
answer_url
stringURL called when call is answered. Vobiz requests this URL for valid Vobiz XML elements to control call flow.
answer_method
stringHTTP method for answer_url (GET or POST).
hangup_url
stringURL called when call ends. Useful for call analytics and cleanup operations.
hangup_method
stringHTTP method for hangup_url (GET or POST).
fallback_answer_url
stringBackup URL if answer_url fails or returns invalid XML.
fallback_method
stringHTTP method for fallback URL (GET or POST).
message_url
stringURL for SMS message callbacks. Vobiz expects HTTP 200 status code.
message_method
stringHTTP method for message_url (GET or POST).
default_number_app
booleanDefault app for phone numbers. If true, newly created numbers without app_id use this application.
default_endpoint_app
booleanDefault app for SIP endpoints. If true, newly created endpoints without app_id use this application.
sub_account
stringSub-account auth_id (null for main account).
resource_uri
stringAPI resource URI.
created_at
string (ISO 8601)Creation timestamp.
updated_at
string (ISO 8601)Last update timestamp.

Example Application Object

JSON
{
  "api_id": "550e8400-e29b-41d4-a716-446655440000",
  "app_id": "12345678",
  "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,
  "resource_uri": "/v1/Account/{Auth_ID}/Application/12345678/",
  "created_at": "2025-10-28T10:30:00Z",
  "updated_at": "2025-10-28T10:30:00Z"
}