Get Voice IN Trunk Group

Description

Returns a single Voice IN Trunk Group.

Request

HTTP Method: GET

URI Path: /v3/voice_in_trunk_groups/

URI Query Parameters:

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the Trunk Group.

includes

string

Optional

Inclusion.

Includes:

Value

Description

trunks

List of Trunk Objects

Examples

http

GET /v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664 -H 'Accept: application/vnd.api+json' -H 'Api-Key: [API token]' -H 'Content-Type: application/vnd.api+json'

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "418fe352-04b8-4e03-a7ce-cb57efd8c664",
    "type": "voice_in_trunk_groups",
    "links": {
      "self": "https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664"
    },
    "attributes": {
      "created_at": "2017-06-25T14:56:31.513Z",
      "name": "Common Group",
      "capacity_limit": 69
    },
    "relationships": {
      "voice_in_trunks": {
        "links": {
          "self": "https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/relationships/voice_in_trunks",
          "related": "https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/voice_in_trunks"
        }
      }
    },
    "meta": {
      "trunks_count": 1
    }
  }
}

http

GET /v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae?include=voice_in_trunks HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i 'https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae?include=voice_in_trunks' -H 'Accept: application/vnd.api+json' -H 'Api-Key: [API token]' -H 'Content-Type: application/vnd.api+json'

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "465b059a-b4a2-4c8e-ab3b-33dc60e096ae",
    "type": "voice_in_trunk_groups",
    "links": {
      "self": "https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae"
    },
    "attributes": {
      "created_at": "2017-06-25T14:56:31.513Z",
      "name": "Common Group",
      "capacity_limit": 69
    },
    "relationships": {
      "voice_in_trunks": {
        "links": {
          "self": "https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/relationships/voice_in_trunks",
          "related": "https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/voice_in_trunks"
        },
        "data": [
          {
            "type": "voice_in_trunks",
            "id": "87133f4d-4a88-436b-b74b-b63e79318426"
          }
        ]
      }
    },
    "meta": {
      "trunks_count": 1
    }
  },
  "included": [
    {
      "id": "87133f4d-4a88-436b-b74b-b63e79318426",
      "type": "voice_in_trunks",
      "attributes": {
        "priority": 1,
        "capacity_limit": 5,
        "weight": 65535,
        "name": "Office Mobile",
        "cli_format": "e164",
        "cli_prefix": null,
        "description": null,
        "ringing_timeout": null,
        "configuration": {
          "type": "pstn_configurations",
          "attributes": {
            "dst": "1xxxxxxxxx"
          }
        }
      },
      "relationships": {
        "voice_in_trunk_group": {
          "links": {
            "self": "https://api.didww.com/v3/voice_in_trunks/87133f4d-4a88-436b-b74b-b63e79318426/relationships/voice_in_trunk_group",
            "related": "https://api.didww.com/v3/voice_in_trunks/87133f4d-4a88-436b-b74b-b63e79318426/voice_in_trunk_group"
          }
        }
      }
    }
  ]
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized