Vobiz Logo
Vobiz
|API Documentation
Console

List All Incoming Carriers

This API lists all incoming carriers registered with your account.

API Endpoint
GEThttps://api.vobiz.ai/api/v1/Account/{auth_id}/IncomingCarrier/

Arguments

Request Parameters

NameTypeDescription
name
stringAllows filtering by name. The filter term can be either the exact name of the carrier or a phrase contained within the name of the carrier (includes the "starts with" filter).
limit
integerDenotes the number of results to display per page. The maximum number of results that can be fetched is 20.
offset
integerDenotes the number of value items by which the results should be offset.

Response Example

HTTP Status Code: 200
{
  "api_id": "correlation-id-uuid",
  "meta": {
    "limit": 20,
    "offset": 0,
    "total_count": 5
  },
  "objects": [
    {
      "carrier_id": "a1b2c3d4e5f6g7",
      "name": "Primary Carrier",
      "ip_set": "203.0.113.10,203.0.113.11",
      "voice": true,
      "sms": false,
      "resource_uri": "/v1/Account/{Auth_ID}/IncomingCarrier/a1b2c3d4e5f6g7/"
    },
    {
      "carrier_id": "h8i9j0k1l2m3n4",
      "name": "Backup Carrier",
      "ip_set": "198.51.100.20,198.51.100.21",
      "voice": true,
      "sms": false,
      "resource_uri": "/v1/Account/{Auth_ID}/IncomingCarrier/h8i9j0k1l2m3n4/"
    }
  ]
}

Examples

cURL - List All Incoming Carriers

cURL Request
curl -X GET https://api.vobiz.ai/api/v1/Account/{Auth_ID}/IncomingCarrier/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"
Retrieve an Incoming Carrier
Update an Incoming Carrier