Oracle® Communications Service Broker Social Voice Communicator Implementation Guide Release 6.1 Part Number E29461-01 |
|
|
PDF · Mobi · ePub |
This chapter explains how to provision and manage Oracle Communications Service Broker Social Voice Communicator (SVC) subscriber services data.
You use the SVC RESTful API to create, provision, configure, and manage the SVC services that you offer to your subscribers.
You typically create a self-administered web portal (or add to an existing portal) that you subscribers use to self-administer their accounts. You can design the user portal any way that meets your requirements, using any tools at your disposal, if they can use the RESTful API.
Before subscribes can access their accounts and access SVC services, an administrator must create their accounts. The SVC API operations, including the "Creating Accounts and Services by Using the SVC API" operation, operate on one record at a time.
Your administrator may need to create or alter multiple accounts at the same time, for example to:
Create accounts to have ready for your subscribers to configure.
Make large-scale changes to your SVC subscriber base for changes in policy.
Load a test database full of accounts to test new functionality.
Administrators use the Service Broker Batch Loader program to create or alter groups of SVC subscriber accounts. See "Provisioning Multiple Accounts by Using the Batch Loader Tools" for more information.
Figure 4-1 shows the SVC data objects and their relationships.
SVC is designed primarily to allow subscribers to administer their own accounts individually once you set up a user portal with the API operations. Your administration staff can also use these operations on individual subscriber accounts. The following sections explains the available API operations.
Perform operations in Table 4-1 to create, change, or delete SVC subscriber accounts for all SVC services.
Table 4-1 Subscriber Account Management Operations
Operation | Description |
---|---|
Creates subscriber accounts. Administrator-only. |
|
Modify a Subscriber Password or Social Circle One Number Preference |
Changes subscriber account details. |
Removes a subscriber account from the database. |
|
Returns a list of all subscriber account names and locations. Administrator-only. |
|
Returns all details for a subscriber account. |
Perform the operations in Table 4-2 to add, change, delete, or obtain information for personal contacts.
Table 4-2 Managing Personal Contact Operations
Operation | Description |
---|---|
Populates a subscriber's account with the personal contacts contained in the array submitted with this operation. |
|
Modifies a personal contact with the new status (toggles default on or off) and number that you submit with this operation. |
|
Returns an array of personal contact names and access URIs for a subscriber. |
|
Returns the personal contact number and status (default or not) for a single personal contact. |
|
Deletes the personal contact that you submit with this operation. |
|
Removes all personal contacts for a subscriber. |
Perform the operations in Table 4-3 to manage the SVC Social Circle one numbers and the routing policy rules for those numbers.
Table 4-3 Social Voice Service Management API Operations
Operation | Description |
---|---|
Adds an SVC Social Voice service to a subscriber account. Administrator-only. |
|
Retrieves the list of SVC Social Voice contacts for a subscriber's SVC Social Circle. |
|
Retrieves the SVC Social Voice name, type (group or personal), and any policies applied to a SVC Social Voice contact. |
|
Removes a SVC Social Voice service from a subscriber's account. |
|
Removes all SVC Social Voice contacts for a subscriber's account. |
|
Applies call routing policies to a single SVC Social Voice contact, that are based on the time of day and day of week. |
|
Retrieves details of a policy object. |
|
Makes changes to a subscriber's SVC Social Voice policy, by replacing the policy object in the database. |
|
Removes a SVC Social Circle policy rule. |
Each SVC Social Voice account can have any number of group and group members. There are two types of groups: public, which any subscriber can join, and private, which can be more exclusive. Typical private groups include family and friends; typical public groups include sports teams or hobby clubs. Two default groups are supplied: personal and business. Use the operations Table 4-4 to administer SVC Social Voice private groups, and the operations in Table 4-5 to administer SVC Social Voice public groups.
Table 4-4 Social Voice Private Group Management Operations
Operation | Description |
---|---|
Adds a SVC Social Voice private group to a subscriber's account. |
|
Adds a new member to a private group. |
|
Returns details for all private groups that a subscriber owns or is a member of. |
|
Sets the name, SVC Social Voice group number, and URI of a subscriber's contact group. |
|
Changes a private group's one number value. |
|
Returns an array of private group member. |
|
Returns the name, number, and active status for a private group member. |
|
Changes a private group contact details. |
|
Removes a subscriber from a private group. |
|
Deletes a contact group and all its members from a subscriber's account. |
Table 4-5 Social Voice Public Group Management
Operation | Description |
---|---|
Creates an SVC Social Voice public group. |
|
Adds a member to a Social Voice public group. |
|
Removes a member from a public group. |
|
Returns an array of the types, URIs, and names of all groups that a subscriber owns. |
|
Returns an array of all group names and group owners that a subscriber is a member of. |
|
Returns an array of the active status, name, contact name, contact number, and group type for each contact in a public group. |
|
Removes an SVC Social Voice public group. |
Perform the "Make a Click-to-dial Call" operation to initiate a call from a web interface.
Note that ACR messages are sent after the call is connected, rather than before.
Each SVC subscriber is eligible for access to a voice-mail system. Perform the operations in Table 4-6 to manage voice-mail access.
See "Configuring Voice-Mail for SVC Services" for details on configuring SVC voice-mail services.
Table 4-6 Voice-Mail Subscriber Management Operations
Operation | Description |
---|---|
Grants subscribers access to SVC Social Voicemail features. |
|
Adds or removes SVC Social Voicemail access for a subscriber, but does not affect the subscriber's data. This operation is intended for temporary service suspension. Administrator-only. To permanently remove a voice-mail access perform the "Delete Social Voicemail Access and Data for a Social Circle" operation. |
|
Deactivates a subscriber's SVC Social Voicemail access and removes all data. This operation permanently removes voice-mail access and data. Administrator-only. To temporarily suspend voice-mail access, perform the "Activate/Deactivate Social Voicemail Access" operation. |
|
Returns a list of all SVC Social Voicemail accounts and their status (active/inactive). Administrator-only. |
After granting access to SVC Social Voicemail services, perform the operations in Table 4-7 to manage subscriber's SVC Social Voicemail services.
Table 4-7 Voice-Mail Box Management Operations
Operation | Description |
---|---|
Changes the SVC Social Voicemail settings. |
|
Deletes the personal greeting WAV file. The default greeting file is used instead. |
|
Sets a voice-mail message as either public or private. |
|
Deactivates a name message WAV file. |
|
Returns the voice-mailbox settings, such as password, maximum number of allowed messages, and so on. |
|
Returns the location and status of a a subscriber's voice name message WAV file. |
|
Sets a WAV file as the personalgreeting.wav file in a subscriber's greeting folder. |
|
Sets a WAV file as a voice-mailbox name message. |
Perform the operations in Table 4-8 to manage SVC Social Voicemail messages.
Table 4-8 Voice-Mail Message Management Operations
Operation | Description |
---|---|
Removes a voice-mail message. |
|
Retrieves a list of voice-mail messages. |
|
Retrieves the WAV file containing a voice-mail message. |
|
Retrieves the message type, date and time created, caller name and number, file location, and public/private setting for a voice-mail message. |
|
Retrieves the location and status of a voice-mailbox greeting message. |
|
Sends a voice-mail message from one subscriber to another. |
|
Uploads a WAV file. |
|
Get a List of the Public Social Voicemail Messages in a Mailbox |
Retrieves a list of the publicly-accessible voice-mail message in a subscriber's mailbox. |
The SVC API creates or alters records in one account at a time, often by the subscribers themselves. During the course of creating or administering your SVC implementation, you will probably need to create or alter multiple accounts at the same time.
You use the Service Broker batch loader tools to make bulk changes to multiple SVC accounts in the same database at the same time. For more information, see the discussion on using the batch operation tools in Oracle Communications Service Broker VPN Implementation Guide.
The batch loader tools require system administration-level permission to use, and require you to specify the user name and password of an API administrator. The program is located in Oracle_home/ocsb61/admin_server/utils/bulkloader.
The batch loader tools accept input in the form of comma-separated value files.
See "Batch Loader SVC Data Files" for more information on the input data files.