OriginationUrl Resource
The OriginationUrl Resource represents the Origination SIP URL(s) of your Trunk. OriginationUrls identify the network element entry point(s) into your communications infrastructure (e.g. IP-PBX, SBC). See Origination Settings in the SIP Trunking configuration page
for more information.
OriginationUrl properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that created the OriginationUrl resource. |
sid
|
The unique string that we created to identify the OriginationUrl resource. |
trunk_sid
|
The SID of the Trunk that owns the Origination URL. |
weight
|
The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority. |
enabled
|
Whether the URL is enabled. The default is |
sip_url
|
The SIP address you want Twilio to route your Origination calls to. This must be a |
friendly_name
|
The string that you assigned to describe the resource. |
priority
|
The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI. |
date_created
|
The date and time in GMT when the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in RFC 2822 format. |
url
|
The absolute URL of the resource. |
Create an OriginationUrl resource
https://trunking.twilio.com/v1/Trunks/{TrunkSid}/OriginationUrls
Parameters
| Parameters in REST API format | |
|---|---|
trunk_sid
Path
|
The SID of the Trunk to associate the resource with. |
weight
Required
|
The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority. |
priority
Required
|
The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI. |
enabled
Required
|
Whether the URL is enabled. The default is |
friendly_name
Required
|
A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
sip_url
Required
|
The SIP address you want Twilio to route your Origination calls to. This must be a |
Example 1
Fetch an OriginationUrl resource
https://trunking.twilio.com/v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
trunk_sid
Path
|
The SID of the Trunk from which to fetch the OriginationUrl. |
sid
Path
|
The unique string that we created to identify the OriginationUrl resource to fetch. |
Example 1
Read multiple OriginationUrl resources
https://trunking.twilio.com/v1/Trunks/{TrunkSid}/OriginationUrls
Parameters
| Parameters in REST API format | |
|---|---|
trunk_sid
Path
|
The SID of the Trunk from which to read the OriginationUrl. |
Example 1
Update an OriginationUrl resource
https://trunking.twilio.com/v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
trunk_sid
Path
|
The SID of the Trunk from which to update the OriginationUrl. |
sid
Path
|
The unique string that we created to identify the OriginationUrl resource to update. |
weight
Optional
|
The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority. |
priority
Optional
|
The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI. |
enabled
Optional
|
Whether the URL is enabled. The default is |
friendly_name
Optional
|
A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
sip_url
Optional
|
The SIP address you want Twilio to route your Origination calls to. This must be a |
Example 1
Delete an OriginationUrl resource
https://trunking.twilio.com/v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
trunk_sid
Path
|
The SID of the Trunk from which to delete the OriginationUrl. |
sid
Path
|
The unique string that we created to identify the OriginationUrl resource to delete. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
