Create connection policy target

POST /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets

Network element entry points into your communications infrastructure

Path parameters

Body

  • Enabled boolean

    Whether the Target is enabled. The default is true.

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

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

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

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the 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}$.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • enabled boolean | null

      Whether the target is enabled

    • friendly_name string | null

      The string that you assigned to describe the resource

    • priority integer | null

      The relative importance of the target

    • sid string | null

      The unique string that identifies the resource

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

    • target string(uri) | null

      The SIP address you want Twilio to route your calls to

    • url string(uri) | null

      The absolute URL of the resource

    • weight integer | null

      The value that determines the relative load the Target should receive compared to others with the same priority
POST /v1/ConnectionPolicies/{ConnectionPolicySid}/Targets 
curl \
 -X POST https://voice.twilio.com/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Enabled=true&FriendlyName=string&Priority=42&Target=https%3A%2F%2Fexample.com&Weight=42'
Request example 
{
  "Enabled": true,
  "FriendlyName": "string",
  "Priority": 42,
  "Target": "https://example.com",
  "Weight": 42
}
Request examples 
{
  "Enabled": true,
  "FriendlyName": "string",
  "Priority": 42,
  "Target": "https://example.com",
  "Weight": 42
}
Response examples (201) 
{
  "account_sid": "string",
  "connection_policy_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "enabled": true,
  "friendly_name": "string",
  "priority": 42,
  "sid": "string",
  "target": "https://example.com",
  "url": "https://example.com",
  "weight": 42
}
Response examples (201) 
{
  "account_sid": "string",
  "connection_policy_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "enabled": true,
  "friendly_name": "string",
  "priority": 42,
  "sid": "string",
  "target": "https://example.com",
  "url": "https://example.com",
  "weight": 42
}