<?php
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
namespace Twilio\Rest\Api\V2010\Account;
use Twilio\Options;
use Twilio\Values;
abstract class IncomingPhoneNumberOptions {
/**
* @param string $accountSid The SID of the Account that created the resource
* to update
* @param string $apiVersion The API version to use for incoming calls made to
* the phone number
* @param string $friendlyName A string to describe the resource
* @param string $smsApplicationSid Unique string that identifies the
* application
* @param string $smsFallbackMethod HTTP method used with sms_fallback_url
* @param string $smsFallbackUrl The URL we call when an error occurs while
* executing TwiML
* @param string $smsMethod The HTTP method to use with sms_url
* @param string $smsUrl The URL we should call when the phone number receives
* an incoming SMS message
* @param string $statusCallback The URL we should call to send status
* information to your application
* @param string $statusCallbackMethod The HTTP method we should use to call
* status_callback
* @param string $voiceApplicationSid The SID of the application to handle the
* phone number
* @param boolean $voiceCallerIdLookup Whether to lookup the caller's name
* @param string $voiceFallbackMethod The HTTP method used with fallback_url
* @param string $voiceFallbackUrl The URL we will call when an error occurs in
* TwiML
* @param string $voiceMethod The HTTP method used with the voice_url
* @param string $voiceUrl The URL we should call when the phone number
* receives a call
* @param string $emergencyStatus Whether the phone number is enabled for
* emergency calling
* @param string $emergencyAddressSid The emergency address configuration to
* use for emergency calling
* @param string $trunkSid SID of the trunk to handle phone calls to the phone
* number
* @param string $voiceReceiveMode Incoming call type: fax or voice
* @param string $identitySid Unique string that identifies the identity
* associated with number
* @param string $addressSid The SID of the Address resource associated with
* the phone number
* @return UpdateIncomingPhoneNumberOptions Options builder
*/
public static function update($accountSid = Values::NONE, $apiVersion = Values::NONE, $friendlyName = Values::NONE, $smsApplicationSid = Values::NONE, $smsFallbackMethod = Values::NONE, $smsFallbackUrl = Values::NONE, $smsMethod = Values::NONE, $smsUrl = Values::NONE, $statusCallback = Values::NONE, $statusCallbackMethod = Values::NONE, $voiceApplicationSid = Values::NONE, $voiceCallerIdLookup = Values::NONE, $voiceFallbackMethod = Values::NONE, $voiceFallbackUrl = Values::NONE, $voiceMethod = Values::NONE, $voiceUrl = Values::NONE, $emergencyStatus = Values::NONE, $emergencyAddressSid = Values::NONE, $trunkSid = Values::NONE, $voiceReceiveMode = Values::NONE, $identitySid = Values::NONE, $addressSid = Values::NONE) {
return new UpdateIncomingPhoneNumberOptions($accountSid, $apiVersion, $friendlyName, $smsApplicationSid, $smsFallbackMethod, $smsFallbackUrl, $smsMethod, $smsUrl, $statusCallback, $statusCallbackMethod, $voiceApplicationSid, $voiceCallerIdLookup, $voiceFallbackMethod, $voiceFallbackUrl, $voiceMethod, $voiceUrl, $emergencyStatus, $emergencyAddressSid, $trunkSid, $voiceReceiveMode, $identitySid, $addressSid);
}
/**
* @param boolean $beta Whether to include new phone numbers
* @param string $friendlyName A string that identifies the IncomingPhoneNumber
* resources to read
* @param string $phoneNumber The phone numbers of the IncomingPhoneNumber
* resources to read
* @param string $origin Include phone numbers based on their origin. By
* default, phone numbers of all origin are included.
* @return ReadIncomingPhoneNumberOptions Options builder
*/
public static function read($beta = Values::NONE, $friendlyName = Values::NONE, $phoneNumber = Values::NONE, $origin = Values::NONE) {
return new ReadIncomingPhoneNumberOptions($beta, $friendlyName, $phoneNumber, $origin);
}
/**
* @param string $phoneNumber The phone number to purchase in E.164 format
* @param string $areaCode The desired area code for the new phone number
* @param string $apiVersion The API version to use for incoming calls made to
* the new phone number
* @param string $friendlyName A string to describe the new phone number
* @param string $smsApplicationSid The SID of the application to handle SMS
* messages
* @param string $smsFallbackMethod HTTP method used with sms_fallback_url
* @param string $smsFallbackUrl The URL we call when an error occurs while
* executing TwiML
* @param string $smsMethod The HTTP method to use with sms url
* @param string $smsUrl The URL we should call when the new phone number
* receives an incoming SMS message
* @param string $statusCallback The URL we should call to send status
* information to your application
* @param string $statusCallbackMethod HTTP method we should use to call
* status_callback
* @param string $voiceApplicationSid The SID of the application to handle the
* new phone number
* @param boolean $voiceCallerIdLookup Whether to lookup the caller's name
* @param string $voiceFallbackMethod The HTTP method used with
* voice_fallback_url
* @param string $voiceFallbackUrl The URL we will call when an error occurs in
* TwiML
* @param string $voiceMethod The HTTP method used with the voice_url
* @param string $voiceUrl The URL we should call when the phone number
* receives a call
* @param string $emergencyStatus Status determining whether the new phone
* number is enabled for emergency calling
* @param string $emergencyAddressSid The emergency address configuration to
* use for emergency calling
* @param string $trunkSid SID of the trunk to handle calls to the new phone
* number
* @param string $identitySid The SID of the Identity resource to associate
* with the new phone number
* @param string $addressSid The SID of the Address resource associated with
* the phone number
* @param string $voiceReceiveMode Incoming call type: fax or voice
* @return CreateIncomingPhoneNumberOptions Options builder
*/
public static function create($phoneNumber = Values::NONE, $areaCode = Values::NONE, $apiVersion = Values::NONE, $friendlyName = Values::NONE, $smsApplicationSid = Values::NONE, $smsFallbackMethod = Values::NONE, $smsFallbackUrl = Values::NONE, $smsMethod = Values::NONE, $smsUrl = Values::NONE, $statusCallback = Values::NONE, $statusCallbackMethod = Values::NONE, $voiceApplicationSid = Values::NONE, $voiceCallerIdLookup = Values::NONE, $voiceFallbackMethod = Values::NONE, $voiceFallbackUrl = Values::NONE, $voiceMethod = Values::NONE, $voiceUrl = Values::NONE, $emergencyStatus = Values::NONE, $emergencyAddressSid = Values::NONE, $trunkSid = Values::NONE, $identitySid = Values::NONE, $addressSid = Values::NONE, $voiceReceiveMode = Values::NONE) {
return new CreateIncomingPhoneNumberOptions($phoneNumber, $areaCode, $apiVersion, $friendlyName, $smsApplicationSid, $smsFallbackMethod, $smsFallbackUrl, $smsMethod, $smsUrl, $statusCallback, $statusCallbackMethod, $voiceApplicationSid, $voiceCallerIdLookup, $voiceFallbackMethod, $voiceFallbackUrl, $voiceMethod, $voiceUrl, $emergencyStatus, $emergencyAddressSid, $trunkSid, $identitySid, $addressSid, $voiceReceiveMode);
}
}
class UpdateIncomingPhoneNumberOptions extends Options {
/**
* @param string $accountSid The SID of the Account that created the resource
* to update
* @param string $apiVersion The API version to use for incoming calls made to
* the phone number
* @param string $friendlyName A string to describe the resource
* @param string $smsApplicationSid Unique string that identifies the
* application
* @param string $smsFallbackMethod HTTP method used with sms_fallback_url
* @param string $smsFallbackUrl The URL we call when an error occurs while
* executing TwiML
* @param string $smsMethod The HTTP method to use with sms_url
* @param string $smsUrl The URL we should call when the phone number receives
* an incoming SMS message
* @param string $statusCallback The URL we should call to send status
* information to your application
* @param string $statusCallbackMethod The HTTP method we should use to call
* status_callback
* @param string $voiceApplicationSid The SID of the application to handle the
* phone number
* @param boolean $voiceCallerIdLookup Whether to lookup the caller's name
* @param string $voiceFallbackMethod The HTTP method used with fallback_url
* @param string $voiceFallbackUrl The URL we will call when an error occurs in
* TwiML
* @param string $voiceMethod The HTTP method used with the voice_url
* @param string $voiceUrl The URL we should call when the phone number
* receives a call
* @param string $emergencyStatus Whether the phone number is enabled for
* emergency calling
* @param string $emergencyAddressSid The emergency address configuration to
* use for emergency calling
* @param string $trunkSid SID of the trunk to handle phone calls to the phone
* number
* @param string $voiceReceiveMode Incoming call type: fax or voice
* @param string $identitySid Unique string that identifies the identity
* associated with number
* @param string $addressSid The SID of the Address resource associated with
* the phone number
*/
public function __construct($accountSid = Values::NONE, $apiVersion = Values::NONE, $friendlyName = Values::NONE, $smsApplicationSid = Values::NONE, $smsFallbackMethod = Values::NONE, $smsFallbackUrl = Values::NONE, $smsMethod = Values::NONE, $smsUrl = Values::NONE, $statusCallback = Values::NONE, $statusCallbackMethod = Values::NONE, $voiceApplicationSid = Values::NONE, $voiceCallerIdLookup = Values::NONE, $voiceFallbackMethod = Values::NONE, $voiceFallbackUrl = Values::NONE, $voiceMethod = Values::NONE, $voiceUrl = Values::NONE, $emergencyStatus = Values::NONE, $emergencyAddressSid = Values::NONE, $trunkSid = Values::NONE, $voiceReceiveMode = Values::NONE, $identitySid = Values::NONE, $addressSid = Values::NONE) {
$this->options['accountSid'] = $accountSid;
$this->options['apiVersion'] = $apiVersion;
$this->options['friendlyName'] = $friendlyName;
$this->options['smsApplicationSid'] = $smsApplicationSid;
$this->options['smsFallbackMethod'] = $smsFallbackMethod;
$this->options['smsFallbackUrl'] = $smsFallbackUrl;
$this->options['smsMethod'] = $smsMethod;
$this->options['smsUrl'] = $smsUrl;
$this->options['statusCallback'] = $statusCallback;
$this->options['statusCallbackMethod'] = $statusCallbackMethod;
$this->options['voiceApplicationSid'] = $voiceApplicationSid;
$this->options['voiceCallerIdLookup'] = $voiceCallerIdLookup;
$this->options['voiceFallbackMethod'] = $voiceFallbackMethod;
$this->options['voiceFallbackUrl'] = $voiceFallbackUrl;
$this->options['voiceMethod'] = $voiceMethod;
$this->options['voiceUrl'] = $voiceUrl;
$this->options['emergencyStatus'] = $emergencyStatus;
$this->options['emergencyAddressSid'] = $emergencyAddressSid;
$this->options['trunkSid'] = $trunkSid;
$this->options['voiceReceiveMode'] = $voiceReceiveMode;
$this->options['identitySid'] = $identitySid;
$this->options['addressSid'] = $addressSid;
}
/**
* The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).
*
* @param string $accountSid The SID of the Account that created the resource
* to update
* @return $this Fluent Builder
*/
public function setAccountSid($accountSid) {
$this->options['accountSid'] = $accountSid;
return $this;
}
/**
* The API version to use for incoming calls made to the phone number. The default is `2010-04-01`.
*
* @param string $apiVersion The API version to use for incoming calls made to
* the phone number
* @return $this Fluent Builder
*/
public function setApiVersion($apiVersion) {
$this->options['apiVersion'] = $apiVersion;
return $this;
}
/**
* A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.
*
* @param string $friendlyName A string to describe the resource
* @return $this Fluent Builder
*/
public function setFriendlyName($friendlyName) {
$this->options['friendlyName'] = $friendlyName;
return $this;
}
/**
* The SID of the application that should handle SMS messages sent to the number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.
*
* @param string $smsApplicationSid Unique string that identifies the
* application
* @return $this Fluent Builder
*/
public function setSmsApplicationSid($smsApplicationSid) {
$this->options['smsApplicationSid'] = $smsApplicationSid;
return $this;
}
/**
* The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $smsFallbackMethod HTTP method used with sms_fallback_url
* @return $this Fluent Builder
*/
public function setSmsFallbackMethod($smsFallbackMethod) {
$this->options['smsFallbackMethod'] = $smsFallbackMethod;
return $this;
}
/**
* The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.
*
* @param string $smsFallbackUrl The URL we call when an error occurs while
* executing TwiML
* @return $this Fluent Builder
*/
public function setSmsFallbackUrl($smsFallbackUrl) {
$this->options['smsFallbackUrl'] = $smsFallbackUrl;
return $this;
}
/**
* The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $smsMethod The HTTP method to use with sms_url
* @return $this Fluent Builder
*/
public function setSmsMethod($smsMethod) {
$this->options['smsMethod'] = $smsMethod;
return $this;
}
/**
* The URL we should call when the phone number receives an incoming SMS message.
*
* @param string $smsUrl The URL we should call when the phone number receives
* an incoming SMS message
* @return $this Fluent Builder
*/
public function setSmsUrl($smsUrl) {
$this->options['smsUrl'] = $smsUrl;
return $this;
}
/**
* The URL we should call using the `status_callback_method` to send status information to your application.
*
* @param string $statusCallback The URL we should call to send status
* information to your application
* @return $this Fluent Builder
*/
public function setStatusCallback($statusCallback) {
$this->options['statusCallback'] = $statusCallback;
return $this;
}
/**
* The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $statusCallbackMethod The HTTP method we should use to call
* status_callback
* @return $this Fluent Builder
*/
public function setStatusCallbackMethod($statusCallbackMethod) {
$this->options['statusCallbackMethod'] = $statusCallbackMethod;
return $this;
}
/**
* The SID of the application we should use to handle phone calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
*
* @param string $voiceApplicationSid The SID of the application to handle the
* phone number
* @return $this Fluent Builder
*/
public function setVoiceApplicationSid($voiceApplicationSid) {
$this->options['voiceApplicationSid'] = $voiceApplicationSid;
return $this;
}
/**
* Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.
*
* @param boolean $voiceCallerIdLookup Whether to lookup the caller's name
* @return $this Fluent Builder
*/
public function setVoiceCallerIdLookup($voiceCallerIdLookup) {
$this->options['voiceCallerIdLookup'] = $voiceCallerIdLookup;
return $this;
}
/**
* The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $voiceFallbackMethod The HTTP method used with fallback_url
* @return $this Fluent Builder
*/
public function setVoiceFallbackMethod($voiceFallbackMethod) {
$this->options['voiceFallbackMethod'] = $voiceFallbackMethod;
return $this;
}
/**
* The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
*
* @param string $voiceFallbackUrl The URL we will call when an error occurs in
* TwiML
* @return $this Fluent Builder
*/
public function setVoiceFallbackUrl($voiceFallbackUrl) {
$this->options['voiceFallbackUrl'] = $voiceFallbackUrl;
return $this;
}
/**
* The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $voiceMethod The HTTP method used with the voice_url
* @return $this Fluent Builder
*/
public function setVoiceMethod($voiceMethod) {
$this->options['voiceMethod'] = $voiceMethod;
return $this;
}
/**
* The URL that we should call to answer a call to the phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.
*
* @param string $voiceUrl The URL we should call when the phone number
* receives a call
* @return $this Fluent Builder
*/
public function setVoiceUrl($voiceUrl) {
$this->options['voiceUrl'] = $voiceUrl;
return $this;
}
/**
* The configuration status parameter that determines whether the phone number is enabled for emergency calling.
*
* @param string $emergencyStatus Whether the phone number is enabled for
* emergency calling
* @return $this Fluent Builder
*/
public function setEmergencyStatus($emergencyStatus) {
$this->options['emergencyStatus'] = $emergencyStatus;
return $this;
}
/**
* The SID of the emergency address configuration to use for emergency calling from this phone number.
*
* @param string $emergencyAddressSid The emergency address configuration to
* use for emergency calling
* @return $this Fluent Builder
*/
public function setEmergencyAddressSid($emergencyAddressSid) {
$this->options['emergencyAddressSid'] = $emergencyAddressSid;
return $this;
}
/**
* The SID of the Trunk we should use to handle phone calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
*
* @param string $trunkSid SID of the trunk to handle phone calls to the phone
* number
* @return $this Fluent Builder
*/
public function setTrunkSid($trunkSid) {
$this->options['trunkSid'] = $trunkSid;
return $this;
}
/**
* The configuration parameter for the phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.
*
* @param string $voiceReceiveMode Incoming call type: fax or voice
* @return $this Fluent Builder
*/
public function setVoiceReceiveMode($voiceReceiveMode) {
$this->options['voiceReceiveMode'] = $voiceReceiveMode;
return $this;
}
/**
* The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations.
*
* @param string $identitySid Unique string that identifies the identity
* associated with number
* @return $this Fluent Builder
*/
public function setIdentitySid($identitySid) {
$this->options['identitySid'] = $identitySid;
return $this;
}
/**
* The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations.
*
* @param string $addressSid The SID of the Address resource associated with
* the phone number
* @return $this Fluent Builder
*/
public function setAddressSid($addressSid) {
$this->options['addressSid'] = $addressSid;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString() {
$options = array();
foreach ($this->options as $key => $value) {
if ($value != Values::NONE) {
$options[] = "$key=$value";
}
}
return '[Twilio.Api.V2010.UpdateIncomingPhoneNumberOptions ' . implode(' ', $options) . ']';
}
}
class ReadIncomingPhoneNumberOptions extends Options {
/**
* @param boolean $beta Whether to include new phone numbers
* @param string $friendlyName A string that identifies the IncomingPhoneNumber
* resources to read
* @param string $phoneNumber The phone numbers of the IncomingPhoneNumber
* resources to read
* @param string $origin Include phone numbers based on their origin. By
* default, phone numbers of all origin are included.
*/
public function __construct($beta = Values::NONE, $friendlyName = Values::NONE, $phoneNumber = Values::NONE, $origin = Values::NONE) {
$this->options['beta'] = $beta;
$this->options['friendlyName'] = $friendlyName;
$this->options['phoneNumber'] = $phoneNumber;
$this->options['origin'] = $origin;
}
/**
* Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
*
* @param boolean $beta Whether to include new phone numbers
* @return $this Fluent Builder
*/
public function setBeta($beta) {
$this->options['beta'] = $beta;
return $this;
}
/**
* A string that identifies the IncomingPhoneNumber resources to read.
*
* @param string $friendlyName A string that identifies the IncomingPhoneNumber
* resources to read
* @return $this Fluent Builder
*/
public function setFriendlyName($friendlyName) {
$this->options['friendlyName'] = $friendlyName;
return $this;
}
/**
* The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
*
* @param string $phoneNumber The phone numbers of the IncomingPhoneNumber
* resources to read
* @return $this Fluent Builder
*/
public function setPhoneNumber($phoneNumber) {
$this->options['phoneNumber'] = $phoneNumber;
return $this;
}
/**
* Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
*
* @param string $origin Include phone numbers based on their origin. By
* default, phone numbers of all origin are included.
* @return $this Fluent Builder
*/
public function setOrigin($origin) {
$this->options['origin'] = $origin;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString() {
$options = array();
foreach ($this->options as $key => $value) {
if ($value != Values::NONE) {
$options[] = "$key=$value";
}
}
return '[Twilio.Api.V2010.ReadIncomingPhoneNumberOptions ' . implode(' ', $options) . ']';
}
}
class CreateIncomingPhoneNumberOptions extends Options {
/**
* @param string $phoneNumber The phone number to purchase in E.164 format
* @param string $areaCode The desired area code for the new phone number
* @param string $apiVersion The API version to use for incoming calls made to
* the new phone number
* @param string $friendlyName A string to describe the new phone number
* @param string $smsApplicationSid The SID of the application to handle SMS
* messages
* @param string $smsFallbackMethod HTTP method used with sms_fallback_url
* @param string $smsFallbackUrl The URL we call when an error occurs while
* executing TwiML
* @param string $smsMethod The HTTP method to use with sms url
* @param string $smsUrl The URL we should call when the new phone number
* receives an incoming SMS message
* @param string $statusCallback The URL we should call to send status
* information to your application
* @param string $statusCallbackMethod HTTP method we should use to call
* status_callback
* @param string $voiceApplicationSid The SID of the application to handle the
* new phone number
* @param boolean $voiceCallerIdLookup Whether to lookup the caller's name
* @param string $voiceFallbackMethod The HTTP method used with
* voice_fallback_url
* @param string $voiceFallbackUrl The URL we will call when an error occurs in
* TwiML
* @param string $voiceMethod The HTTP method used with the voice_url
* @param string $voiceUrl The URL we should call when the phone number
* receives a call
* @param string $emergencyStatus Status determining whether the new phone
* number is enabled for emergency calling
* @param string $emergencyAddressSid The emergency address configuration to
* use for emergency calling
* @param string $trunkSid SID of the trunk to handle calls to the new phone
* number
* @param string $identitySid The SID of the Identity resource to associate
* with the new phone number
* @param string $addressSid The SID of the Address resource associated with
* the phone number
* @param string $voiceReceiveMode Incoming call type: fax or voice
*/
public function __construct($phoneNumber = Values::NONE, $areaCode = Values::NONE, $apiVersion = Values::NONE, $friendlyName = Values::NONE, $smsApplicationSid = Values::NONE, $smsFallbackMethod = Values::NONE, $smsFallbackUrl = Values::NONE, $smsMethod = Values::NONE, $smsUrl = Values::NONE, $statusCallback = Values::NONE, $statusCallbackMethod = Values::NONE, $voiceApplicationSid = Values::NONE, $voiceCallerIdLookup = Values::NONE, $voiceFallbackMethod = Values::NONE, $voiceFallbackUrl = Values::NONE, $voiceMethod = Values::NONE, $voiceUrl = Values::NONE, $emergencyStatus = Values::NONE, $emergencyAddressSid = Values::NONE, $trunkSid = Values::NONE, $identitySid = Values::NONE, $addressSid = Values::NONE, $voiceReceiveMode = Values::NONE) {
$this->options['phoneNumber'] = $phoneNumber;
$this->options['areaCode'] = $areaCode;
$this->options['apiVersion'] = $apiVersion;
$this->options['friendlyName'] = $friendlyName;
$this->options['smsApplicationSid'] = $smsApplicationSid;
$this->options['smsFallbackMethod'] = $smsFallbackMethod;
$this->options['smsFallbackUrl'] = $smsFallbackUrl;
$this->options['smsMethod'] = $smsMethod;
$this->options['smsUrl'] = $smsUrl;
$this->options['statusCallback'] = $statusCallback;
$this->options['statusCallbackMethod'] = $statusCallbackMethod;
$this->options['voiceApplicationSid'] = $voiceApplicationSid;
$this->options['voiceCallerIdLookup'] = $voiceCallerIdLookup;
$this->options['voiceFallbackMethod'] = $voiceFallbackMethod;
$this->options['voiceFallbackUrl'] = $voiceFallbackUrl;
$this->options['voiceMethod'] = $voiceMethod;
$this->options['voiceUrl'] = $voiceUrl;
$this->options['emergencyStatus'] = $emergencyStatus;
$this->options['emergencyAddressSid'] = $emergencyAddressSid;
$this->options['trunkSid'] = $trunkSid;
$this->options['identitySid'] = $identitySid;
$this->options['addressSid'] = $addressSid;
$this->options['voiceReceiveMode'] = $voiceReceiveMode;
}
/**
* The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
*
* @param string $phoneNumber The phone number to purchase in E.164 format
* @return $this Fluent Builder
*/
public function setPhoneNumber($phoneNumber) {
$this->options['phoneNumber'] = $phoneNumber;
return $this;
}
/**
* The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only).
*
* @param string $areaCode The desired area code for the new phone number
* @return $this Fluent Builder
*/
public function setAreaCode($areaCode) {
$this->options['areaCode'] = $areaCode;
return $this;
}
/**
* The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.
*
* @param string $apiVersion The API version to use for incoming calls made to
* the new phone number
* @return $this Fluent Builder
*/
public function setApiVersion($apiVersion) {
$this->options['apiVersion'] = $apiVersion;
return $this;
}
/**
* A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number.
*
* @param string $friendlyName A string to describe the new phone number
* @return $this Fluent Builder
*/
public function setFriendlyName($friendlyName) {
$this->options['friendlyName'] = $friendlyName;
return $this;
}
/**
* The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.
*
* @param string $smsApplicationSid The SID of the application to handle SMS
* messages
* @return $this Fluent Builder
*/
public function setSmsApplicationSid($smsApplicationSid) {
$this->options['smsApplicationSid'] = $smsApplicationSid;
return $this;
}
/**
* The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $smsFallbackMethod HTTP method used with sms_fallback_url
* @return $this Fluent Builder
*/
public function setSmsFallbackMethod($smsFallbackMethod) {
$this->options['smsFallbackMethod'] = $smsFallbackMethod;
return $this;
}
/**
* The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.
*
* @param string $smsFallbackUrl The URL we call when an error occurs while
* executing TwiML
* @return $this Fluent Builder
*/
public function setSmsFallbackUrl($smsFallbackUrl) {
$this->options['smsFallbackUrl'] = $smsFallbackUrl;
return $this;
}
/**
* The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $smsMethod The HTTP method to use with sms url
* @return $this Fluent Builder
*/
public function setSmsMethod($smsMethod) {
$this->options['smsMethod'] = $smsMethod;
return $this;
}
/**
* The URL we should call when the new phone number receives an incoming SMS message.
*
* @param string $smsUrl The URL we should call when the new phone number
* receives an incoming SMS message
* @return $this Fluent Builder
*/
public function setSmsUrl($smsUrl) {
$this->options['smsUrl'] = $smsUrl;
return $this;
}
/**
* The URL we should call using the `status_callback_method` to send status information to your application.
*
* @param string $statusCallback The URL we should call to send status
* information to your application
* @return $this Fluent Builder
*/
public function setStatusCallback($statusCallback) {
$this->options['statusCallback'] = $statusCallback;
return $this;
}
/**
* The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $statusCallbackMethod HTTP method we should use to call
* status_callback
* @return $this Fluent Builder
*/
public function setStatusCallbackMethod($statusCallbackMethod) {
$this->options['statusCallbackMethod'] = $statusCallbackMethod;
return $this;
}
/**
* The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
*
* @param string $voiceApplicationSid The SID of the application to handle the
* new phone number
* @return $this Fluent Builder
*/
public function setVoiceApplicationSid($voiceApplicationSid) {
$this->options['voiceApplicationSid'] = $voiceApplicationSid;
return $this;
}
/**
* Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.
*
* @param boolean $voiceCallerIdLookup Whether to lookup the caller's name
* @return $this Fluent Builder
*/
public function setVoiceCallerIdLookup($voiceCallerIdLookup) {
$this->options['voiceCallerIdLookup'] = $voiceCallerIdLookup;
return $this;
}
/**
* The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $voiceFallbackMethod The HTTP method used with
* voice_fallback_url
* @return $this Fluent Builder
*/
public function setVoiceFallbackMethod($voiceFallbackMethod) {
$this->options['voiceFallbackMethod'] = $voiceFallbackMethod;
return $this;
}
/**
* The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
*
* @param string $voiceFallbackUrl The URL we will call when an error occurs in
* TwiML
* @return $this Fluent Builder
*/
public function setVoiceFallbackUrl($voiceFallbackUrl) {
$this->options['voiceFallbackUrl'] = $voiceFallbackUrl;
return $this;
}
/**
* The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
*
* @param string $voiceMethod The HTTP method used with the voice_url
* @return $this Fluent Builder
*/
public function setVoiceMethod($voiceMethod) {
$this->options['voiceMethod'] = $voiceMethod;
return $this;
}
/**
* The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.
*
* @param string $voiceUrl The URL we should call when the phone number
* receives a call
* @return $this Fluent Builder
*/
public function setVoiceUrl($voiceUrl) {
$this->options['voiceUrl'] = $voiceUrl;
return $this;
}
/**
* The configuration status parameter that determines whether the new phone number is enabled for emergency calling.
*
* @param string $emergencyStatus Status determining whether the new phone
* number is enabled for emergency calling
* @return $this Fluent Builder
*/
public function setEmergencyStatus($emergencyStatus) {
$this->options['emergencyStatus'] = $emergencyStatus;
return $this;
}
/**
* The SID of the emergency address configuration to use for emergency calling from the new phone number.
*
* @param string $emergencyAddressSid The emergency address configuration to
* use for emergency calling
* @return $this Fluent Builder
*/
public function setEmergencyAddressSid($emergencyAddressSid) {
$this->options['emergencyAddressSid'] = $emergencyAddressSid;
return $this;
}
/**
* The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
*
* @param string $trunkSid SID of the trunk to handle calls to the new phone
* number
* @return $this Fluent Builder
*/
public function setTrunkSid($trunkSid) {
$this->options['trunkSid'] = $trunkSid;
return $this;
}
/**
* The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.
*
* @param string $identitySid The SID of the Identity resource to associate
* with the new phone number
* @return $this Fluent Builder
*/
public function setIdentitySid($identitySid) {
$this->options['identitySid'] = $identitySid;
return $this;
}
/**
* The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
*
* @param string $addressSid The SID of the Address resource associated with
* the phone number
* @return $this Fluent Builder
*/
public function setAddressSid($addressSid) {
$this->options['addressSid'] = $addressSid;
return $this;
}
/**
* The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.
*
* @param string $voiceReceiveMode Incoming call type: fax or voice
* @return $this Fluent Builder
*/
public function setVoiceReceiveMode($voiceReceiveMode) {
$this->options['voiceReceiveMode'] = $voiceReceiveMode;
return $this;
}
/**
* Provide a friendly representation
*
* @return string Machine friendly representation
*/
public function __toString() {
$options = array();
foreach ($this->options as $key => $value) {
if ($value != Values::NONE) {
$options[] = "$key=$value";
}
}
return '[Twilio.Api.V2010.CreateIncomingPhoneNumberOptions ' . implode(' ', $options) . ']';
}
}