List SIP trunks on the account

curl --request GET \
  --url 'https://api.wavix.com/v1/trunks?appid='

{
  "sip_trunks": [
    {
      "id": 3107,
      "label": "My trunk",
      "name": "32882",
      "auth_method": "IP auth",
      "callerid": "14302287001",
      "host_request": {
        "host": "127.0.0.1",
        "status": "pending"
      },
      "encrypted_media": false,
      "passthrough": "false,",
      "multiple_numbers": true,
      "status": "pending",
      "charge": 24.637,
      "talk_time": 65,
      "machine_detection_enabled": true,
      "call_recording_enabled": true,
      "transcription_enabled": true,
      "transcription_threshold": 6
    }
  ],
  "pagination": {
    "current_page": 1,
    "total": 1,
    "per_page": 25,
    "total_pages": 1
  }
}

GET

trunks

curl --request GET \
  --url 'https://api.wavix.com/v1/trunks?appid='

{
  "sip_trunks": [
    {
      "id": 3107,
      "label": "My trunk",
      "name": "32882",
      "auth_method": "IP auth",
      "callerid": "14302287001",
      "host_request": {
        "host": "127.0.0.1",
        "status": "pending"
      },
      "encrypted_media": false,
      "passthrough": "false,",
      "multiple_numbers": true,
      "status": "pending",
      "charge": 24.637,
      "talk_time": 65,
      "machine_detection_enabled": true,
      "call_recording_enabled": true,
      "transcription_enabled": true,
      "transcription_threshold": 6
    }
  ],
  "pagination": {
    "current_page": 1,
    "total": 1,
    "per_page": 25,
    "total_pages": 1
  }
}

Authorizations

appid

string

query

required

An API key to authorize your request

Query Parameters

page

integer<int32>

Requested page

per_page

integer<int32>

Number of records per page

Response

sip_trunks

SIPTrunkShort · object[] | null

required

A list of SIP trunks associated with your account

Show child attributes

sip_trunks.id

integer<int32>

required

Unique identifier of the SIP trunk on the platform

Example:

293

sip_trunks.name

string

required

System-generated login name of the SIP trunk

Example:

"67758"

sip_trunks.callerid

string

required

Caller ID associated with the SIP trunk. Contains an empty string if multiple Caller IDs are allowed.

Example:

"12345678900"

sip_trunks.label

string

required

User-defined name of the SIP trunk

Example:

"My trunk"

sip_trunks.auth_method

string

required

SIP trunk authentication method. Can be either Digest or IP auth.

sip_trunks.host_request

string | null

required

For SIP trunks with IP-based authentication, contains the status of the IP authentication request.

sip_trunks.multiple_numbers

boolean

required

Indicates whether multiple Caller IDs are enabled for the SIP trunk

Example:

false

sip_trunks.status

string

required

Status of the SIP trunk. Possible values are: active - The SIP trunk is active and can be used to place outbound calls. pending - The IP authentication request is under review by the Wavix team. rejected - The IP authentication request was rejected by the Wavix team. SIP trunks with a pending or rejected status can't be used to place calls.

sip_trunks.talk_time

integer<int32>

required

Total duration of all outbound calls placed through the SIP trunk the current month, in seconds. Automatically resets at the beginning of each month.

Example:

65

sip_trunks.charge

string

required

Total cost of all outbound calls placed through the SIP trunk in the current month, in USD. Automatically resets at the beginning of each month.

Example:

"24.637"

sip_trunks.passthrough

boolean

Indicates whether Caller ID passthrough is enabled for the SIP trunk

Example:

false

sip_trunks.call_recording_enabled

boolean

default:false

Indicates whether outbound call recording is enabled for the SIP trunk

sip_trunks.machine_detection_enabled

boolean

default:false

Indicates whether automatic voicemail detection is enabled for the SIP trunk. Available for Flex Pro customers only.

sip_trunks.transcription_enabled

boolean

default:false

Indicates whether automatic call transcription is enabled for the SIP trunk. Available for Flex Pro customers only.

sip_trunks.transcription_threshold

integer<int32>

default:6

Minimum call duration (in seconds) required to automatically generate a transcription. Transcriptions are created for calls that meet or exceed this value. Available to Flex Pro customers only.

sip_trunks.encrypted_media

boolean

Indicates whether media enecryption (SRTP) is enabled for the SIP trunk

Example:

true

pagination

Pagination · object

required

Show child attributes

pagination.current_page

integer<int32>

required

Current page number

Example:

2

pagination.per_page

integer<int32>

required

Number of records per page

Example:

25

pagination.total

integer<int32>

required

Total number of records

Example:

101

pagination.total_pages

integer<int32>

required

Total number of pages

Example:

5

Get your API key

Create a new SIP trunk

Using the APIs

API reference

List SIP trunks on the account

Authorizations

Query Parameters

Response