Webex · Schema
GetLocationCallBackNumberObject
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| locationInfo | object | Data relevant to this location. |
| locationMemberInfo | object | Data relevant to the user/place/virtual line/hunt group (member) selected for ECBN. |
| selected | object | Selected number type to configure emergency call back. |
| elinExpiryTimeMinutes | integer | ELIN (Emergency Location Identification Number) provides location-specific callback information to emergency responders. This field indicates the time in minutes that the ELIN association remains acti |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetLocationCallBackNumberObject",
"title": "GetLocationCallBackNumberObject",
"type": "object",
"required": [
"locationInfo",
"locationMemberInfo",
"selected",
"elinExpiryTimeMinutes"
],
"properties": {
"locationInfo": {
"type": "object",
"required": [
"effectiveValue",
"quality"
],
"properties": {
"phoneNumber": {
"type": "string",
"example": "+12145551767",
"description": "The location DN."
},
"name": {
"type": "string",
"example": "CPAPI_Dev_Test_Location_DND",
"description": "The name of the location."
},
"effectiveLevel": {
"$ref": "#/components/schemas/CallBackEffectiveLevel",
"description": "The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary."
},
"effectiveValue": {
"type": "string",
"example": "+12145551767",
"description": "Location calling line ID (CLID) number. Avaliable only when number is present and quality would be invalid."
},
"quality": {
"$ref": "#/components/schemas/CallBackQuality",
"description": "Used to represent whether a number is a recommended ECBN."
}
},
"description": "Data relevant to this location."
},
"locationMemberInfo": {
"type": "object",
"required": [
"effectiveValue",
"quality"
],
"properties": {
"phoneNumber": {
"type": "string",
"example": "+12145551767",
"description": "The member DN."
},
"firstName": {
"type": "string",
"example": "Jim",
"description": "The member first name."
},
"lastName": {
"type": "string",
"example": "Grey",
"description": "The member last name. Always contains `.` if the member is a place."
},
"memberId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MmQ3YTY3MS00YmVlLTQ2MDItOGVkOC1jOTFmNjU5NjcxZGI",
"description": "Member ID of user/place/virtual line/hunt group within the location."
},
"memberType": {
"$ref": "#/components/schemas/CallBackMemberType",
"description": "Member Type."
},
"effectiveLevel": {
"$ref": "#/components/schemas/CallBackEffectiveLevel",
"description": "The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary."
},
"effectiveValue": {
"type": "string",
"example": "+12145551767",
"description": "Location CLID number. Avaliable only when number is present and quality would be invalid."
},
"quality": {
"$ref": "#/components/schemas/CallBackQuality",
"description": "Used to represent whether a number is a recommended ECBN."
}
},
"description": "Data relevant to the user/place/virtual line/hunt group (member) selected for ECBN."
},
"selected": {
"$ref": "#/components/schemas/CallBackSelected",
"description": "Selected number type to configure emergency call back."
},
"elinExpiryTimeMinutes": {
"type": "integer",
"example": 120,
"description": "ELIN (Emergency Location Identification Number) provides location-specific callback information to emergency responders. This field indicates the time in minutes that the ELIN association remains active after being established. The default value is 60 minutes, and the valid values range from 10 to 1440 minutes."
}
}
}