Salesforce UX API

(0 reviews)

TMF629-VoiceMailServiceTowardsVMS

Update VMS (voice-mail) status

This operation updates Voice mail service entity

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

http://[localhost]:[port]/sfdc-ux/v1/{businessId}/customer/id

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code	Y
id	string	unique identifier to identify the customer/user	Y

name	value	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction Minimum characters: 1 Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	Y
targetSystem	string	target system in which the customer details are getting updated. Expected value for VMS user update is "VMS"	Y

Body

VMS user update request:

{
    "engagedParty": {
        "id": "123",
        "@referredType": "Individual"
    },
    "status": "active",
    "characteristic": [
        {
            "name": "language",
            "value": "eng"
        },
        {
            "name": "pin",
            "value": "1234"
        },
        {
            "name": "visualVM",
            "value": "false"
        },
        {
            "name": "mwnBearers",
            "value": "MWI"
        }
    ]
}

Definitions:

Each of the request parameters is detailed.

VMS User update request definitions:

Each of the request parameters is detailed.

name	type	description	required
engagedParty	object	user details	O
engagedParty.id	String	user's ID	O
engagedParty.@referredType	String	type of the class	O
characteristic	array	array of name value pairs. name represents the variable name and the value represents the value of the variable. All charcteristic names and values are strings.	Y
characteristic.language	String	New language for Voice Mail account. The values can be "eng", "spa" or "fre".	Y*
characteristic.pin	String	New personal access code for Voice Mail account.	Y*
characteristic.visualVM	String	New value for Visual Voice Mail feature flag. The values can be either "true" or "false".	O
characteristic.mwnBearers	String	New message waiting notification (MWN) bearers authorized for this account.	O
status	String	New Voice Mail account state. The value can be either "active" or "inactive".	Y*

Note: One of the fields status, language or pin is mandatory (marked as Y*). The payload can contain more than one fields or all fields.

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - customer update request processed successfully.

VMS Response Body

{
    "id": "0000",
    "description": "Successful method execution."
}