/
REST Objects VoIP Provider
Document toolboxDocument toolbox

REST Objects VoIP Provider

Owned by Andrew Hill (Deactivated)
Last updated: Nov 09, 2023 by Jason AndrewVersion comment

5.0.0

The VoIP Provider object is part of the overall ServiceBroker Configuration object, in the following location:

A VoIP Provider object is used within the context of a REST Objects Providers (itself part of an REST Objects Configuration) to represent the details of how ServiceBroker is to be integrated with a Voice over IP provider for the relevant tenant.  

ServiceBroker currently only supports integration with the Twillio Voice over IP service.    

 


On this page:

Related pages:

VoIP Provider Object Format

Unable to render {include} The included page could not be found.

VoIP Provider Object Properties


PropertyTypeRequired?Description
ProviderstringYesThe VoIP provider to use. Currently only the value Twillio is supported.
AcctIDstringYesThe Twillio sub-account ID to use for the VoIP integration.
AcctAuthTokenstringYesThe Twillio sub-account authentication token.
PhoneNumberstringYesThe phone number that calls/SMS messages will come from/be sent from.

EnableSMSOptOut

booleanYes

Set to true to enable end users to opt out of SMS message updates by responding with a text message.

Default value is false.

OptOutTitle

stringYesThe text message sent to end users as a confirmation message, after they have opted out of SMS message updates.

OptOutStopKeyword

stringYes

The text keyword that should be used to opt out of SMS message updates.

Note that the keyword "STOP" is reserved for use by ServiceBroker to allow end users to opt out of all updates; therefore, a different text keyword must be used, such as "NO".

IVRNumber

stringYesRESERVED for future use.