> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.jambonz.org/reference/rest-platform-management/carriers/get-voip-carrier/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.jambonz.org/_mcp/server.

# retrieve voip carrier

GET https://api.jambonz.cloud/v1/VoipCarriers/{VoipCarrierSid}

Reference: https://docs.jambonz.org/reference/rest-platform-management/carriers/get-voip-carrier

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `VoipCarrierSid` (string, required)

## Response

### 200

voip carrier found

- `service_provider_sid` (string, required)
- `name` (string, required)
- `description` (string, optional)
- `account_sid` (string, optional)
- `application_sid` (string, optional)
- `e164_leading_plus` (boolean, optional)
- `requires_register` (boolean, optional)
- `register_username` (string, optional)
- `register_sip_realm` (string, optional)
- `register_password` (string, optional)
- `tech_prefix` (string, optional)
- `diversion` (string, optional)
- `is_active` (boolean, optional)
- `smpp_system_id` (string, optional)
- `smpp_password` (string, optional)
- `smpp_inbound_system_id` (string, optional)
- `smpp_inbound_password` (string, optional)
- `smpp_enquire_link_interval` (integer, optional)
- `trunk_type` (enum, optional, default: static_ip) — The type of trunk to create, see the [guide](/guides/using-the-jambonz-portal/basic-concepts/creating-carriers) for details
  - Allowed values: `static_ip`, `auth`, `reg`
- `inbound_auth_username` (string, optional) — username for an auth trunk
- `inbound_auth_password` (string, optional) — password for an auth trunk

## Errors

### 404 Not Found Error

voip carrier not found

- `any`

### 500 Internal Server Error

system error

- `msg` (string, required)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "service_provider_sid": "6072f617-6151-4c15-8eb9-74a4967ab701",
  "name": "Acme VoIP Carrier",
  "description": "Primary SIP carrier for North America region",
  "account_sid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "application_sid": "123e4567-e89b-12d3-a456-426614174000",
  "e164_leading_plus": true,
  "requires_register": true,
  "register_username": "acme_user",
  "register_sip_realm": "sip.acmevoip.com",
  "register_password": "securePass!2024",
  "tech_prefix": "99",
  "diversion": "true",
  "is_active": true,
  "smpp_system_id": "acme_smpp",
  "smpp_password": "smppPass123",
  "smpp_inbound_system_id": "acme_inbound",
  "smpp_inbound_password": "inboundPass456",
  "smpp_enquire_link_interval": 30,
  "trunk_type": "static_ip",
  "inbound_auth_username": "inboundUser",
  "inbound_auth_password": "inboundSecret"
}
```

**SDK Code**

```python
import requests

url = "https://api.jambonz.cloud/v1/VoipCarriers/VoipCarrierSid"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.jambonz.cloud/v1/VoipCarriers/VoipCarrierSid';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jambonz.cloud/v1/VoipCarriers/VoipCarrierSid"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.jambonz.cloud/v1/VoipCarriers/VoipCarrierSid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.jambonz.cloud/v1/VoipCarriers/VoipCarrierSid")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.jambonz.cloud/v1/VoipCarriers/VoipCarrierSid', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.jambonz.cloud/v1/VoipCarriers/VoipCarrierSid");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.jambonz.cloud/v1/VoipCarriers/VoipCarrierSid")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```