Get SipTrunk Status
GET /api/v1/sip/trunk/status/{trunk_id}
Operation id: get__api_v1_sip_trunk_status_trunk_id_
Description
Get current status of the SipTrunk
Tags: SipTrunk
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
trunk_id | integer | Yes | id of existing SIP Trunk |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenant_id | string | Yes | tenant id of required records |
Security
- PhoenixToken-Authorization (apiKey)
- PhoenixToken-Authorization
Responses
200 — OK
Content type: application/json
400 — Bad Request
Content type: application/json
404 — Not Found
Content type: application/json
500 — Internal Server Error
Content type: application/json
Response models
200 — OK
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
details | string | No | |
sbc_name | string | No | |
status | integer | No | |
trunk_id | integer | No | |
trunk_name | string | No | |
updated_at | string | No |
{
"type": "object",
"properties": {
"details": {
"type": "string"
},
"sbc_name": {
"type": "string"
},
"status": {
"type": "integer"
},
"trunk_id": {
"type": "integer"
},
"trunk_name": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
400 — Bad Request
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer | No | |
message | string | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0
},
"message": {
"type": "string",
"example": "Success"
}
}
}
404 — Not Found
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer | No | |
message | string | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0
},
"message": {
"type": "string",
"example": "Success"
}
}
}
500 — Internal Server Error
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer | No | |
message | string | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0
},
"message": {
"type": "string",
"example": "Success"
}
}
}