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

 

Classes

  ClassDescription
Public classWS
The WS class contains all the Phone Sherpa Platform API web service methods for content upload, editing, publishing, and delivery.
Public classWS..::.Carrier
A supported carrier within the Phone Sherpa system. A supported carrier is one which Phone Sherpa can send messages to the carrier's subscribers' phones.
Public classWS..::.Country
A supported country within the Phone Sherpa system. Supported countries have at least 1 active carrier associated with it.
Public classWS..::.EditAudioContentResult
Return structure from the EditAudioContent(...) method.
Public classWS..::.ErrorResponse
This structure is returned in every web service response object. It provides a standard way to report errors and success of the function call.
Public classWS..::.GetCarrierListResult
Return structure from the GetCarrierList(...) method. Contains a list of carriers supported by Phone Sherpa for a given country.
Public classWS..::.GetContentDownloadInstructionsResult
Return structure from the GetContentDownloadInstructions(...) method. Contains a list of install instructions for a given phone model.
Public classWS..::.GetCountryListResult
Return structure from the GetCountryList(...) method. Contains a list of countries supported by Phone Sherpa.
Public classWS..::.GetPhoneModelListResult
Return structure from the GetPhoneModelList(...) method. Contains a list of phone models supported by Phone Sherpa.
Public classWS..::.GetPostFileInfoResult
Return structure from the GetPostFileInfo(...) method.
Public classWS..::.GetRingtoneEditorFilesResult
Return structure from the GetRingtoneEditorFiles(...) method. Gives public URLs to audio playback and waveform image files.
Public classWS..::.GetStateProvinceListResult
Return structure from the GetStateProvinceList(...) method. Contains a list of states or provinces supported by Phone Sherpa for a given country.
Public classWS..::.LoadFileFromUrlResult
Return structure from the LoadFileFromUrl(...) method.
Public classWS..::.PhoneModel
A supported phone model within the Phone Sherpa system. Supported phone models meet the following requirements: support true tone audio, color main display, internet enabled (with proper data plan).
Public classWS..::.PublishContentResult
Return structure from the PublishContent(...) method. Contains URLs to phone download ready content files, which are files that are friendly named, DRM forward locked, metadata wrapped (if required), and available via secured URL paths per carrier requirements.
Public classWS..::.ResolveContentHandleResult
Return structure from the ResolveContentHandle(...) method. Contains a publically accessible URL to the requested internal SourceFile.
Public classWS..::.SendContentToPhoneResult
Return structure from the SendContentToPhone(...) method.
Public classWS..::.SendTestToPhoneResult
Return structure from the SendTestToPhone(...) method.
Public classWS..::.State
A supported state or province within the Phone Sherpa system. These values are only used for credit card billing API functions.
Public classWS..::.UserPhoneInformation
A summary of required information from the user to edit and deliver content to thier phone. This structure is used in several API function calls dealing with editing and content delivery.
Public classWS..::.ValidatePhoneNumberResult
Return structure from the ValidatePhoneNumber(...) method. Contains a properly formatted and validated international phone number.
Public classWS..::.ValidateUserPhoneInformationResult
Return structure from the ValidateUserPhoneInformation(...) method. Contains a properly formatted and validated international phone number and ensures all other phone delivery information parameters are set properly..
Public classWS..::.WaveFormInformation
Structure used to define the waveform image dimensions and colorization for the GetRingtoneEditorFiles(...) method.