ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
VT_API.GetSMSStatus Method

Determines the status of the business' VETtrak SMS service. 

This function checks whether the business has the VETtrak SMS service activated and whether the SMS service is online. If it is set up, it also returns the business' current SMS balance. 

A TAuthSMSStatus object is returned. Refer to the SmsStatus property for the status of the VETtrak SMS service, and the StatusMessage property for more information. The current SMS balance is returned in the SmsBalance property. 

A token is passed for authentication. If the authentication fails, or other errors occur, no data will be returned. The result of the authentication is represented by a TAuthenticate object. 

This function has security level "Protected", and can only be accessed by users that have explicitly been granted permission to the API.

C#
[WebMethod(Description = "Gets the status of the SMS service - whether the SMS service has been activated for this business, and if so, the current message balance")]
public TAuthSMSStatus GetSMSStatus(string token);
Parameters 
Description 
string token 
Mandatory string containing a token. 

TAuthSMSStatus containing the status of the business' VETtrak SMS service

Copyright (c) VETtrak 2022. All rights reserved.