Class: ByocTrunkInstance

Twilio.Voice.V1.ByocTrunkInstance(version, payload, sid)

new ByocTrunkInstance(version, payload, sid)

Initialize the ByocTrunkContext
Parameters:
Name Type Description
version V1 Version of the resource
payload ByocTrunkPayload The instance payload
sid sid The unique string that identifies the resource
Properties:
Name Type Description
accountSid string The SID of the Account that created the resource
sid string The unique string that identifies the resource
friendlyName string The string that you assigned to describe the resource
voiceUrl string The URL we call when receiving a call
voiceMethod string The HTTP method to use with voice_url
voiceFallbackUrl string The URL we call when an error occurs while executing TwiML
voiceFallbackMethod string The HTTP method used with voice_fallback_url
statusCallbackUrl string The URL that we call with status updates
statusCallbackMethod string The HTTP method we use to call status_callback_url
cnamLookupEnabled boolean Whether Caller ID Name (CNAM) lookup is enabled for the trunk
connectionPolicySid string Origination Connection Policy (to your Carrier)
fromDomainSid string The SID of the SIP Domain that should be used in the `From` header of originating calls
dateCreated Date The RFC 2822 date and time in GMT that the resource was created
dateUpdated Date The RFC 2822 date and time in GMT that the resource was last updated
url string The absolute URL of the resource
Source:

Methods

fetch(callbackopt) → {Promise}

fetch a ByocTrunkInstance
Parameters:
Name Type Attributes Description
callback function <optional>
Callback to handle processed record
Source:
Returns:
Resolves to processed ByocTrunkInstance
Type
Promise

remove(callbackopt) → {Promise}

remove a ByocTrunkInstance
Parameters:
Name Type Attributes Description
callback function <optional>
Callback to handle processed record
Source:
Returns:
Resolves to processed ByocTrunkInstance
Type
Promise

toJSON()

Provide a user-friendly representation
Source:
Returns:
Object

update(optsopt, callbackopt) → {Promise}

update a ByocTrunkInstance
Parameters:
Name Type Attributes Description
opts object <optional>
Options for request
Properties
Name Type Attributes Description
friendlyName string <optional>
A string to describe the resource
voiceUrl string <optional>
The URL we should call when receiving a call
voiceMethod string <optional>
The HTTP method we should use with voice_url
voiceFallbackUrl string <optional>
The URL we should call when an error occurs in executing TwiML
voiceFallbackMethod string <optional>
The HTTP method used with voice_fallback_url
statusCallbackUrl string <optional>
The URL that we should call to pass status updates
statusCallbackMethod string <optional>
The HTTP method we should use to call status_callback_url
cnamLookupEnabled boolean <optional>
Whether Caller ID Name (CNAM) lookup is enabled for the trunk
connectionPolicySid string <optional>
Origination Connection Policy (to your Carrier)
fromDomainSid string <optional>
The SID of the SIP Domain that should be used in the `From` header of originating calls
callback function <optional>
Callback to handle processed record
Source:
Returns:
Resolves to processed ByocTrunkInstance
Type
Promise