Bandwidth · Schema
Call
Call schema from Bandwidth voice API
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA
Properties
| Name | Type | Description |
|---|---|---|
| callId | string | The unique identifier for the call |
| accountId | string | The Bandwidth account ID |
| applicationId | string | The application ID associated with the call |
| to | string | The destination phone number |
| from | string | The originating phone number |
| direction | string | The direction of the call |
| state | string | The current state of the call |
| startTime | string | The time the call was initiated |
| answerTime | string | The time the call was answered |
| endTime | string | The time the call ended |
| disconnectCause | string | The reason the call was disconnected |
| tag | string | Custom tag attached to the call |
| callUrl | string | The URL for this call resource |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-schema/voice-call-schema.json",
"title": "Call",
"description": "Call schema from Bandwidth voice API",
"type": "object",
"properties": {
"callId": {
"type": "string",
"description": "The unique identifier for the call"
},
"accountId": {
"type": "string",
"description": "The Bandwidth account ID"
},
"applicationId": {
"type": "string",
"description": "The application ID associated with the call"
},
"to": {
"type": "string",
"description": "The destination phone number"
},
"from": {
"type": "string",
"description": "The originating phone number"
},
"direction": {
"type": "string",
"enum": [
"inbound",
"outbound"
],
"description": "The direction of the call"
},
"state": {
"type": "string",
"enum": [
"initiated",
"answered",
"completed"
],
"description": "The current state of the call"
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "The time the call was initiated"
},
"answerTime": {
"type": "string",
"format": "date-time",
"description": "The time the call was answered"
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "The time the call ended"
},
"disconnectCause": {
"type": "string",
"description": "The reason the call was disconnected"
},
"tag": {
"type": "string",
"description": "Custom tag attached to the call"
},
"callUrl": {
"type": "string",
"format": "uri",
"description": "The URL for this call resource"
}
}
}