Create Trunk Group

Description

Creates a Trunk Group.

Request

HTTP Method: POST

URI Path: /v3/trunk_groups

URI Query Parameters:

Name

Type

Is Required?

Description

include

string

Optional

Inclusion

Request Body Object Attributes:

Name

Type

Nullable

Is Required?

Description

name

string

False

Yes

Unique name of the Trunk Group.

capacity_limit

integer

False

Optional

Maximum number of simultaneous calls for the Trunk Group.

Request Body Object Relationships:

Title

Type

Description

trunks

To many | Linkage for included trunks.

Examples

http

POST /v3/trunk_groups HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "trunk_groups",
    "attributes": {
      "name": "Main group",
      "capacity_limit": 100
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/trunk_groups -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"capacity_limit": 100, "name": "Main group"}, "type": "trunk_groups"}}'

response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "a6370df6-86db-4a1a-9a54-3742f1d8615c",
    "type": "trunk_groups",
    "attributes": {
      "created_at": "2017-06-25T14:56:31.513Z",
      "name": "Main group",
      "capacity_limit": 100
    },
    "relationships": {
      "trunks": {
        "links": {
          "self": "https://api.didww.com/v3/trunk_groups/a6370df6-86db-4a1a-9a54-3742f1d8615c/relationships/trunks",
          "related": "https://api.didww.com/v3/trunk_groups/a6370df6-86db-4a1a-9a54-3742f1d8615c/trunks"
        }
      }
    },
    "meta": {
      "trunks_count": 0
    }
  },
  "meta": {
    "api_version": "2017-09-18"
  }
}

Other Responses

Code

Success

Description

422

No

Unprocessable Entity

401

No

Unauthorized