Read redacted SIP configuration and phone-number projections
GET
cookie
vg_session<token>The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.
orgId*stringAuthorised orgId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthprojectId*stringAuthorised projectId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthAuthorised read result. Null means unreported, never zero. Source-specific coverage limits remain visible.
application/json- response
readAt*stringFormat
date-timesource*stringlivekitNumbers*array<>inbound*array<>outbound*array<>rules*array<>sourceStatus?How fresh a sampled read is. Present when the worker samples the layer; a layer never read successfully answers 503 source_unavailable instead.
Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/sip'Example Response
{ "readAt": "2019-08-24T14:15:22Z", "source": "string", "livekitNumbers": [ { "number": "string", "status": "string", "ruleIds": [ "string" ] } ], "inbound": [ { "id": "string", "numbers": [ "string" ], "allowedNumbers": 0, "allowedAddresses": 0, "auth": true, "krisp": true, "media": { "encryption": "string", "codecs": [ "string" ], "onlyListedCodecs": true, "mediaTimeout": "string" } } ], "outbound": [ { "id": "string", "address": "string", "transport": "string", "numbers": [ "string" ], "destinationCountry": "string", "auth": true, "headerNames": [ "string" ], "media": { "encryption": "string", "codecs": [ "string" ], "onlyListedCodecs": true, "mediaTimeout": "string" } } ], "rules": [ { "id": "string", "type": "string", "prefixSet": true, "pin": true, "trunkIds": [ "string" ], "hidePhoneNumber": true, "inboundNumbers": 0, "agents": 0, "media": { "encryption": "string", "codecs": [ "string" ], "onlyListedCodecs": true, "mediaTimeout": "string" } } ], "sourceStatus": { "lastReadAt": "2019-08-24T14:15:22Z", "lastGoodReadAt": "2019-08-24T14:15:22Z", "errorClass": "unauthenticated" }}Was this page helpful?