Function Return Values
All ByRSVP API functions return results to the caller in the form of a result string. Each result string contains:
- A numeric status code
- Optionally an extra values field contained in square brackets
- Descriptive text of the result
Some examples of the return values are:
200 OK 202 [15443] Message accepted
Status Codes
The status codes returned by ByRSVP API functions are similar to those used in HTTP and SIP protocols. They are numbers in the following ranges:
- 200-299: Generally means success.
- 400-499: Some client-side error (i.e. caller).
- 500-599: Some error that occurred on the server-side.
Each API function lists the specific meanings of the status codes that it may return. But in general, the following status codes can be returned by any API functions.
| Status Code | Description |
|---|---|
| 200 | This is a general OK status message to mean that the function has succeeded. |
| 400 | Something is wrong with the function call. For example, a required parameter was not specified. |
| 401 | Request is unauthorized. This means the API Key was not supplied when it was needed for authorization, or that the API Key supplied is invalid. |
| 403 | Request is forbidden. This means that the API Key supplied corresponds to an account that is not permitted to make the request. |
| 500 | An internal error occurred on the server. |
If the API function description does not document a specific code, the meanings in the above table applies.
Extra Values Field
The purpose of the extra values field is to return additional information to the caller. This happens when the function needs to return more information than Status Codes on their own can convey.
For example, when a SMS message has been accepted for transmission, the rsvpSendSMS function needs to inform the caller of the SMS Send ID. This ID is needed by the caller to subsequently request additional information on this message.
When extra values are returned, they are contained in square backets. If there is more than one extra values to be returned, they are space separated in the extra values field.