[This is preliminary documentation and is subject to change.]

Delivers a test ringtone or wallpaper to a user's phone via SMS/WAP/MMS. Validates user has properly configured phone and the appropriate data plan to receive mobile content.

Namespace:  PhoneSherpa.Services
Assembly:  App_Code.fxrph_yi (in App_Code.fxrph_yi)
Version: 0.0.0.0

Syntax

C#
public WS..::.SendTestToPhoneResult SendTestToPhone(
	string AccessKey,
	WS..::.UserPhoneInformation UserPhoneInfo,
	int TestType
)
Visual Basic (Declaration)
Public Function SendTestToPhone ( _
	AccessKey As String, _
	UserPhoneInfo As WS..::.UserPhoneInformation, _
	TestType As Integer _
) As WS..::.SendTestToPhoneResult
JScript
public function SendTestToPhone(
	AccessKey : String, 
	UserPhoneInfo : WS..::.UserPhoneInformation, 
	TestType : int
) : WS..::.SendTestToPhoneResult

Parameters

AccessKey
Type: System..::.String
Security key allocated to a developer enabling access to the web service API.
UserPhoneInfo
Type: PhoneSherpa.Services..::.WS..::.UserPhoneInformation
UserPhoneInformation structure containing the user's phone delivery information.
TestType
Type: System..::.Int32
Type of test to send to the phone. 1 = Wallpaper, 2 = Ringtone.

Return Value

Function success or failure.

Remarks

This function should be leveraged in scenarios where the end user is initially signing up for use of a mobile service. It provides validation that the user's phone information, cell phone selection, and carrier is correct. It also, most importantly, validates that the user has the proper data plan to receive mobile content. The main point of customer failure to receive content is that they do not have an active data plan to receive mobile content. Providing a button or similar UI mechanism for user's to test thier phone before purchasing content is a great way to reduce customer service requests for non-delivery or non-compatible phones.

The test content is formated specifically for the user's phone model. The test content is also DRM protected using OMA 2.0 forward locking, if the phone model supports this feature. GCD and similar content wrappers are automatically generated for carriers that require them.

Any given phone number is limited to receiving a combination of 20 tests or content links sent to them per 24 hour period. This is to prevent fraud situations. Functions that trip the 20 usage meter in a 24 hour period will still return function success, however.

Below is an example of how to use this function:

CopyVB.NET
Function SendTestRingtone(ByVal UserPhoneNumber As String, ByVal CountryID As Integer, ByVal CarrierID As Integer, ByVal PhoneModelID As Integer) As String
    Dim SherpaService As New PhoneSherpa.Services.WS
    'Phone Sherpa services use a standard structure for passing phone delivery information.
    Dim UserPhoneInfo As New PhoneSherpa.Services.UserPhoneInformation

    UserPhoneInfo.CarrierId = CarrierID
    UserPhoneInfo.CountryId = CountryID
    UserPhoneInfo.EmailAddress = ""
    UserPhoneInfo.PhoneModelId = PhoneModelID
    UserPhoneInfo.PhoneNumber = UserPhoneNumber

    Dim SendTest_Response As PhoneSherpa.Services.SendTestToPhoneResult = Nothing

    SendTest_Response = SherpaService.SendTestToPhone("My_WSAccessKey", UserPhoneInfo, 2)

    If SendTest_Response.Result.ErrorCode = 0 Then
        'Function succeeded
        Return "Success"
    Else
        'error - failed validating user information or delivery of the test failed
        'Display validation specific failures to the user.  
        'Merchant code should use thier own messaging rather than the raw error message in the response
        Return SendTest_Response.Result.ErrorMessage
    End If
End Function

See Also