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

Takes an internal source file within the Phone Sherpa system and returns a public URL to that file for external consumption.
**This function incurs a 1 credit usage charge.

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

Syntax

C#
public WS..::.ResolveContentHandleResult ResolveContentHandle(
	string AccessKey,
	string SourceFile
)
Visual Basic (Declaration)
Public Function ResolveContentHandle ( _
	AccessKey As String, _
	SourceFile As String _
) As WS..::.ResolveContentHandleResult
JScript
public function ResolveContentHandle(
	AccessKey : String, 
	SourceFile : String
) : WS..::.ResolveContentHandleResult

Parameters

AccessKey
Type: System..::.String
Security key allocated to a developer enabling access to the web service API.
SourceFile
Type: System..::.String
Internal source file name within Phone Sherpa system. Expressed as a random and unique file name without a path.

Return Value

A public URL to the published internal source file. The developer can then access and download this file for other purposes.

Remarks

ResolveContentHandle takes any internal source file name and makes it available for download via a public URL. Internal source files are not accessible outside of the Phone Sherpa system. They are used as the source for editing, content delivery, and are the result of editing. If a developer needs to get download one of these files back into thier system for use, such as to store it for later or offer some other custom delivery/billing mechanism, then ResolveContentHandle provides public access to the internal source file.

Files are available for pickup via the URL response for a period of 24 hours. After this time, the pubished files are removed from the public pickup location. This location is not indended to be a mechanism to host files indefinately.

This function incurs a 1 credit usage charge. Prepay customers must have credits in thier account to successfully call this function. Postpay customers will be metered 1 credit on thier monthly billing statement for each call to this function.

Below is an example of how to use this function:

CopyVB.NET
Public Function GetFileFromPhoneSherpa(ByVal SourceFile As String) As String
    Dim SherpaService As New PhoneSherpa.Services.WS
    Dim URL As String = ""

    Dim ResolveContent_Response As PhoneSherpa.Services.ResolveContentHandleResult = Nothing

    ResolveContent_Response = SherpaService.ResolveContentHandle("My_WSAccessKey", SourceFile)

    If ResolveContent_Response.Result.ErrorCode = 0 Then
        'Use the returned user phone information for whatever you need
        URL = ResolveContent_Response.Url

        'return the URL to the source file or do other app specific processing (such as downloading the file) here
        Return URL
    Else
        'error - failed resolving the source file
        Return ResolveContent_Response.Result.ErrorMessage
    End If
End Function

See Also