The IncomingCarrier Object
The IncomingCarrier object represents a carrier configuration for routing incoming calls through Vobiz from your own phone numbers.
Attributes
IncomingCarrier Attributes
| Name | Type | Description |
|---|---|---|
carrier_id | string | Unique 14-character identifier for the incoming carrier. Auto-generated by Vobiz when the carrier is created. |
name | string | Carrier name (max 255 characters). Can contain alphanumeric characters, hyphens, and underscores. |
ip_set | string | Comma-separated list of IPv4 addresses from which SIP traffic will be accepted. Used for IP-based authentication. |
voice | boolean | Enable voice traffic (default: true). Controls whether the carrier can handle voice calls. |
sms | boolean | Enable SMS traffic (must be false - SMS carriers not supported in current version). |
resource_uri | string | API endpoint path for this specific carrier resource. |
Example IncomingCarrier Object
JSON
{
"carrier_id": "a1b2c3d4e5f6g7",
"name": "My Primary Carrier",
"ip_set": "203.0.113.10,203.0.113.11,203.0.113.12",
"voice": true,
"sms": false,
"resource_uri": "/v1/Account/{Auth_ID}/IncomingCarrier/a1b2c3d4e5f6g7/"
}