Qodex.ai

Get Voice OUT Trunks

GET https://{{host}}/v3/voice_out_trunks

Returns a single Voice Out trunk owned by the account.

Request Params

KeyDatatypeRequiredDescription
includenullComma-separated values of include parameter.
The response will include a top-level object relationships with associated data under the appropriate resource key.
Details in Inclusion of Related Resources Article.

Allowed values:

dids - list of DID Object *** | | filter[name] | null | | string - Filters by trunk name field.

  • Allow blank - Yes.
  • Allow array - Yes. | | filter[name_contains] | null | | string - Filters by trunk name_contains field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[on_cli_mismatch_action] | null | | string - Filters by trunk on_cli_mismatch_action field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[allow_any_did_as_cli] | null | | boolean - Filters by trunk allow_any_did_as_cli field.
  • Allow blank - No.
  • Allow array - No. | | filter[status] | null | | string - Filters by trunk status field.
  • Allow blank - No.
  • Allow array - No. | | filter[threshold_reached] | null | | boolean - Filters by trunk threshold_reached field.
  • Allow blank - No.
  • Allow array - No. | | filter[default_dst_action] | null | | string - Filters by trunk default_dst_action field.
  • Allow blank - No.
  • Allow array - No. | | filter[media_encryption_mode] | null | | string - Filters by trunk media_encryption_mode field.
  • Allow blank - No.
  • Allow array - No. | | sort | null | | Used for sorting the fields returned by the request, with a comma , separating the included fields. Details in Sorting Article.

name - The name field.

created_at - The created_at field.

allow_any_did_as_cli - The allow_any_did_as_cli field.

threshold_reached - The threshold_reached field. *** |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"data":[{"id":"457bf47d-446d-41cd-91c3-dfbda7bf0753","type":"voice_out_trunks","attributes":{"allowed_sip_ips":["0.0.0.0/0"],"allowed_rtp_ips":["0.0.0.0/0"],"allow_any_did_as_cli":true,"status":"active","on_cli_mismatch_action":"reject_call","name":"Outbound trunk 1","capacity_limit":100,"username":"****ff1onm","password":"****b4m55h","created_at":"2021-12-15T18:59:28.875Z","threshold_reached":false,"threshold_amount":"10000.0","media_encryption_mode":"disabled","default_dst_action":"allow_all","dst_prefixes":[],"force_symmetric_rtp":false,"rtp_ping":false,"callback_url":null},"relationships":{"dids":{"links":{"self":"https://api.didww.com/v3/voice_out_trunks/457bf47d-446d-41cd-91c3-dfbda7bf0753/relationships/dids","related":"https://api.didww.com/v3/voice_out_trunks/457bf47d-446d-41cd-91c3-dfbda7bf0753/dids"}}},"meta":{"spent_amount":"0.0"}},{"id":"d471975a-c6ee-4f84-80f0-fad67c5e22b1","type":"voice_out_trunks","attributes":{"allowed_sip_ips":["192.168.1.1/32"],"allowed_rtp_ips":["192.168.1.1/32"],"allow_any_did_as_cli":false,"status":"active","on_cli_mismatch_action":"send_original_cli","name":"Outbound trunk 11","capacity_limit":100,"username":"****rh5vb","password":"****kmgnda","created_at":"2021-12-02T07:17:40.125Z","threshold_reached":false,"threshold_amount":"9999.0","media_encryption_mode":"disabled","default_dst_action":"allow_all","dst_prefixes":["23"],"force_symmetric_rtp":false,"rtp_ping":false,"callback_url":null},"relationships":{"dids":{"links":{"self":"https://api.didww.com/v3/voice_out_trunks/d471975a-c6ee-4f84-80f0-fad67c5e22b1/relationships/dids","related":"https://api.didww.com/v3/voice_out_trunks/d471975a-c6ee-4f84-80f0-fad67c5e22b1/dids"}}},"meta":{"spent_amount":"0.0"}}],"meta":{"total_records":2,"api_version":"2021-12-15"},"links":{"first":"https://api.didww.com/v3/voice_out_trunks?page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/voice_out_trunks?page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}