sip trunk

API Docs by APIMATIC

SIP Trunk

Fields

NameDescription
id Required
Number

Unique ID of SIP trunk of the platform.

name Required
String

System-generated login name of the SIP trunk

callerid Required
String

Caller ID configured on the SIP trunk, if any

label Required
String

User-defined name of the SIP trunk

charge Required
Decimal

Total price of all outbound calls placed via the trunk in the current month

talk_time Required
Number

Total talk time of all outbound calls placed via the trunk in the current month, in seconds

auth_method Required
String

Authentication method set for the SIP trunk. Can be either Digest for registration-based SIP trunks or IP auth for SIP trunks using IP-based authentication.

passthrough Required
Boolean

Indicates if Caller ID passthrough feature is active for the SIP trunk

status Required
String

Indicates if the SIP trunk can be used to place outbound calls. Can be either active or pending. Outbound calls are allowed via SIP trunks with active status only.

host_request Required

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

passthrough_request Required

Status of the Caller ID passthrough request for with the SIP trunk.

{
  "id": 1,
  "name": "67758",
  "callerid": "12345678900",
  "label": "My SIP trunk",
  "charge": 87.26,
  "talk_time": 63627,
  "auth_method": "Digest",
  "passthrough": false,
  "status": "active",
  "host_request": {
    "host": "127.0.0.1",
    "status": "pending"
  },
  "passthrough_request": null
}