Siptalk API Getting Started / Test Endpoint

Navigation

General Description

The test endpoint will allow you to test your authentication process and confirm you can access the API successfully.

API URL

https://api.siptalk.com.au/test/

Required Fields

Field Description
apikey The API key created in the portal.
apisecret The API secret created in the portal.

Optional Fields

Field Description
badrequest Can be any non-empty value, including this will make the API return a 400 Bad Request header.
notfound Can be any non-empty value, including this will make the API return a 404 Not Found header.
ratelimit Can be any non-empty value, including this will make the API return a 429 Too Many Requests header.
servererror Can be any non-empty value, including this will make the API return a 500 Internal Server Error header.
denied Can be any non-empty value, including this will make the API return a 550 Permission Denied header.
sandbox Can be any non-empty value, including this will make classify the request as readonly and no changes will be made to the system.

Response Fields

Field Type Value Description
message text hello world Always returned

Success Response

The test endpoint will return a message containing 'hello world' if successful.

{
    "message": "hello world"
}

If you included the optional sandbox field.

{
    "message": "hello world"
    "sandbox": "yes"
}