Create an Incoming Carrier

This API lets you add a new incoming carrier to your Vobiz account.

API Endpoint

POSThttps://api.vobiz.ai/api/v1/Account/{auth_id}/IncomingCarrier/

Arguments

Request Parameters

Name	Type	Description
`name`Required	string	Carrier name (max 255 characters). Allowed: Alphabets (upper and lower case), Numbers (0-9), hyphens (-), and underscores (_).
`ip_set`Required	string	Comma-separated list of IPv4 addresses from which SIP traffic will be accepted. Must be valid IPv4 format (e.g., 203.0.113.10). Do not include CIDR notation or port numbers.
`voice`	boolean	Enable voice traffic (default: true).
`sms`	boolean	Must be false. SMS carriers are not currently supported.

Note: IP addresses are added to OpenSIPS IP whitelist in real-time upon carrier creation.

Request Body

JSON

{
  "name": "My SIP Carrier",
  "ip_set": "203.0.113.10,203.0.113.11,203.0.113.12",
  "voice": true,
  "sms": false
}

Examples

cURL - Create Incoming Carrier

cURL Request

curl -X POST https://api.vobiz.ai/api/v1/Account/{Auth_ID}/IncomingCarrier/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My SIP Carrier",
    "ip_set": "203.0.113.10,203.0.113.11,203.0.113.12",
    "voice": true,
    "sms": false
  }'

Response Example

HTTP Status Code: 201

{
  "api_id": "correlation-id-uuid",
  "carrier_id": "a1b2c3d4e5f6g7"
}

Response Fields

api_id: Correlation ID for tracking the request
carrier_id: Unique 14-character identifier for the created carrier

The IncomingCarrier Object

Retrieve an Incoming Carrier