[Index]

Model: device/spark/Trunks

Model Details: device/spark/Trunks

Title Description Details
id ID of the trunk.
  • Field Name: id
  • Type: String
Name A unique name for the trunk.
  • Field Name: name
  • Type: String
Location Name
  • Field Name: locationName
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • Format: uri
Location ID A location id for the trunk.
  • Field Name: locationId
  • Type: String
Password A unique password for the trunk. This field is for setting or resetting a password used on a trunk.
  • Field Name: password
  • Type: String
  • Is Password: True
Associated Organization An array of organization information.
  • Field Name: organization
  • Type: Object
Name Org Name
  • Field Name: organization.name
  • Type: String
ID The ID of the org.
  • Field Name: organization.id
  • Type: String
Associated Customer Customer associated with the trunk..
  • Field Name: customer
  • Type: Object
Customer Name Name of the customer/organization.
  • Field Name: customer.name
  • Type: String
Customer ID ID of the customer/organization
  • Field Name: customer.id
  • Type: String
Associated Location Location associated with the trunk.
  • Field Name: location
  • Type: Object
Location Name A unique name for the location.
  • Field Name: location.name
  • Type: String
Location ID Unique identifier for the location.
  • Field Name: location.id
  • Type: String
Outgoing and Destination Trunk Group Unique Outgoing and Destination trunk group associated with the dial plan.
  • Field Name: otgDtgId
  • Type: String
Line Port The Line/Port identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode.
  • Field Name: linePort
  • Type: String
Locations Using Trunk Locations using trunk.
  • Field Name: locationsUsingTrunk.[n]
  • Type: Array
Location Name A unique name for the location.
  • Field Name: locationsUsingTrunk.[n].name
  • Type: String
Location ID Unique identifier for the location.
  • Field Name: locationsUsingTrunk.[n].id
  • Type: String
Pilot User Id User ID.
  • Field Name: pilotUserId
  • Type: String
Outbound Proxy Contains the body of the HTTP response received following the request to Console API and will not be set if the response has no body.
  • Field Name: outboundProxy
  • Type: Object
SIP Access Service Type SIP Access Service Type.
  • Field Name: outboundProxy.sipAccessServiceType
  • Type: String
DNS Type DNS Type.
  • Field Name: outboundProxy.dnsType
  • Type: String
Outbound Proxy Outbound Proxy HTTP.
  • Field Name: outboundProxy.outboundProxy
  • Type: String
Srv Prefix Srv Prefix.
  • Field Name: outboundProxy.srvPrefix
  • Type: String
CName Records CName Records.
  • Field Name: outboundProxy.cnameRecords
  • Type: String
Attachment Updated Attachment Updated.
  • Field Name: outboundProxy.attachmentUpdated
  • Type: Boolean
SIP Authentication User Name User's authentication service information.
  • Field Name: sipAuthenticationUserName
  • Type: String
Status Device status.
  • Field Name: status
  • Type: String
Error Codes
  • Field Name: errorCodes.[n]
  • Type: Array
Response Status Present partial error/warning status information included when the http response is 206.
  • Field Name: responseStatus.[n]
  • Type: Array
Code Response Status Code.
  • Field Name: responseStatus.[n].code
  • Type: String
Type Status type.
  • Field Name: responseStatus.[n].type
  • Type: String
Summary English Error summary in English.
  • Field Name: responseStatus.[n].summaryEnglish
  • Type: String
Tracking Id Error Tracking ID.
  • Field Name: responseStatus.[n].trackingId
  • Type: String
Dual Identity Support Enabled Determines the behavior of the From and PAI headers on outbound calls.
  • Field Name: dualIdentitySupportEnabled
  • Type: Boolean
In Use In Use
  • Field Name: inUse
  • Type: Boolean
Trunk Type Trunk Type associated with the trunk.
  • Field Name: trunkType
  • Type: String
Device Type Device type assosiated with trunk.
  • Field Name: deviceType
  • Type: String
Address FQDN or SRV address. Required to create a static certificate-based trunk.
  • Field Name: address
  • Type: String
Domain Domain name. Required to create a static certificate based trunk.
  • Field Name: domain
  • Type: String
Port FQDN port. Required to create a static certificate-based trunk.
  • Field Name: port
  • Type: String
Max Concurrent Calls Max Concurrent call. Required to create a static certificate based trunk
  • Field Name: maxConcurrentCalls
  • Type: String
Is Restricted To Dedicated Instance Is Restricted To Dedicated Instance
  • Field Name: isRestrictedToDedicatedInstance
  • Type: Boolean