4 Provisioning and Managing Social Voice Communicator Services

This chapter explains how to provision and manage Oracle Communications Service Broker SVC subscriber services data.

About the SVC API

You use the SVC RESTful API to create, provision, configure, and manage the SVC services that you offer to your subscribers.

You will 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, as long as they can use the API.

About Creating Subscriber Accounts with the SVC 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.

Understanding the SVC Data Model

Figure 4-1 shows the SVC data objects and their relationships.

Figure 4-1 SVC Data Model

Description of "Figure 4-1 SVC Data Model"

Creating Accounts and Services by Using the SVC API

SVC is designed primarily to allow subscribers to administer their own accounts individually. 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.

Managing Subscriber Accounts for SVC Services

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
Create Subscriber Accounts	Creates subscriber accounts. Administrator-only.
Modify a Subscriber Password or Social Circle One-number Preference	Changes subscriber account details.
Delete a Subscriber Account	Removes a subscriber account from the database.
Get Subscriber Accounts	Returns a list of all subscriber account names and locations. Administrator-only.
Get Subscriber Account Details	Returns all details for a subscriber account.

Managing Subscriber Account Personal Contacts

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
Create Personal Contacts in a Subscriber Account	Populates a subscriber's account with the personal contacts contained in the array submitted with this operation.
Modify a Personal Contact Details and/or Default Status	Modifies a personal contact with the new status (toggles default on or off) and number that you submit with this operation.
Get a Personal Contact List	Returns an array of personal contact names and access URIs for a subscriber.
Get a Personal Contact and its Default Status	Returns the personal contact number and status (default or not) for a single personal contact.
Delete a Social Circle Contact	Deletes the personal contact that you submit with this operation.
Delete All Personal Contacts	Removes all personal contacts for a subscriber.

Managing Subscriber Personal Social Circle Accounts

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
Create a Social Circle One-number	Adds an SVC Social Voice service to a subscriber account. Administrator-only.
Get All Social Circle One-number Contacts for a Subscriber	Retrieves the list of SVC Social Voice contacts for a subscriber's SVC Social Circle.
Get Details for a Social Circle Contact	Retrieves the SVC Social Voice name, type (group or personal), and any policies applied to a SVC Social Voice contact.
Delete a Social Circle Contact	Removes a SVC Social Voice service from a subscriber's account.
Delete All Social Circle Contacts	Removes all SVC Social Voice contacts for a subscriber's account.
Create a Policy Rule for a Social Circle Contact	Applies call routing policies to a single SVC Social Voice contact, that are based on the time of day and day of week.
Get a Social Circle Policy Rule Details	Retrieves details of a policy object.
Modify a Social Circle Policy Rule	Makes changes to a subscriber's SVC Social Voice policy, by replacing the policy object in the database.
Delete a Social Circle Policy Rule	Removes a SVC Social Circle policy rule.

Managing a Subscribers' Social Voice Service

Each SVC Social Voice account can have any number of group contacts. Members are typically family or friends. There are two default groups supplied: personal and business. Perform the operations in Table 4-4 to administer SVC Social Voice groups.

Table 4-4 Group Contact API Operations

Operation	Description
Create a Social Voice Group	Adds a SVC Social Voice group to a subscriber's account.
Set Personal Group Contact Details	Sets the name, SVC Social Voice group-number, and URI of a subscriber's contact group.
Get Group Contact Names	Retrieves a list of a subscriber's group contacts.
Modify Personal Contact Group Name	Changes a contact group name.
Delete a Personal Contact Group	Deletes a contact group and all its members from a subscriber's account.
Add a Personal Group Contact	Adds a member's name, number, and status (active or inactive) to a subscriber's contact group.
Get Personal Contact Group Contact Details	Retrieves a contact group member name, number, and status.
Get All Personal Contacts Group Contacts	Retrieves a list of all member's URIs for a subscriber's contact group.
Modify a Personal Group Contact	Replaces a group contact URIs in a subscriber's account with a new one.
Delete a Personal Group Contact	Removes a member from a subscriber's group contact list.

Making a Click-to-Dial Call

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.

Managing Social Voicemail Access

Each SVC subscriber is eligible for access to a voice-mail system. Perform the operations in Table 4-5 to manage voice-mail access.

Table 4-5 Voice-Mail Subscriber Management Operations

Operation	Description
Activate Social Voicemail for Subscribers	Grants subscribers access to SVC Social Voicemail features.
Modify Social Voicemail Access	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.
Delete Social Voicemail Access and Data for a Social Circle	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 "Modify Social Voicemail Access" operation.
Get All Social Voicemail Subscriber Accounts	Returns a list of all SVC Social Voicemail accounts and their status (active/inactive). Administrator-only.

Managing Social Voicemail Service

After granting access to SVC Social Voicemail services, perform the operations in Table 4-6 to manage subscriber's SVC Social Voicemail services.

Table 4-6 Voice-Mail Box Management Operations

Operation	Description
Modify Social Voicemail Settings	Changes the SVC Social Voicemail settings.
Cancel a Social Voicemail Personal Greeting Message	Deletes the personal greeting WAV file. The default greeting file is used instead.
Modify Social Voicemail Message Public/Private Setting	Sets a voice-mail message as either public or private.
Deactivate a Social Voicemail Name Message	Deactivates a name message WAV file.
Get Social Voicemail Settings	Returns the voice-mailbox settings, such as password, maximum number of allowed messages, and so on.
Get Social Voicemail Name Message Settings	Returns the location and status of a a subscriber's voice name message WAV file.
Create Social Voicemail Greeting Message	Sets a WAV file as the personalgreeting.wav file in a subscriber's greeting folder.
Create Social Voicemail Box Name Message	Sets a WAV file as a voice-mailbox name message.

Managing Social Voicemail Messages

Perform the API operations in Table 4-7 to manage SVC Social Voicemail messages.

Table 4-7 Voice-Mail Message Management Operations

Operation	Description
Delete a Social Voicemail Message	Removes a voice-mail message.
Get a List of Social Voicemail Messages	Retrieves a list of voice-mail messages.
Get a Social Voicemail Message File	Retrieves the WAV file containing a voice-mail message.
Get Details for a Social Voicemail Message	Retrieves the message type, date and time created, caller name and number, file location, and public/private setting for a voice-mail message.
Get Personal Greeting Message Settings	Retrieves the location and status of a voice-mailbox greeting message.
Send a Social Voicemail Message to Other Subscribers	Sends a voice-mail message from one subscriber to another.
Create sentMessage Voice Message	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.

Provisioning Multiple Accounts by Using the Batch Loader Tools

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 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/ocsb60/admin_console/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.