API Function Library

This is the list of functions available in the ByRSVP API.

Notes:

• All parameters are mandatory unless they are marked as optional.
• The API Key (for functions that require this parameter for authentication and authorization purposes, needs to be created from My Account → Business Services → Access Control. It is not the same as the Email Key.
• The function documentation below may not list every possible return status code. Generic meanings of status codes that functions may return is documented in Function Return Values.

rsvpHelloWorld

This is a simple HelloWorld function for testing your application access to our API.

This is a simple test function that you can use to test your application's access to our API. This function always returns a 200 status code.

If called without any parameters, the return text will be OK. If the message paramter is provided, the paramter value will be echoed back in the return text.

rsvpSendSMS

This is the function for sending SMS messages. Do NOT use this for sending Unsolicited Bulk Messages.

This function is used for submitting a SMS message for transmission to a recipient mobile phone.

You need to ensure that the specified phone number is valid and is capable of accepting SMS messages. Our system does some simple syntax checks on the number, but will not be able to determine if the phone number is actually valid or not. Once our system accepts the message, credits are deducted, whether or not the SMS message was actually capable of being delivered.

This function is NOT to be used for sending Unsolicited Bulk Messages. It is a violation of ByRSVP's Terms and Conditions to send Unsolicited Bulk Messages through our API.

rsvpCheckCredits

This function returns the number of credits remaining for the credit type specified.

This function is used for determining the number of credits remaining for the credit type specified.

Upon success, the function returns status code 200, and the number of credits in the extra values field.