Send

Send

POST https://api.simpu.co/sms/send

This endpoint is for sending an outbound message.

Headers

NameTypeDescription

Authorization*

string

Simpu API key to authenticate the request.

Request Body

NameTypeDescription

recipients*

string

Recipients phone number, to send to multiple users separate each phone number with a comma

content*

string

Specifies the message you want to send to the recipients

channel

string

The route to send the sms through

Options: sms, WhatsApp Default: sms

channel_id

String

Generated channel_id learn more

callback

String

This is an endpoint supplied by you, the developer so that we can send a post request of the final status of the sms. SMS final status code

external_ref

String

This is a reference supplied by you, the developer that identifies the sms

{
    "status": 200,
    "type": "success",
    "message": "Successful",
    "data": {
        "message": {
            "created_datetime": "2023-07-13T06:50:08.199",
            "organisation_id": "af02ac6f8bc711ebbd939a88eb4ca9b7",
            "user_id": "0",
            "recipients": [
                "2348012345678"
            ],
            "content": "Hello! World",
            "external_aggregate_ref": "<EXTERNAL_REF>",
            "is_trackable": false,
            "callback": "http://acme.com",
            "id": "e9002b7725024cf8b0a40223a8533"
        }
    }
}

Last updated