OTP API Documentation

OTP API

OPENSMS SMS API allows you to send and receive SMS messages to and from any country in the world through a REST API. Each message is identified by a unique random ID so that users can always check the status of a message using the given endpoint.

API Endpoint

                                
                                    https://www.opensms.co.ke/api/v3/sms/send

Parameters

Parameter	Required	Description
Authorization	Yes	When calling our API, send your api token with the authentication type set as `Bearer` (Example: `Authorization: Bearer {api_token}`)
Accept	Yes	Set to `application/json`

Send outbound SMS

OPENSMS's Programmable SMS API enables you to programmatically send SMS messages from your web application. First, you need to create a new message object. OPENSMS returns the created message object with each request.

Send your first SMS message with this example request.

API Endpoint

                                
                                    https://www.opensms.co.ke/api/v3/sms/send

Parameters

Parameter	Required	Type	Description
recipient	Yes	string	Number to send message
sender_id	Yes	string	The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. In case of an alphanumeric string, the maximum length is 11 characters.
type	Yes	string	The type of the message. For text message you have to insert `otp` as sms type.
message	Yes	string	The body of the SMS message.
schedule_time	No	datetime	The scheduled date and time of the message in RFC3339 format `(Y-m-d H:i)`

Example request

                                
curl -X POST https://www.opensms.co.ke/api/v3/sms/send \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"31612345678",
"sender_id":"YourName",
"type":"otp",
"message":"This is a test message"
}'

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "sms reports with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

View an SMS

You can use OPENSMS's SMS API to retrieve information of an existing inbound or outbound SMS message.

You only need to supply the unique message id that was returned upon creation or receiving.

API Endpoint

                                
                                    https://www.opensms.co.ke/api/v3/sms/{uid}

Parameters

Parameter	Required	Type	Description
uid	Yes	string	A unique random uid which is created on the OPENSMS platform and is returned upon creation of the object.

Example request

                                
curl -X GET https://www.opensms.co.ke/api/v3/sms/606812e63f78b \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "sms data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

View all messages

API Endpoint

                                
                                    https://www.opensms.co.ke/api/v3/sms/

Example request

                                
curl -X GET https://www.opensms.co.ke/api/v3/sms \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "sms reports with pagination",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}