Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Attributes

FieldTypeDescription
app_idstringUnique identifier for the application.
app_namestringName of the application.
answer_urlstringURL called when a call is answered. Vobiz requests this URL for valid VobizXML elements to control call flow.
answer_methodstringHTTP method for answer_url (GET or POST).
hangup_urlstringURL called when a call ends. Useful for call analytics and cleanup operations.
hangup_methodstringHTTP method for hangup_url (GET or POST).
fallback_answer_urlstringBackup URL if answer_url fails or returns invalid XML.
fallback_methodstringHTTP method for the fallback URL (GET or POST).
message_urlstringURL for SMS message callbacks. Vobiz expects an HTTP 200 status code.
message_methodstringHTTP method for message_url (GET or POST).
default_number_appbooleanDefault app for phone numbers. If true, newly created numbers without an app_id use this application.
default_endpoint_appbooleanDefault app for SIP endpoints. If true, newly created endpoints without an app_id use this application.
sub_accountstringSub-account auth_id (null for main account).
resource_uristringAPI resource URI.
application_typestringThe type of application (e.g., “voice”, “messaging”).
default_appbooleanWhether this is the default application for the account.
enabledbooleanWhether the application is enabled.
log_incoming_messagebooleanWhether incoming messages are logged.
public_uribooleanWhether the application has a public URI.
sip_transfer_methodstringHTTP method used for SIP transfer callbacks.
sip_transfer_urlstringURL notified during a SIP transfer.
sip_uristringSIP URI associated with the application.
created_atstring (ISO 8601)Creation timestamp.
updated_atstring (ISO 8601)Last update timestamp.

​
Example Application Object

JSON
{
  "answer_method": "POST",
  "answer_url": "https://example.com/answer",
  "api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "app_id": "12345678901234567",
  "app_name": "My Voice App",
  "application_type": "XML",
  "created_at": "2026-04-02 12:11:19.740666+00:00",
  "default_app": false,
  "default_endpoint_app": false,
  "enabled": true,
  "fallback_answer_url": null,
  "fallback_method": "POST",
  "hangup_method": "POST",
  "hangup_url": "https://example.com/hangup",
  "log_incoming_message": true,
  "message_method": "POST",
  "message_url": null,
  "public_uri": false,
  "resource_uri": "/v1/Account/MA_XXXXXXXX/Application/12345678901234567/",
  "sip_transfer_method": "POST",
  "sip_transfer_url": null,
  "sip_uri": "sip:12345678901234567@app.vobiz.ai",
  "sub_account": null,
  "updated_at": "2026-04-02 12:11:19.740666+00:00"
}