| Oracle® Communications Service Broker SVC Implementation Guide Release 6.0 Part Number E24885-02 |
|
|
View PDF |
| Oracle® Communications Service Broker SVC Implementation Guide Release 6.0 Part Number E24885-02 |
|
|
View PDF |
This chapter describes the Oracle Communications Service Broker SVC subscriber management RESTful API, an application programming interface that creates, modifies, and deletes subscriber accounts and data for SVC services.
This chapter lists RESTful operations for this API, including the parameters accepted and returned by each operation and examples of HTTP requests and responses.
All JSON body parameters for POST (create) operations are required unless indicated as optional. For PUT (modify) operations, the request only needs to contain the attributes to be changed.
See "About the SVC API Operations" for information on using individual operations in this API.
Note:
In the request and response message examples in this chapter, line breaks and spaces have been added to the JSON data in the body of the message to improve readability.These operations create, update, or delete SVC subscriber accounts.
Creates SVC subscriber accounts for a set of users given their user names and their initial passwords.
An HTTP response 200 message is returned on success. If one member of the list cannot be created, no accounts are created and the 400 (HTTP_BAD_REQUEST) error message is returned.
Administrators
POST
/svc/subscribers
The request body parameters accepted by the operation are arrays of:
username: (String) Subscriber's user name.
password: (String) Subscriber's initial password. This is usually supplied by a service provider.
isPONPresented: (Boolean) Optional. If true, the subscriber's personal SVC Social Voice Group-number is used as the caller number when the subscriber initiates a call. If false, the subscriber's calling phone number is used. The default value is false.
POST /svc/subscribers HTTP/1.1 Accept: application/json Authentication: user admin:D@3K4L@F$5S5OIKLS Content-Length: ??Content-Type: application/jsonHost: ocsb host
[{"username":"bob345","password":"password", true}
{"username":"ming_yu","password":"password"}
{"username":"George_Michaels","password":"password"}
{"username":"555_813_8910","password":"password"}]
Returns a list of all subscriber user names and URIs.
Administrators
GET
/svc/subscribers
Empty
This operation returns a comma-separated list of user names and their access URIs.
GET http://10.182.98.78:9001/svc/subscribers HTTP/1.1Accept-Encoding: gzip,deflateUser-Agent: Jakarta Commons-HttpClient/3.1Host: 10.182.98.78:9001
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 105
Server: Lab1(8.0.1.0)
[{"tom":"http://10.182.98.78:9001/svc/subscriber/tom"}, {"alice":"http://10.182.98.78:9001/svc/subscriber/alice"}]
Retrieves subscriber account information given the subscriber username.
Administrator or subscriber
GET
/svc/subscriber/Subscriber_Name
Empty
This operation returns these subscriber account details:
username: (String) The subscriber's user name.
groups: (String) The subscriber's group access URI.
one_number: (String) The subscriber's SVC Social Circle One-number access URI
contacts: (String) The subscriber's contact list URI.
isPONPresented: (Boolean) If true, the subscriber's personal SVC Social Circle One-number is used as the caller number when the subscriber initiates a call. If false, the subscriber's originating phone number is used.
GET http://10.182.98.78:9001/svc/subscriber/bob HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 105Server: Lab1(8.0.1.0){ "username":"bob","groups":"http://localhost:9001/svc/subscriber/bob/groups""one_numbers":"http://localhost:9001/svc/subscriber/bob/onenumber","contacts":"http://localhost:9001/svc/subscriber/bob/contacts","isPONPresented":true}
Changes a subscribers's password, SVC Social Circle One-number preference, or both.
Administrator or subscriber
PUT
/svc/subscriber/Subscriber_Name
This operation submits the following parameters:
password: (String) A new password for the subscriber to use.
isPONPresented: (Boolean) If true, the subscriber's personal SVC Social Circle One-number is used as the caller number when the subscriber initiates a call. If false, the MSISDN number used to create the subscriber's account is used.
PUT http://10.182.98.78:9001/svc/subscriber/bob HTTP/1.1Accept-Encoding: gzip,deflateUser-Agent: Jakarta Commons-HttpClient/3.1Host: 10.182.98.78:9001{"password":"password", "isPONPresented":"true"}
Deletes a subscriber's SVC account.
Administrator or subscriber.
DELETE
/svc/subscriber/Subscriber_Name
Empty
These operations add, change, delete, or obtain information for SVC Social Circle personal contacts.
Populates a subscriber's list of contacts from an array that you submit with this operation. Exactly one of the contacts must be given the default value of true making it the default contact.
Administrator or subscriber.
POST
/svc/subscribers/Subscriber_Name/contacts
This operation submits the following parameters:
Contact_name:Contact_number: (String) or Contact_name:SIP_address: (String) The name to use for the contacts and their identifying MSISDN number or SIP address in URI format.
default: (Boolean) Set the default contact to true and all others to false.
POST http://10.182.98.78:9001/svc/subscribers/bob/contacts HTTP/1.1Accept-Encoding: gzip,deflateUser-Agent: Jakarta Commons-HttpClient/3.1Host: 10.182.98.78:9001 [{"mobile":"13811110000","default":true},{"home":"01082311212"},{"office":"alice@oracle.com"}]
Returns all personal contact names and access URIs for a subscriber.
Administrator or subscriber.
GET
/svc/subscriber/Subscriber_Name/contacts
Empty
This operation returns an array contact names and their access URIs.
GET http://10.182.98.78:9001/svc/subscriber/bob/contacts HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 137Server: Jetty(8.0.1.0)[{"office":"http://10.182.98.78:9001/svc/subscriber/alice/contact/office"}, {"home":"http://10.182.98.78:9001/svc/subscriber/alice/contact/home"}]
Deletes all members of a subscriber's SVC Social Circle personal contact list.
Administrator or subscriber
DELETE
/svc/subscriber/Subscriber_Name/contacts
Empty
DELETE http://10.182.98.78:9001/svc/subscriber/bob/contacts HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
Retrieves a subscriber's SVC Social Circle personal contact information and whether the contact number is the default.
Administrator or subscriber
GET
/svc/subscriber/Subscriber_Name/contacts/Contact_name
Empty
This operation returns the following parameters:
default: (Boolean) Specifies whether the contact number is the default number.
number: (String) the contact string. For example a telephone number or email address.
GET http://10.182.98.78:9001/svc/subscriber/bob/contact/home HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0)[{"default":false,"number":"bob@oracle.com"}]
Modifies an SVC Social Circle personal contact default status or contact information.
Administrator or subscriber
PUT
/svc/subscriber/Subscriber_Name/contact/Contact_name
This operation submits the following parameters:
default: (Boolean) Optional. true makes the contact the subscriber's default contact. Non-default numbers do not need an argument.
number: (String) The contact's MSISDN number to add.
PUT http://10.182.98.78:9001/svc/subscriber/bob/contact/home HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 URI: http://10.182.100.43:9001/svc/subscriber/bob/contact/home[{"default":true,"number":"222@129.148.75.22"}]
Deletes an SVC Social Circle personal contact.
Administrator or subscriber
DELETE
/svc/subscriber/Subscriber_Name/contact/Contact_name
This operation submits the Contact_Name parameter of the contact to delete.
DELETE http://10.182.98.78:9001/svc/subscriber/alice/contact/home HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
These operations manage SVC Social Circle one-numbers and contacts.
Adds an SVC Social Circle contact to a subscriber account. A subscriber can only have one personal number, but any number of group numbers.
Administrator
POST
/svc/subscriber/Subscriber_Name/onenumber
This operation submits the following parameters:
onenumber: (String) The SVC Social Circle service number to add.
type: (String) The SVC Social Voice category; default values are personal or group.
POST http://10.182.98.78:9001/svc/subscriber/bob/onenumber HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001 [{"onenumber":"+123", "type":"personal"},
{"onenumber":"+456", "type":"group"}]
Returns details for all SVC Social Circle contacts for a subscriber account.
Administrator or subscriber
GET
/svc/subscriber/Subscriber_Name/onenumbers
Empty
This operation returns an array of the following parameters for each contact:
onenumber: (String) The name of the SVC Social Circle contact.
onenumber_url: (String) The access URL for the SVC Social Circle contact.
type: (String) The SVC Social Circle type. The default values are group and personal.
GET http://10.182.98.78:9001/svc/subscriber/alice/onenumbers HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 0Server: Jetty(8.0.1.0)
[{"onenumber":"+123","onenumber_url":"http://localhost:9001/svc/subscriber/alice/onenumber/+123",
"onenumber_policy":[],"type":"personal"},{"onenumber":"+456",
"onenumber_url":"http://localhost:9001/svc/subscriber/alice/onenumber/+456",
"onenumber_policy":[],"type":"group"}]
Deletes all SVC Social Circle contacts for a subscriber account.
Administrator or subscriber
DELETE
/svc/subscriber/Subscriber_Name/onenumbers
Empty
DELETE http://10.182.98.78:9001/svc/subscriber/alice/onenumbers HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
Returns details for an SVC Social Circle contact.
Administrator or subscriber
GET
/svc/subscriber/Subscriber_Name/onenumber/One_Number
Empty
This operation returns the following parameters:
onenumber: (String) The SVC Social Circle contact number.
type: (String) The SVC Social Circle type. The default values are group and personal
onenumber_policy: (Array) A comma-separated list of policy names and access URIs.
GET http://10.182.98.78:9001/svc/subscriber/alice/onenumber/123 HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 0Server: Jetty(8.0.1.0)
[{"onenumber":"123","type":"personal",
"onenumber_policy":[{"policy1": "http://localhost:9001/svc/subscriber/bob/onenumber/123/policy/policy1}]
Deletes a SVC Social Circle contact for a subscriber account.
Administrator or subscriber
DELETE
/svc/subscriber/Subscriber_Name/onenumber/One_Number
Empty
DELETE http://10.182.98.78:9001/svc/subscriber/alice/onenumber/789 HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
Creates a behavior policy for an SVC Social Circle contact.
Administrator or subscriber
POST
/svc/subscriber/Subscriber_Name/onenumber/One_Number/policy/Policy_name
This operation accepts a policy rule array of these values:
froms: Identifies the numbers based on their address and group values. An empty list matches all calls.
address: Uses this syntax: number @domain.
group: A group name
sequenialCall: Boolean. If true, the value for sequentialRingInterval sets the ring interval.
sequentialRingInterval: The number of seconds to allow the call to ring.
toAddresses: The target SIP or Tel URI.
schedule: Specifies the time based routing parameters.
startDate (year, month day): The routing policy start day.
startTime (hour, minute, second): The routing policy start time.
endTime (hour, minute, second): The routing policy end time.
recurrentPeriod: The recurring mode. 1 to repeat daily; 2 for Monday through Friday.
timezone: The routing policy time zone.
until (year, month, day): A routing policy end date.
priority: 1 is the highest priority. When a call can be mapped to multiple policies, the highest priority policy is used.
POST http://10.182.98.78:9001/svc/subscriber/alice/onenumber/123/policy/policy21 HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001 [{
"froms": [],
"sequencialCall": true,
"sequentialRingInterval": 30,
"toAddresses": [
"tom@oracle.com",
"0118613611046326"
],
"schedule": {
"startDate":{
"year":2009,
"month":10,
"day":24
},
"startTime":{
"hour":1,
"minute":00,
"second":0
},
"endTime":{
"hour":13,
"minute":0,
"second":0
},
"recurrentPeriod":1,
"timezone":+8,
"until":{
"year":2010,
"month":12,
"day":24
}
},
"priority":10
}]
Retrieves the details of an SVC Social Circle policy rule.
Administrator or subscriber
GET
/svc/subscriber/Subscriber_Name/onenumber/One_Number/policy/Policy_name
Empty
The response includes a policy rule array. For more information on the array syntax, see the "Create a Social Circle One-number" operation.
GET http://10.182.98.78:9001/svc/subscriber/bob/onenumber/789/policy/policy21 HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 0Server: Jetty(8.0.1.0)
[{"froms": [{"address": "sip:1234@asfddd.com"}], "sequencialCall": false, "sequentialRingInterval": 30, "toAddresses": [ "tom@oracle.com", "0118613611046326" ] , "schedule":{ "startDate":{ "year":2009, "month":11, "day":24}, "startTime":{ "hour":9, "minute":30, "second":0}, "endTime":{ "hour":18, "minute":0, "second":0}, "recurrentPeriod":2, "timezone":-8, "until":{ "year":2010, "month":12, "day":24}}, "priority":10}]
Makes changes to an SVC Social Circle policy rule object.
Administrator or subscriber
PUT
/svc/subscriber/Subscriber_Name/onenumber/One_Number/policy/Policy_Name
This operation submits a policy rule array that replaces a policy rule object. For more information on the policy object, see the "Create a Social Circle One-number" operation.
PUT http://10.182.98.78:9001/svc/subscriber/alice/onenumber/123/policy/policy21 HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001 [{ "froms": [], "sequencialCall": true, "sequentialRingInterval": 30, "toAddresses": [ "tom@oracle.com", "0118613611046326" ], "schedule": { "startDate":{ "year":2009, "month":10, "day":24 }, "startTime":{ "hour":1, "minute":00, "second":0 }, "endTime":{ "hour":13, "minute":0, "second":0 }, "recurrentPeriod":1, "timezone":+8, "until":{ "year":2010, "month":12, "day":24 } }, "priority":10}]
Removes a policy from a subscriber's SVC Social Circle contact.
Administrator or subscriber
DELETE
/svc/subscriber/Subscriber_Name/onenumber/One_Number/policy/Policy_Name
Empty
These operations administer SVC Social Voice accounts.
Adds a SVC Social Voice group contact to a subscriber's account.
Administrator or subscriber
POST
/svc/subscriber/Subscriber_Name/group/Group_Name
This operation submits the following parameters:
grp_onenumber: (String) The group name to add. Can be any names except Others and All Contacts which are reserved for Oracle use.
POST http://10.182.98.78:9001/svc/subscriber/alice/group/family HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
[{"grp_onenumber":"555-6700"}]
Sets the name, SVC Social Voice Group-number, and URI of a subscriber's SVC Social Voice contact group.
Administrator or subscriber
POST
/svc/subscriber/Subscriber_Name/group/Group_name
Empty
This operation returns the follows group parameters:
grp_onenumber: (String) The group's SVC Social Voice Group-number access number.
grp_name: (String) The name of the group.
grp_contacts: (String) The URI to access group contacts.
POST http://10.182.98.78:9001/svc/subscriber/alice/group/family HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 104
Server: Jetty(8.0.1.0)
[{"grp_onenumber":"123456", "grp_name":"friends","grp_contacts":"http://10.182.98.78:9001/svc/subscriber/cindy/group/friends/contacts"}]
Returns a list of the contact names in a subscriber's SVC Social Voice contact group.
Administrator or subscriber
GET
/svc/subscriber/Subscriber_Name/groups
Empty
The response message includes an array of group URIs.
GET http://10.182.98.78:9001/svc/subscriber/bob/groups HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 104
Server: Jetty(8.0.1.0)
[{"groups":["http://10.182.98.78:9001/svc/subscriber/cindy/group/default_group","http://10.182.98.78:9001/svc/subscriber/cindy/group/friends"]
Changes a subscriber's SVC Social Voice personal contact group name.
Administrator or subscriber
PUT
/svc/subscriber/Subscriber_Name/group/Group_name
This operation submits any of the follows parameters:
grp_onenumber: (String) The group's SVC Social Voice access number.
PUT http://10.182.98.78:9001/svc/subscriber/alice/group/family HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001 [{"grp_onenumber":"family"]
HTTP/1.1 200 OK Content-Type: application/json Content-Length: 0 Server: Jetty(8.0.1.0)
Deletes a subscriber's SVC Social Voice group and all of its members.
Administrator or subscriber
DELETE
/svc/subscriber/Subscriber_Name/group/Group_name
Empty
DELETE http://10.182.98.78:9001/svc/subscriber/alice/group/family HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OK Content-Type: application/json Content-Length: 0 Server: Jetty(8.0.1.0)
Adds a SVC Social Voice personal contact group name, number, and status.
Administrator or subscriber
POST
/svc/subscriber/Subscriber_Name/group/Group_name/contact/Contact_Name
This operation submits the following parameters:
grp_contact: (Array) An array containing the contact name, contact number, and a boolean value indicating active/inactive. grp_contact uses this syntax:
["grp_contact":["contact_name","contact_number","true | false"]}
Example 8-38 shows a sample grp_contact array.
POST hhttp://10.182.98.78:9001/svc/subscriber/alice/group/family/contact/bob HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
[{"grp_contact":["bob", "3869", "false"]}]
Returns an array with the SVC Social Voice personal group contact name, number, and active/inactive status.
Administrator or subscriber
GET
/svc/subscriber/Subscriber_Name/group/Group_name/contact/Contact_name
Empty
This operation returns the following parameters:
grp_contact: (Array) An array containing the contact name, contact number, and a boolean value indicating active/inactive. grp_contact uses this syntax:
["grp_contact":["contact_name","contact_number","true | false"]}
Example 8-40 shows a sample grp_contact array.
GET http://10.182.98.78:9001/svc/subscriber/alice/group/family/contact/henry HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OK
Content-Length: 0
Server: Jetty(8.0.1.0)
[{"grp_contact":["henry", "3869", "false"]}]
Returns an array of a subscriber's SVC Social Voice personal contact group URIs.
Administrator or subscriber
GET
/svc/subscriber/Subscriber_Name/group/Group_name/contacts
Empty
This operation returns an array of the Group Contact URIs.
GET http://10.182.98.78:9001/svc/subscriber/alice/group/family/contacts HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OK
Content-Length: 0
Server: Jetty(8.0.1.0)
[{"contacts":["http://10.182.98.78:9001/svc/subscriber/cindy/group/friends/contact/contact1","http://10.182.98.78:9001/svc/subscriber/cindy/group/friends/contact/contact2"]
Replaces a SVC Social Voice personal contact group URI with a new one. All changes in the URI are accepted.
Administrator or subscriber
PUT
/svc/subscriber/Subscriber_Name/group/Group_name/contact/Contact_name
This operation returns the following parameters:
grp_contact: (Array) An array containing the contact name, contact number, and a boolean value indicating active/inactive. grp_contact uses this syntax:
["grp_contact":["contact_name","contact_number","true | false"]}]
Example 8-43 shows a sample grp_contactarray.
PUT http://10.182.98.78:9001/svc/subscriber/alice/group/family/contact/fred HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
[{"grp_contact":["fred", "3869", "false"]}]
Removes a contact from a subscriber's SVC Social Voice personal group.
Administrator or subscriber
DELETE
/svc/subscriber/Subscriber_Name/group/Group_name/contact/Contact_name
Empty
This operation makes a Click-to-Dial call.
Connects the subscriber's SVC Social Circle default contact number on a web site or email server to a callee on a SIP or SS7 telecom network.
Administrator or subscriber
GET
/svc/subscriber/Subscriber_Name/makecall?to=callee
Empty
These operations manage SVC Social Voicemail access.
Activates SVC Social Voicemail features for existing subscribers.You submit an array of subscriber user names and passwords with the request to activate accounts for those subscribers. If any invalid or pre-existing subscribers are submitted, the entire operation fails and none of the subscribers are granted access to SVC Social Voicemail.
Administrator
POST
/svc/admin/vmboxes
This submits an array of user name/password combinations. Voice-mail is activated for all of the users in the array.
username: (String) The subscriber's user name.
one_number: (String) The subscriber's MSISDN SVC Social Circle One-number
POST http://10.182.98.78:9001/svc/admin/vmboxes HTTP/1.1Accept-Encoding: gzip,deflateUser-Agent: Jakarta Commons-HttpClient/3.1Host: 10.182.98.78:9001{"username":"bob345","onenumber":"123456"}
[{"username":"ming_yu","onenumber":"5555551234"}
{"username":"George_Michaels","onenumber":"4155550999"}
{"username":"555_813_8910","onenumber":"2135550444"}]
Changes SVC Social Voicemail access for a subscriber. You submit the subscriber's user name and SVC Social Circle One-number and an isActive setting of true or false to activate or deactivate the subscriber's account. No resources or data are removed when the account is deactivated.
Use this operation to deactivate a subscriber's SVC Social Voicemail account temporarily.
To delete a subscriber's account resources and data permanently, see "Delete Social Voicemail Access and Data for a Social Circle".
Administrator
PUT
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/admin
This operation submits the following parameters:
isActive: (Boolean) A value of true activates subscriber voice-mail access and false deactivates it.
PUT https://10.182.98.78:9001/svc/vmsubscriber/bob345/onenumber/123456/vmbox/admin HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
[{ "isAcitve":true }]
Deactivates a subscribers's SVC Social Voicemail access, and deletes all SVC Social Voicemail data and recordings associated with that subscriber. Use this operation when you do not expect the subscriber to ever need the SVC Social Voicemail account or data ever again.
To deactivate a subscriber's account without removing and data (temporary deactivation), see "Modify Social Voicemail Access".
Administrator
DELETE
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/admin
Empty
DELETE https://10.182.98.78:9001/svc/vmsubscriber/bob345/onenumber/123456/vmbox/admin HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
Returns a list of all SVC Social VoiceMail accounts, and indicates whether those accounts are active or inactive. The response includes each user's user name, SVC Social Circle One-number, the URI of their SVC Social Voicemail box, and whether the voice permission is active or inactive.
Administrator
GET
/svc/admin/vmboxes
Empty
The response includes the following parameters for each subscriber:
subscriber: (String) The subscriber's user name.
one_number: (String) The subscriber's MSISDN SVC Social Circle One-number.
address: (String) The URI of the subscriber's voice-mail box.
isActive: (Boolean) true for subscribers with active voice-mail access and false for subscribers with inactive voice-mail access.
GET http://10.182.98.78:9001/svc/admin/vmboxes HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 137Server: Jetty(8.0.1.0)
[{"subscriber":"bob345","onenumber":"123456","address":"/svc/vmsubscriber/bob345/onehumber/123456/vmbox","isActive": true}
{"subscriber":"ming","onenumber":"5555551234","address":"/svc/vmsubscriber/ming/onenumber/5555551234/vmbox","isActive": true}
{"subscriber":"George_Michaels","onenumber":"4155550999","address":"/svc/vmsubscriber/George_Michaels/onenumber/4155550999/vmbox","isActive": true}
{"subscriber":"555_813_8910","onenumber":"2135550444","address":"/svc/vmsubscriber/555_813_8910/onenumber/2135550444/vmbox","isActive": true}]
Change any of these SVC Social Voicemail settings for a subscriber:
Whether to route unanswered calls to a SVC Social Voicemail box.
The greeting message.
The name message.
The SVC Social Voicemail box password.
Voice-mail password status.
A time limit for storing old messages.
An email address to send a “you have new voice-mail message” announcement mail to. This feature is inactive if no email address is submitted.
The maximum number of inbound messages stored in the voice-mail box.
The maximum number of outbound messages.
The maximum length for a voice-mail message.
Administrator or subscriber.
PUT
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox
Empty
The request body parameters accepted by the operation include:
enableVoiceMail: (Boolean) true (default value) routes unanswered incoming calls to the subscriber's voice-mail box. false drops unanswered calls.
password: (String or null) Must be either a numerical string at least six digits long, or null. A null value deactivates the voice-mail account's password protection.
voiceMessageExpireDays: (Digit String) The number of days that voice-mail messages are stored before being automatically deleted. If no value is submitted, Service Broker uses the system MBean setting.
maximumInboundMessagesInMailbox: (Digit String) The maximum number of voice-mail messages that the voice-mail feature stores. Once this limit is reached, the oldest message is deleted when a new message is stored. If no value is submitted, Service Broker uses the system MBean setting.
maximumOutboundMessagesInMailbox: (Digit String) The maximum number of uploaded messages to store. Once this limit is reached, the oldest message is deleted when a new message is stored. If no value is submitted, Service Broker uses the system MBean setting.
maximumPhoneMessageDuration: (Digit String) the maximum number of seconds for a voice-mail message duration. Recording stops when the limit is reached. If no value is submitted, Service Broker uses the system MBean setting.
notifyEmailAddress: (String or null) A valid email address or a null value. If an email address is submitted with this parameter, Service Broker sends an email message to this address each time a voice-mail message is received. A null value prohibits the voice-mail box from sending voice-mail announcements. This parameter is void if an administrator has deleted or deactivated the voice-mail box account.
PUT https://10.182.98.78:9001/vmsubscriber/bob345/onenumber/1234567/vmbox HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0
[{"enableVoiceMail":true, "voiceMessageExpireDays":60, "maximumInboundMessagesInMailbox":20, "maximumOutboundMessagesInMailbox":20, "maximumPhoneMessageDuration":300, "notifyEmailAddress":"bob@bob.com","greeting" : "/svc/vmsubscriber/alice/onenumber/123321/vmbox/greeting" , "voiceName":"/svc/vmsubscriber/bob/onenumber/123321/vmbox/name", "isPasswordEnable":true} ]
These operations manage SVC Social Voicemail messages.
Cancels a subscriber's personal greeting message by deleting their personalGreeting.wav file. The default greeting file is used instead.
Administrator or subscriber
DELETE
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/greeting
Empty
DELETE https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/greeting HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
Sets a SVC Social Voicemail messages as either publicly or privately accessible.
Administrators or subscribers
PUT
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/message/Message_Name
This operation submits the following parameter:
isPublic (Boolean) true if this message is publicly accessible; false if it is only accessible by the recipient.
Empty
PUT https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/message/abc.wav HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001[{"ispublic":"true"}]
Deactivates a subscriber's SVC Social Voicemail name message.
Administrator or subscriber
DELETE
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/name
Empty
DELETE https://10.182.98.78:9001/vmsubscriber/bob345/onenumber/123456/vmbox/name HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
Deletes a SVC Social Voicemail message.
Administrator or subscriber
DELETE
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/message/Message_Name
Empty
DELETE https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/message/abc.wav HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
Returns a list of all the SVC Social Voicemail message names and types for a subscriber.
Administrator or subscriber
GET
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/messages
Empty
On success the response includes an HTTP 200 OK message and an array of entries with the syntax: messageName : type. Where type is one of receivedMessage or sentMessage.
GET https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/messages HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0[{"messageName":""sample_123124","type":"ReceivedMessage"}, {"messageName":"fridaymessage_123124","type":"SentMessage"},{"messageName":""20100102063002_123124","type":"ReceivedMessage"}, {"messageName":""sample_greeting","type":"SentMessage"}]
Gets a SVC Social Voicemail message WAV file.
Administrator or subscriber
GET
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/message/Message_Name
Empty
On success the response includes an HTTP 200 OK message and the bit stream of the WAV file requested.
GET https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/message/abc.wav HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0Host: 10.182.98.78:9001Content-Length: 231837Content-Type: multipart/form-data; boundary="----=_Part_0_20761102.1296024147640"MIME-Version: 1.0User-Agent: Jakarta Commons-HttpClient/3.1Host: 10.182.98.78:9001Content-Length: 231837------=_Part_0_20761102.1296024147640Content-Type: audio/x-wav; name=test.wavContent-Transfer-Encoding: binaryContent-Disposition: form-data; name="message1.wav"; filename="name.wav"(binary data)
Returns details about a SVC Social Voicemail message, including:
The message type.
The date and time it was created.
The caller name and number.
The file location.
Whether the message is public or private.
Administrator or subscriber
GET
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/message/Message_Name
Empty
The response includes the following parameters:
type: (String) Can be one of SentMessage or ReceivedMessage.
createTime: (UTC Timestamp) The time the message was created.
callerName: (String) The name of the caller leaving the message.
callerNum: (Digit string) The phone number of the caller leaving the message.
fileLocation: (String) The relative address to the voice name message file.
isPublic: (Boolean) true if this message is publicly accessible; false if it is only accessible by the recipient.
GET https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/message/abc.wav HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0[{"type":"SentMessage","time":"201101201333","callerName":"john","callerNum":"3231","fileName":"abc.wav", "fileLocation":"/21/32/3231/abc.wav","isPublic":"true"} ]
Retrieves the location and status (active/inactive) of a subscriber's voice greeting message.
Administrator or subscriber
GET
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/greeting
Empty
This operations returns the following parameters:
isPersonalActive: (Boolean) true indicates that the voice-mail personal greeting is activated; false indicates that the voice-mail greeting is not activated.
fileLocation: (String) Returned if isPesonalActive is true; the relative address to the voice name message file.
GET https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/greeting HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0[{"isPersonalActive":"true","fileLocation":"123456/vmbox/greeting" }]
Returns these SVC Social Voicemail settings for a subscriber:
Whether to route calls to a voice-mailbox.
The Social Voicemail service password.
The number of days to keep a voice-mail message is stored before it is automatically deleted.
The maximum number of inbound messages in the voice-mailbox.
The maximum number of outbound messages.
The maximum length for a voice-mail message.
An email address to send a “new voice-mail message” announcement email to.
Administrator or subscriber.
GET
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox
The request body parameters accepted by the operation include:
enableVoiceMail: (Boolean) A value of true routes unanswered calls to the subscriber's voice-mail. A value of false drops unanswered calls.
password - (Digit string) The password used by subscribers to access their voice-mail service. Must be at least six digits long. A null value deactivates the password and prevents the subscriber from accessing the voice-mail service. Can be reset by subscriber.
voiceMessageExpireDays: (Digit string) The number of days that voice-mail is stored before being automatically deleted. This setting cannot be longer than the system MBean setting.
maximumInboundMessagesInMailbox: (Digit string) The maximum number of voice-mail messages that the voice-mail feature stores. Once the limit is reached, the oldest message is deleted when a new message is stored. If no value is submitted, Service Broker uses the system MBean setting.
maximumOutboundMessagesInMailbox: (Digit String) The maximum number of uploaded messages to store. Once this limit is reached, the oldest message is deleted when a new message is stored. If no value is submitted, Service Broker uses the system MBean setting.
maximumPhoneMessageDuration: (Digit String) the maximum number of seconds for a voice-mail message duration. Recording stops when the limit is reached. If no value is submitted, Service Broker uses the system MBean setting.
notifyEmailAddress - (String) The email address to receive an email notification when a voice-mail message arrives. A null value prohibits the SVC Social Voicemail service from sending voice-mail announcements.
The response includes the same parameters as the request, with a success or failure value in each parameter field to indicate whether the field was successfully changed.
GET https://10.182.98.78:9001/vmsubscriber/bob345/onenumber/123456/vmbox HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
[{"enableVoiceMail":true, "password":"password", "voiceMessageExpireDays":60, "maximumInboundMessagesInMailbox":20, "maximumOutboundMessagesInMailbox":20, "maximumPhoneMessageDuration":300, "notifyEmailAddress":"bob345@bob.com", } ]
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0[ {"enableVoiceMail":"success","maximumInboundMessagesInMailbox":"success", "maximumInboundMessagesInMailbox":"success",maximumPhoneMessageDuration":"success","notifyEmailAddress": "success","voiceMessageExpireDays":"success","password":"failure: password should be six digit numeric type. "} ]
Retrieves the location and status (active/inactive) of a subscriber's SVC Social Voicemail name message.
Administrator or subscriber
GET
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/name
Empty
This operations returns the following parameters:
isPersonalActive: (Boolean) true indicates that the voice-mail name is activated; false indicates that the voice-mail message is not activated.
fileLocation: (String) Present if isPesonalActive is true; the relative address to the voice name message file.
GET https://ocsb_hostport/vmsubscriber/bob345/onenumber/123456/vmbox/name HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0[{"isPersonalActive":"true","fileLocation":"123456/vmbox/name" }]
Sends a message from one SVC Social Voicemail subscriber to another.
Administrator or subscriber
POST
vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/message/Message_Name/sendmessage
This operation submits the following parameters:
receiverOneNumbers: (Array of digit strings) An array of the SVC Social Circle One-numbers to send the message to.
This operation returns the following parameters:
receiverOneNumbers: (Array of digit strings) An array of SVC Social Circle One-numbers that the message was successfully sent to.
POST https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/test.wav/sendmessage HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
{"receiverOneNumbers": ["122345", "3211"]}
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0)[ {"receiverOneNumbers": ["122345", "3211"]} ]
Sets the subscriber's SVC Social Voicemail service greeting as personalgreeting.wav in the subscriber's greeting folder.
Administrator or subscriber
POST
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/greeting
This operation does not submit any parameters, but it does require the voice-mail greeting message WAV file as an attachment.
POST https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/greeting HTTP/1.1 Accept-Encoding: gzip,deflate Content-Type: multipart/form-data; boundary="----=_Part_0_20761102.1296024147640"MIME-Version: 1.0User-Agent: Jakarta Commons-HttpClient/3.1Host: 10.182.98.78:9001Content-Length: 231837------=_Part_0_20761102.1296024147640Content-Type: audio/x-wav; name=greeting.wavContent-Transfer-Encoding: binaryContent-Disposition: form-data; name="greeting.wav"; filename="greeting.wav"(binary data)
Sets a WAV file as the subscriber's SVC Social Voicemail service greeting message. The WAV file is renamed to name.wav and placed in the subscriber's /onenumber/One_Number/vmbox/name directory.
Administrator or subscriber
POST
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/name
This operation does not submit any parameters, but the HTTP request must include the WAV file to use as a voice name message as an attachment.
POST https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/name HTTP/1.1 Accept-Encoding: gzip,deflate Content-Type: multipart/form-data; boundary="----=_Part_0_20761102.1296024147640"MIME-Version: 1.0User-Agent: Jakarta Commons-HttpClient/3.1Host: 10.182.98.78:9001Content-Length: 231837------=_Part_0_20761102.1296024147640Content-Type: audio/x-wav; name=name.wavContent-Transfer-Encoding: binaryContent-Disposition: form-data; name="name.wav"; filename="name.wav"(binary data)
Uploads a WAV message file. This operation appends the SVC Social Circle One-number prefix to the filename root to create a unique name. For example, if the subscriber with an SVC Social Circle One-number prefix of 123 uploads a files called vm34.wav the uploaded file is named vm34_123.wav.
After uploading, use:
"Get Details for a Social Voicemail Message" to get the message.
"Send a Social Voicemail Message to Other Subscribers" to send this message to other users.
"Modify Social Voicemail Message Public/Private Setting" to make the message available to the public.
Administrator or subscriber
POST
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/message
This operation does not submit any parameters, but the HTTP request must include the WAV file to use as a voice-mail message as an attachment.
This operation returns the following parameters:
messageName: (String) An identifier for the uploaded file created by combining the messages's createtime and onenumber values with this syntax: createtime_onenumber.
POST https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/message HTTP/1.1 Accept-Encoding: gzip,deflate Content-Type: multipart/form-data; boundary="----=_Part_0_20761102.1296024147640"MIME-Version: 1.0User-Agent: Jakarta Commons-HttpClient/3.1Host: 10.182.98.78:9001Content-Length: 231837------=_Part_0_20761102.1296024147640Content-Type: audio/x-wav; name=test.wavContent-Transfer-Encoding: binaryContent-Disposition: form-data; name="message1.wav"; filename="name.wav"(binary data)
HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 43Server: Jetty(8.0.1.0)
[{"messageName":"test_321"}]
Retrieves a list of the publicly-accessible SVC Social Voicemail messages in a subscriber's mailbox.
This operation does not perform authorization checking.
GET
/svc/vmsubscriber/Subscriber_Name/onenumber/One_Number/vmbox/messages/public
Empty
On success the response includes an HTTP 200 OK message, and an array of message names and file locations of each voice-mail message file with an isPublic parameter value of true.
GET https://10.182.98.78:9001/vmsubscriber/alice/onenumber/5556789/vmbox/messages/public HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: 10.182.98.78:9001
|
 Copyright © 2011, 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|