Create connection policy target

POST /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets

Network element entry points into your communications infrastructure

Path parameters

  • ConnectionPolicySid string Required

    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}$.

application/x-www-form-urlencoded

Body

  • Target string(uri) Required

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

  • FriendlyName string

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

  • 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.

  • 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.

  • Enabled boolean

    Whether the Target is enabled. The default is true.

Responses

  • 201 application/json

    Created

    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
    • 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.

POST /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets
curl \
 --request POST 'https://voice.twilio.com/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Target=sip%3Asip-box.com%3A1234&Weight=20&Enabled=true&Priority=1&FriendlyName=friendly_name'
Request example
{"Target"=>"sip:sip-box.com:1234", "Weight"=>20, "Enabled"=>true, "Priority"=>1, "FriendlyName"=>"friendly_name"}
Response examples (201)
{
  "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:36Z",
  "friendly_name": "friendly_name",
  "connection_policy_sid": "NYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}