Questions? Feedback?

Introduction


Kedesa Api Documentation

Welcome to Kedesa API Documentation

The kedesa API allows you to use services Kedesa Inc offers in a simple, programmatic way using conventional HTTP requests. The endpoints are intuitive and powerful, allowing you to easily make calls to execute actions and to retrieve information.

All of the functionality that you are familiar with in the Kedesa control panel is also available through the API, allowing you to script the complex actions that your situation requires.


Base Url: https://www.kedesa.com/api/v1

Content-Type: application/json.

Accept header: application/json.

Thank You

Note:
● All parameters are required unless otherwise stated.

Sending SMS


Sending an SMS is one of the most common tasks performed on the Kedesa Platform.

Method: POST

Endpoint: /sms/sendsms

Parameters:

Field Type Description
api_key String API key gotten from your dashboard
api_secret String API Secret gotten from your dashboard
source String Message Sender ID
destination String Mobile Number to which to Send message to (may or may not include country code), multiple mobile numbers should be separated by commas
message String Message Sender ID

Request Sample:

{
    "api_key": "******",
    "api_secret": "*************",
    "source": "Kedesa",
    "destination": "2348068810228",
    "message": "Demo Message"
}
                

Sample POST Response:

{
    "status": "1701",
    "mobile": "2348012345678",
    "message_id": "63370fc3-0793-4635-8f70-726e1a6be9eb"
}
                

Status Codes:

Response Description
1701 Message Submitted Successfully
1702 Invalid URL Error, This means that one of the parameters was not provided or left blank
1703 Invalid value in username or password field
1709 User validation failed
1710 Internal Error
1025 Insufficient Credit
1715 Response Timeout

Note:
● Along with the above errors codes, standard SMPP v3.4 error codes may also be returned where applicable.
● Apart from 1709, Please DO NOT RETRY re-sending the message for any other error code (including SMPP v3.4 Error codes ).
● For 1715, Do not re-submit the same message back again.

SMS Delivery Response


Sending an SMS is one of the most common tasks performed on the Kedesa Platform.

Method: GET

Endpoint: /sms/getsmsstatus/@message_id

Parameters:

Field Type Description
message_id String Message ID of sms sent via the HTTP URL.

Response Sample:

DELIVRD

Response Codes:

Response Description
DELIVRD Message delivered to handset
UNDELIVRD Message is Undeliverable
REJECTED Message REJECTD
EXPIRED Message validity period expired, before any successful tries of submission
UNKNOWN Anything could have happened

Missed Call Verification/ Reverse Caller ID


This simple but powerful verification is made by intercepting a missed call from a random number allowing you to verify a user with a seamless user experience that removes the pin-entry on Android and reduces signup friction.

Method: POST

Endpoint: /voice/missedcallverification

Parameters:

Field Type Description
api_key String Api Key gotten from the dashboard
api_secret String API Secret gotten from the Dashboard.
destination Number Mobile Number to be verified with missed call.
token (Optional) Number Verification Token, will be the last (4 - 6) digits

Request Sample:

{
    "api_key": "******",
    "api_secret": "*************",
    "destination": "23412345678",
    "token": "12345"
}
                

Response Sample:

{
  "status": {
    "code": 100,
    "desc": "making call to 2348012345678"
  },
  "entity":  {
    "caller_id":"01440843012345",
    "call_id":"513121242434343434323"
  }
}

Response Codes:

Response Description
100 Call Delivered Successfully
120 Something happened, the call did not deliver

Note:
● The call_id is used to fetch the status of the call.

Support


We will be glad to help you if you have any questions relating to this API Documentation. If you have any queries, please feel free to contact us at Support Center.

Email Us at : [email protected]