Documentation for the functions available in the SMS WebService
Description: This function checks the balance of the user based on their provided username and password.
WebMethod: Balance
Input Parameters:
- username (String): The username of the user for whom the balance is to be checked.
- password (String): The password associated with the provided username.
Return Value:
- String: The balance amount in the user's account formatted as "###0.00", or an error message starting with "ERR" if the username or password is invalid.
Description: This function creates a new group for the user and associates it with the provided username and password.
WebMethod: CreateGroup
Input Parameters:
- username (String): The username of the user creating the group.
- password (String): The password associated with the provided username.
- GroupName (String): The name of the group to be created.
Return Value:
- String: The ID of the newly created group, or an error message starting with "ERR" if the username or password is invalid.
Description: This function adds a new contact to a specific group for the user based on the provided information.
WebMethod: CreateContact
Input Parameters:
- username (String): The username of the user adding the contact.
- password (String): The password associated with the provided username.
- Groupid (String): The ID of the group to which the contact will be added.
- ContactName (String): The name of the contact to be added.
- ContactNumber (String): The phone number of the contact to be added.
Return Value:
- String: The Group ID of the contact that was added, or an error message starting with "ERR" if the username or password is invalid.
Description: This function checks the delivery status of a message based on the provided message ID (msgid).
WebMethod: Delivery
Input Parameters:
- msgid (String): The ID of the message for which the delivery status is to be checked.
Return Value:
- String: The delivery status of the message (e.g., "Delivered", "Failed", "Buffered", etc.), or an error message if the message ID is invalid.
Description: This function sends an SMS message on behalf of the user using the provided information.
WebMethod: SendSMS
Input Parameters:
- username (String): The username of the user sending the SMS.
- password (String): The password associated with the provided username.
- Sender (String): The sender's name or number for the SMS.
- ToNumber (String): The recipient's phone number for the SMS.
- Message (String): The content of the SMS message.
- DelayUntil (String): Optional parameter specifying a delay until which the message should be sent (if provided).
Return Value:
- String: The response from the SMS service indicating the status of the SMS delivery.
Description: This function checks if a user exists based on the provided username.
WebMethod: CheckIfUserExists
Input Parameters:
- username (String): The username to be checked.
- key (String): A security key for authentication.
Return Value:
- String: "True" if the user exists, "False" if the user does not exist, or "Bad key" if the security key is invalid.
Description: This function checks the balance of a user based on the provided username and password.
WebMethod: CheckUserBalance
Input Parameters:
- username (String): The username of the user for whom the balance is to be checked.
- password (String): The password associated with the provided username.
- key (String): A security key for authentication.
Return Value:
- String: The balance amount in the user's account formatted as a string, or "False" if the username, password, or security key is invalid.
Description: This function retrieves the list of groups associated with a user.
WebMethod: ViewGroups
Input Parameters:
- username (String): The username of the user for whom the groups are to be retrieved.
- password (String): The password associated with the provided username.
- key (String): A security key for authentication.
Return Value:
- String: A string containing the IDs and names of the groups associated with the user, or an error message if the username, password, or security key is invalid.
Description: This function retrieves the list of contacts associated with a specific group for a user.
WebMethod: ViewContacts
Input Parameters:
- username (String): The username of the user for whom the contacts are to be retrieved.
- password (String): The password associated with the provided username.
- GroupID (String): The ID of the group for which contacts are to be retrieved.
Return Value:
- String: A string containing the names and mobile numbers of the contacts in the specified group, or an error message if the username or password is invalid.
Description: This function adds a new user to the system with the provided information. The user's account will be created in the "sms" database table.
WebMethod: AddUser
Input Parameters:
- username (String): The desired username for the new user.
- Epomumia (String): The name of the user.
- address (String): The user's address.
- city (String): The city where the user resides.
- email (String): The email address of the user.
- mobile (String): The user's mobile phone number.
- key (String): A security key for authentication.
- Device (String): The device from which the user is being added (optional).
Return Value:
- String: A status message indicating the result of the user creation process.
Description: This function sends user credentials (username and password) via SMS to the provided mobile number.
WebMethod: RemindByPhone
Input Parameters:
- mobile (String): The user's mobile phone number to which the credentials will be sent.
- key (String): A security key for authentication.
Return Value:
- String: A status message indicating whether the credentials were sent successfully or if there was an error.
Description: This function sends user credentials (username and password) via email to the provided email address.
WebMethod: RemindByEmail
Input Parameters:
- email (String): The user's email address to which the credentials will be sent.
- key (String): A security key for authentication.
Return Value:
- String: A status message indicating whether the credentials were sent successfully or if there was an error.