Raw schema
{
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 160,
"description": "Supplier name"
},
"sipHost": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"description": "SIP host IP/hostname (voice termination)"
},
"sipPort": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 65535
},
{
"type": "null"
}
],
"description": "SIP port"
},
"transport": {
"anyOf": [
{
"type": "string",
"enum": [
"udp",
"tcp",
"tls"
]
},
{
"type": "null"
}
],
"description": "Transport; defaults udp"
},
"techPrefix": {
"anyOf": [
{
"type": "string",
"maxLength": 24
},
{
"type": "null"
}
],
"description": "Tech prefix (digits/*/# only)"
},
"sipAuthUsername": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
],
"description": "SIP auth username"
},
"sipAuthPassword": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
],
"description": "SIP auth password"
},
"supportedCodecs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"maxLength": 24
},
"maxItems": 16
},
{
"type": "null"
}
],
"description": "Codec list"
},
"defaultRatePerUnit": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"description": "Default cost rate per unit in USD (per minute for voice, per message for SMS)"
},
"billingIncrement": {
"anyOf": [
{
"type": "string",
"maxLength": 10
},
{
"type": "null"
}
],
"description": "Billing increment in seconds as \"initial/subsequent\", e.g. 60/60"
},
"currency": {
"anyOf": [
{
"type": "string",
"minLength": 3,
"maxLength": 3
},
{
"type": "null"
}
],
"description": "ISO 4217 currency code (default USD)"
},
"capacity": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"description": "Channel capacity (concurrent calls)"
},
"maxCps": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
],
"description": "Max calls per second"
},
"status": {
"type": "string",
"enum": [
"active",
"disabled",
"draft",
"testing",
"draining",
"fault"
],
"description": "Trunk status"
},
"settlementMode": {
"type": "string",
"enum": [
"ap",
"prepaid"
],
"description": "AP payable or prepaid wallet draw"
},
"balance": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"description": "Prepaid credit remaining, in USD"
},
"portalEmail": {
"anyOf": [
{
"type": "string",
"format": "email",
"maxLength": 255
},
{
"type": "null"
}
],
"description": "Supplier portal login email"
},
"smsDeliveryMethod": {
"anyOf": [
{
"type": "string",
"enum": [
"http",
"smpp"
]
},
{
"type": "null"
}
],
"description": "SMS termination: http (smsDeliveryUrl) or smpp (bind to the SMSC below)"
},
"smsDeliveryUrl": {
"anyOf": [
{
"type": "string",
"format": "uri",
"maxLength": 500
},
{
"type": "null"
}
],
"description": "HTTP SMS delivery URL"
},
"smppHost": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"description": "SMPP SMSC host"
},
"smppPort": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 65535
},
{
"type": "null"
}
],
"description": "SMPP port"
},
"smppSystemId": {
"anyOf": [
{
"type": "string",
"maxLength": 16
},
{
"type": "null"
}
],
"description": "SMPP system_id (max 16)"
},
"smppPassword": {
"type": [
"string",
"null"
],
"description": "SMPP password (stored sealed, never returned)"
},
"smppBindType": {
"anyOf": [
{
"type": "string",
"enum": [
"transceiver",
"transmitter"
]
},
{
"type": "null"
}
],
"description": "SMPP bind type"
},
"smppTps": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 1000
},
{
"type": "null"
}
],
"description": "SMPP throughput cap, messages per second"
}
},
"required": [
"label"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}