Voice Channel

List SIP Trunk

SIP Trunk

The SIP Trunk API in the Integrari system allows you to manage SIP trunk configurations, enabling seamless connectivity for voice communication. This API facilitates operations such as creating, listing, editing, and deleting SIP trunks. With these functionalities, you can efficiently integrate SIP trunk capabilities within their applications.

Servers

https://api.integrari.com/

List SIP Trunk

Request

Retrieve a list of all configured SIP trunks.

Query

idstring

endPointIpstring

endPointIp

namestring

TrunkName

statusstring

Status

Headers

accountIdstring

Account Id of the customer

curl -i -X GET \
  'https://api.integrari.com/o/sip-trunk/v1.0/list?endPointIp=string&id=string&name=string&status=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'accountId: string'

Responses

A List of SIP Trunks

Body

dataArray of objects

messagestring

Example: "The request has succeeded"

totalinteger

Example: 1

Response

{
  "data": [
    {
      "allowOutgoingCalls": "Yes",
      "capacity": "100",
      "cps": "100",
      "createdBy": "449542034",
      "createdOn": "2024-09-23 18:31:05",
      "groupId": "310",
      "groupName": "Test Group",
      "modifiedBy": "449542115",
      "modifiedOn": "2024-09-23 19:02:08",
      "outBoundTransparent": "Transparent",
      "routingPolicy": "Priority",
      "status": "active",
      "sipTrunk": [
        {
          "endPointIp": "10.30.0.58",
          "id": "293",
          "isDefault": "true",
          "name": "SIP_Trunk_1",
          "portNumber": "9080",
          "status": "active"
        }
      ]
    }
  ],
  "message": "The request has succeeded",
  "total": 1
}

Add SIP Trunk

Request

Create a new SIP trunk.

Headers

accountIdstring

Account Id of the customer

Body

SIPTrunk Add Request

namestring

TrunkName

typeinteger

TrunkType

userNamestring

UserName

dialingPrefixinteger

DialingPrefix

endPointIpstring

EndPointIp

portNumberinteger

PortNumber

statusstring

Status

isDefaultboolean

IsDefault

curl -i -X POST \
  https://api.integrari.com/o/sip-trunk/v1.0/add \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'accountId: string' \
  -d '{
    "name": "string",
    "type": 0,
    "userName": "string",
    "dialingPrefix": 0,
    "endPointIp": "string",
    "portNumber": 0,
    "status": "string",
    "isDefault": true
  }'

Responses

Body

messagestring

Example: "The request has succeeded"

Response

{
  "message": "The request has succeeded"
}

Update SIP Trunk

Request

Modify an existing SIP trunk.

Headers

accountIdstring

Account Id of the customer

Body

SIPTrunk Edit Request

idstring

SIPTrunkId

capacityinteger

Capacity

dialingPrefixinteger

DialingPrefix

endPointIpstring

EndPointIp

portNumberinteger

PortNumber

statusstring

Status

isDefaultboolean

IsDefault

curl -i -X PATCH \
  https://api.integrari.com/o/sip-trunk/v1.0/edit \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'accountId: string' \
  -d '{
    "id": "string",
    "capacity": 0,
    "dialingPrefix": 0,
    "endPointIp": "string",
    "portNumber": 0,
    "status": "string",
    "isDefault": true
  }'

Responses

Body

messagestring

Example: "The request has succeeded"

Response

{
  "message": "The request has succeeded"
}

Delete SIP Trunk

Request

Remove a SIP trunk from your configuration.

Query

idinteger

Headers

accountIdstring

Account Id of the customer

curl -i -X DELETE \
  'https://api.integrari.com/o/sip-trunk/v1.0/delete?id=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'accountId: string'

Responses

Body

messagestring

Example: "The request has succeeded"

Response

{
  "message": "The request has succeeded"
}