Keed SMS - API Documentation

API Documentation

Explore our flexible SMS APIs to Integrate in your own applications

Welcome to the Keed SMS API documentation! This guide provides developers with all the information they need to integrate Keed SMS's messaging service into their applications.

Keed SMS allows you to programmatically send SMS messages to individual recipients or groups. This API is ideal for businesses that need to automate SMS communication for marketing campaigns, appointment reminders, or other notifications.

Getting Started

Before diving into the API functionalities, you'll need a Keed SMS account. Sign up for an account to obtain your API key and secret. These credentials are required to authenticate your API requests.

Base URL

https://api.keedsms.com/gw/v1/

Authentication

All API requests require authentication using an API key and secret. Obtain these credentials by signing up for a Keed SMS account.

Content-Type: application/json
X-Api-Key: "api-key"
X-Api-Secret: "api-secret"

Send SMS

This endpoint is used to send SMS messages to multiple recipients.

Endpoint

POST /sms/send

Request Body

{
    "recipients": 
        "2332XXXXXXXX",
        ...
    ],
    "message": "message_content",
    "sender": "sender_id"
}

    
          Parameter
          Type
          Description
        
          recipients
          array
          An array of phone numbers to send SMS to
        
          message
          string
          The content of the SMS message
        
          sender
          string
          The sender ID (alphanumeric or numeric)

Parameter	Type	Description
recipients	array	An array of phone numbers to send SMS to
message	string	The content of the SMS message
sender	string	The sender ID (alphanumeric or numeric)

Response

{
    "succeeded": true/false,
    "messages": [
        {
        "code": "status",
        "message": "response_message"
        }
    ]
}

    
          Field
          Type
          Description
        
          succeeded
          boolean
          Indicates whether the SMS was sent successfully (true or false)
        
          message
          array
          An array of objects containing the status of each SMS sent
        
          code
          string
          The status code of the SMS
        
            message
            string
            A message describing the SMS status

Field	Type	Description
succeeded	boolean	Indicates whether the SMS was sent successfully (true or false)
message	array	An array of objects containing the status of each SMS sent
code	string	The status code of the SMS
message	string	A message describing the SMS status

Example Request

curl -X POST \
https://api.keedsms.com/gw/v1/sms/send \
-H 'Content-Type: application/json' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET' \
-d '{
"recipients": ["2332XXXXXXXX", "2332YYYYYYYY"],
"message": "Hello from Keed SMS!",
"sender": "KeedSMS"
}'

Example Response

{
    "succeeded": true,
    "messages": [
        {
            "code": "200",
            "message": "Message sent successfully"
        }
    ]
}

    Error Codes
    
          Code
          Description
        
          200
          Success request
        
          400
          Bad request
        
          401
          Unauthorized request