Bandwidth · Schema

Endpoint

An E911 endpoint representing an end user

CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Properties

Name Type Description
endpointId string The unique identifier for the endpoint
alternateEndUserId string The Alternate End User ID (AEUI) that identifies the end user
callerName string The name of the end user for PSAP display
locationId string The ID of the validated location associated with this endpoint
telephoneNumber string The phone number associated with this endpoint
activated boolean Whether the endpoint is currently active
View JSON Schema on GitHub

JSON Schema

emergency-calling-endpoint-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-schema/emergency-calling-endpoint-schema.json",
  "title": "Endpoint",
  "description": "An E911 endpoint representing an end user",
  "type": "object",
  "properties": {
    "endpointId": {
      "type": "string",
      "description": "The unique identifier for the endpoint"
    },
    "alternateEndUserId": {
      "type": "string",
      "description": "The Alternate End User ID (AEUI) that identifies the end user"
    },
    "callerName": {
      "type": "string",
      "description": "The name of the end user for PSAP display"
    },
    "locationId": {
      "type": "string",
      "description": "The ID of the validated location associated with this endpoint"
    },
    "telephoneNumber": {
      "type": "string",
      "description": "The phone number associated with this endpoint"
    },
    "activated": {
      "type": "boolean",
      "description": "Whether the endpoint is currently active"
    }
  }
}