SIP trunks

Check a SIP trunk

Asterisk’s own qualify result and a live network probe, reported side by side rather than reduced to one boolean, because where they disagree IS the diagnosis. A provider that ignores unauthenticated OPTIONS shows probe.reachable: false while Asterisk reports it healthy — that is normal and Asterisk is right. A provider whose account has been suspended shows healthy on both, which is what recent_failures is for: a failure_code of 21 on a reachable trunk almost always means the carrier account is suspended, closed or out of balance.

GET

sip-trunks

{id}

status

Check a SIP trunk

curl --request GET \
  --url https://api.voice.wixzel.com/v1/sip-trunks/{id}/status \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.voice.wixzel.com/v1/sip-trunks/{id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voice.wixzel.com/v1/sip-trunks/{id}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.voice.wixzel.com/v1/sip-trunks/{id}/status"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.voice.wixzel.com/v1/sip-trunks/{id}/status")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "object": "sip_trunk_status",
  "sip_trunk_id": "6a96a3ead6e886d42462dd3e",
  "name": "<string>",
  "host": "<string>",
  "port": 123,
  "transport": "<string>",
  "origination_uri": "sip:95.216.218.102:5090",
  "asterisk": {
    "connected": true,
    "endpoint_known": true,
    "endpoint_state": "<string>",
    "reachable": true,
    "round_trip_ms": 123,
    "detail": "<string>"
  },
  "probe": {
    "reachable": true,
    "method": "<string>",
    "detail": "<string>"
  },
  "recent_failures": [
    {
      "call_id": "<string>",
      "failure_code": 123,
      "failure_reason": "<string>",
      "at": "<string>"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Path Parameters

string

required

Pattern: ^[0-9a-f]{24}$

Example:

"6a96a3ead6e886d42462dd3e"

Response

Current state of the trunk

object

enum<string>

required

Available options:

sip_trunk_status

sip_trunk_id

string

required

Pattern: ^[0-9a-f]{24}$

Example:

"6a96a3ead6e886d42462dd3e"

name

string | null

required

host

string | null

required

port

integer | null

required

transport

string | null

required

origination_uri

string | null

required

Where the carrier must send inbound calls. Repeated here because a number that never rings is half of "why is this not working", and unlike everything else in this response it is not a state we can measure — if it is missing from the carrier's Origination URI field the call never reaches us and nothing on this side is aware of it.

Example:

"sip:95.216.218.102:5090"

asterisk

object

required

Show child attributes

probe

object

required

Show child attributes

recent_failures

object[]

required

The last few carrier rejections on this account, newest first. A reachable trunk that rejects every call is usually a suspended or unfunded carrier account — cause 21.

Show child attributes

⌘I

Check a SIP trunk

curl --request GET \
  --url https://api.voice.wixzel.com/v1/sip-trunks/{id}/status \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.voice.wixzel.com/v1/sip-trunks/{id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voice.wixzel.com/v1/sip-trunks/{id}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.voice.wixzel.com/v1/sip-trunks/{id}/status"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.voice.wixzel.com/v1/sip-trunks/{id}/status")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "object": "sip_trunk_status",
  "sip_trunk_id": "6a96a3ead6e886d42462dd3e",
  "name": "<string>",
  "host": "<string>",
  "port": 123,
  "transport": "<string>",
  "origination_uri": "sip:95.216.218.102:5090",
  "asterisk": {
    "connected": true,
    "endpoint_known": true,
    "endpoint_state": "<string>",
    "reachable": true,
    "round_trip_ms": 123,
    "detail": "<string>"
  },
  "probe": {
    "reachable": true,
    "method": "<string>",
    "detail": "<string>"
  },
  "recent_failures": [
    {
      "call_id": "<string>",
      "failure_code": 123,
      "failure_reason": "<string>",
      "at": "<string>"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

Getting started

Guides

Concepts

API reference

Check a SIP trunk

Authorizations

Path Parameters

Response