lucee.Componenttwilio-sdk.TwilioClient
Interact with the Twilio API
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
accountSID
The configured account SID.
|
true
|
false
|
|
any
|
hyperClient
A configured HyperBuilder client to use with the Twilio API.
|
true
|
false
|
Method Summary | |
---|---|
string
|
getAccountSID()
|
string
|
getHyperClient()
|
any
|
lookup([any phoneNumber], [any withCallerName='false'], [any addons='[runtime expression]'])
Look up information about a phone number. |
any
|
newRequest()
|
any
|
onMissingMethod([any missingMethodName], [any missingMethodArguments])
|
any
|
setAccountSID(any accountSID)
|
any
|
setHyperClient(any hyperClient)
|
any
|
sms([any to], [any from], [any body])
Send an sms message. |
Methods inherited from class lucee.Component |
---|
None |
Property Detail |
---|
The configured account SID. This can be overridden for subaccounts.
access
- publicrequired
- falsereturntype
- anyinject
- coldbox:setting:accountSID@twilio-sdkserializable
- trueA configured HyperBuilder client to use with the Twilio API. This is handled for you when using as a ColdBox module.
access
- publicrequired
- falsereturntype
- anyinject
- TwilioHyperClient@twilio-sdkserializable
- trueMethod Detail |
---|
Look up information about a phone number. (This costs extra.) Default: false. | in the response. (This may cost extra.)
phoneNumber
- The phone number to look up. |withCallerName
- Should caller information be included in the response.addons
- An optional array of addons to process and includemissingMethodName
missingMethodArguments
accountSID
hyperClient
Send an sms message. This must be a valid Twilio number.
to
- The phone number the sms is going to.from
- The phone number the sms is from.body
- The body of the sms message.