Get Sip Trunk

GET

https://api.agentphone.ai/v1/sip-trunks/:trunk_id

GET

/v1/sip-trunks/:trunk_id

1 import { AgentPhoneClient } from "agentphone";
2 
3 async function main() {
4     const client = new AgentPhoneClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.sipTrunks.getSipTrunk("trunk_id");
8 }
9 main();

1 {
2   "id": "string",
3   "name": "string",
4   "encrypted": true,
5   "transport": "string",
6   "mediaEncryption": "string",
7   "transfers": "string",
8   "transferCallerId": "string",
9   "terminationSipUri": "string",
10   "createdAt": "string",
11   "originationUris": [
12     {
13       "sip_uri": "string",
14       "name": "",
15       "priority": 10,
16       "weight": 10
17     }
18   ],
19   "allowedIps": [
20     {
21       "cidr": "string",
22       "name": ""
23     }
24   ],
25   "proxyIps": [
26     "string"
27   ],
28   "credentials": [
29     {
30       "username": "string",
31       "password": "string",
32       "passwordLast4": "string",
33       "credentialListName": "string"
34     }
35   ]
36 }

Get a single SIP trunk.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

trunk_idstringRequired

Response

Successful Response

idstring

namestring

encryptedboolean

transportstring

mediaEncryptionstring

transfersstring

transferCallerIdstring

terminationSipUristring

createdAtstring

originationUrislist of objectsOptional

allowedIpslist of objectsOptional

proxyIpslist of stringsOptional

credentialslist of objects or nullOptional

Errors

422

Unprocessable Entity Error