Custom

Getting Started

You can integrate any custom gateway as a sending server if you have its API details. To do this, enter the API format in the configuration fields.

Configurations

URL

The API endpoint URL.

Method

The HTTP method to use for the request (e.g., GET or POST).

Headers

Add any headers required by the API. You can add multiple headers by clicking Add button.

Example:

Authorization: Bearer uxn13EPebZujZlgzKWhKEjeIu
Content-Type: application/json

Parameters

Add parameters you want to send with the API request. Multiple parameters can be added using the Add button. If your API requires json body, you can set Content-Type header to application/json and use the dot notation for parameter names.

Available Placeholders:

The following placeholders can be used as parameter value. They will be replaced with actual values when sending messages.

{from} — Sender’s phone number or ID
{to} — Recipient’s phone number
{message} — Message body
{attachments} — Comma-separated list of attachment URLs (for MMS/WhatsApp)
{type} — Message type (sms, mms, or whatsapp)

Example:

apiKey: uxn13EPebZujZlgzKWhKEjeIu
sender: {from}
recipient: {to}
text: {message}
media: {attachments}
message_type: {type}

Success Parameter

The JSON response parameter that indicates a successful request. Leave blank if the API uses HTTP status codes to indicate success. This only applies to JSON responses.

If your api response is like below then you can use status as success parameter.

{
    "status": "success",
    "message_id": "1234567890"
}

Success Value

The expected value of the success parameter. If left blank, it defaults to boolean value true. Requires Success Parameter to be set and applies only to JSON responses.

Example:

If your api response is like below then you can use success as success value.

{
    "status": "success",
    "message_id": "1234567890"
}

15 September 2025