Update an Incoming Carrier
This API lets you modify an existing incoming carrier set up on your account.
API Endpoint
POST
https://api.vobiz.ai/api/v1/Account/{auth_id}/IncomingCarrier/{carrier_id}/Arguments
Request Parameters
| Name | Type | Description |
|---|---|---|
name | string | Carrier name (max 255 characters). Allowed: Alphabets (upper and lower case), Numbers (0-9), hyphens (-), and underscores (_). |
ip_set | string | Comma-separated list of IPv4 addresses. Must be valid IPv4 format without CIDR notation or port numbers. IP whitelist is updated in OpenSIPS in real-time. |
Restrictions
- Cannot enable SMS (sms: true) - SMS carriers not supported
- IP addresses must be valid IPv4 format
- Name must not exceed 255 characters
- Partial update supported - only send fields you want to change
Request Body
JSON (Partial Update Supported)
{
"name": "Updated Carrier Name",
"ip_set": "203.0.113.10,203.0.113.20,203.0.113.30"
}Examples
cURL - Update Incoming Carrier
cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{Auth_ID}/IncomingCarrier/a1b2c3d4e5f6g7/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Carrier Name",
"ip_set": "203.0.113.10,203.0.113.20,203.0.113.30"
}'Response Example
HTTP Status Code: 202
{
"api_id": "correlation-id-uuid",
"message": "changed"
}Response Notes
- HTTP 202 Accepted: Update was successful
- message: Always returns "changed" on success
- OpenSIPS: IP whitelist updated in real-time