List connection policy target

GET /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets

Network element entry points into your communications infrastructure

Path parameters

  • ConnectionPolicySid string Required

    The SID of the Connection Policy from which to read the Targets.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^NY[0-9a-fA-F]{32}$.

Query parameters

  • PageSize integer(int64)

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • targets array[object]
      Hide targets attributes Show targets attributes object
      • account_sid string | null

        The SID of the Account that created the Target resource.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • connection_policy_sid string | null

        The SID of the Connection Policy that owns the Target.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^NY[0-9a-fA-F]{32}$.

      • sid string | null

        The unique string that we created to identify the Target resource.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^NE[0-9a-fA-F]{32}$.

      • friendly_name string | null

        The string that you assigned to describe the resource.

      • target string(uri) | null

        The SIP address you want Twilio to route your calls to. This must be a sip: schema. sips is NOT supported.

      • priority integer

        The relative importance of the target. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important target.

        Default value is 0.

      • weight integer

        The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. Targets with higher values receive more load than those with lower ones with the same priority.

        Default value is 0.

      • enabled boolean | null

        Whether the target is enabled. The default is true.

      • date_created string(date-time) | null

        The date and time in GMT when the resource was created specified in RFC 2822 format.

      • date_updated string(date-time) | null

        The date and time in GMT when the resource was last updated specified in RFC 2822 format.

      • url string(uri) | null

        The absolute URL of the resource.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets
curl \
 --request GET 'https://voice.twilio.com/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "targets",
    "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "targets": [
    {
      "sid": "NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets/NEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "target": "sip:sip-box.com:1234",
      "weight": 20,
      "enabled": true,
      "priority": 1,
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2020-03-18T23:31:36Z",
      "date_updated": "2020-03-18T23:31:37Z",
      "friendly_name": "friendly_name",
      "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}
{
  "meta": {
    "key": "targets",
    "url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://voice.twilio.com/v1/ConnectionPolicies/NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Targets?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "targets": []
}