SMS API ​

This API provides SMS service to authorized users with valid API key. The API allows users to send SMS messages, retrieve a list of available devices, check the status of a specific SMS message, and retrieve received SMS messages.

Base URL: https://api.webtender.host

Authentication ​

All API endpoints require authentication using a valid API key. The API key can be passed in the query parameter or in the request body as api_key. Unauthorized requests will result in an HTTP 401 status code with a corresponding error message.

Get your API key from the WebTender Console.

Send SMS Message ​

Send an SMS message using the SMS service.

Request ​

POST /api/sms/send

Request Headers ​

Request Body ​

Response ​

Success Response ​

Code: 200 OK

Body:

{
    "message_id": "<string>"
}

{
    "message_id": "<string>"
}

Error Response ​

Code: 401 Unauthorized

Body:

{
    "error": "Invalid API Key"
}

{
    "error": "Invalid API Key"
}

Code: 403 Forbidden

Body:

{
    "error": "Cannot use SMS Service"
}

{
    "error": "Cannot use SMS Service"
}

Code: 422 Unprocessable Entity

Check the phone_number is a valid NZ or AU and the message provided.

Body:

{
    "errors": {
        "phone_number": [
            "The phone number field is required."
        ],
        "message": [
            "The message field is required."
        ]
    }
}

{
    "errors": {
        "phone_number": [
            "The phone number field is required."
        ],
        "message": [
            "The message field is required."
        ]
    }
}

Code: 500 Internal Server Error

Uh oh! This likely caused by a service outage on our end, or if your account has been blocked due to service abuse

Body:

{
    "error": "No devices available to send messages"
}

{
    "error": "No devices available to send messages"
}

Check a message's status ​

Get the status of an SMS message by ID.

Request ​

GET /sms/status/{messageId}

Request Parameters:

JSON Response:

Status: 200 OK

Status Codes: