Update H323 Trunk

PATCH https://{{host}}/v3/trunks/:id

Request Body Scheme

{

data (object, required) {

id (string, required)
Unique ID identifier of Trunk.

type (string, required): trunks
Trunks

attributes (object, required) {
Trunk configuration complex object.

priority (integer, required)
The priority of this target host. DIDWW will attempt to contact the target trunk with the lowest-numbered priority; target trunk with the same priority will be tried in an order defined by the weight field. The range is 0-65535. See RFC 2782 for more details.

weight (integer, required)
A trunk selection mechanism. The weight field specifies a relative weight for entries with the same priority. Larger weights will be given a proportionately higher probability of being selected. The range of this number is 0-65535. In the presence of records containing weights greater than 0, records with weight 0 will have a very small chance of being selected. See RFC 2782 for more details.

capacity_limit (integer, required)
Maximum number of simultaneous calls for the trunk.

ringing_timeout (integer, required)
After which it will be end transaction with internal disconnect code Ringing timeout if the call was not connected.

name (string, required)
Friendly name of the trunk.

cli_format (string, required): RAW, E164, Local
RAW - Do not alter CLI (default).
E164 - Attempt to convert CLI to E.164 format.
Local - Attempt to convert CLI to Localized format.

CLI format conversion may not work correctly for phone calls originating from outside the country of that specific DID.

cli_prefix (string, required)
You may prefix the CLI with an optional + sign followed by up to 6 characters, including digits and #.

description (string, optional)
Optional description of the trunk.

configuration (object, required) {
Trunk configuration complex object.

type (string, required): h323_configurations
H323 configuration complex object.

attributes (object, required) {
H323 configuration attributes object.

dst (string, optional, NOT nullable)
Phone number’s.

host (string, optional, NOT nullable)
Destination server.

port (string, optional, nullable)
Destination port.

codec_ids (array[integer], optional, NOT nullable)
Codecs

}

}

}

relationships (object, optional) {

pop (object, optional): to-one
Linkage for included POP Object

trunk_group (object, optional): to-one
Linkage for included Trunk Group Object

}

}

}

Request Body Example

{
  "data": {
    "id": "57a939dd-1600-41a6-80b1-f624e22a1f4c",
    "type": "trunks",
    "attributes": {
      "name": "Office H323",
      "capacity_limit": 18,
      "cli_format": "e164",
      "cli_prefix": "+1",
      "configuration": {
        "type": "h323_configurations",
        "attributes": {
          "dst": "1xxxxxxxxx",
          "host": "example.com",
          "codec_ids": [
            9,
            6
          ]
        }
      }
    }
  }
}

HEADERS

RESPONSES

status: OK

{"data":{"id":"389deacb-5be5-46d7-8cbd-aba11f66d6c2","type":"trunks","attributes":{"priority":1,"capacity_limit":18,"weight":65535,"name":"Office H323 API","cli_format":"e164","cli_prefix":"+1","description":null,"ringing_timeout":null,"created_at":"2017-06-25T08:21:41.795Z","configuration":{"type":"h323_configurations","attributes":{"dst":"7xxxxxxxx","host":"example.com","port":null,"codec_ids":[9,6]}}},"relationships":{"trunk_group":{"links":{"self":"https://api.didww.com/v3/trunks/389deacb-5be5-46d7-8cbd-aba11f66d6c2/relationships/trunk_group","related":"https://api.didww.com/v3/trunks/389deacb-5be5-46d7-8cbd-aba11f66d6c2/trunk_group"}},"pop":{"links":{"self":"https://api.didww.com/v3/trunks/389deacb-5be5-46d7-8cbd-aba11f66d6c2/relationships/pop","related":"https://api.didww.com/v3/trunks/389deacb-5be5-46d7-8cbd-aba11f66d6c2/pop"}}}},"meta":{"api_version":"2017-09-18"}}