Fast Message APIs
Home
Getting Started
Home
Getting Started
  • SMS API
    • Send SMS
    • Bulk SMS
    • Send Hashed SMS
    • Send OTP
    • Delivery Reports
    • Delivery Status Descriptions
    • SMS Balance
    • Common Errors
    • Response Codes
  • RESELLER SMS CREDIT API
  • USSD GUIDE
  • SHORTCODE GUIDE
  • SMPP API
  • AIRTIME API
  • EMAIL API

SHORTCODE GUIDE

The Shortcode Guide provides instructions for setting up an endpoint that we will configure on the client's shortcode.

Info

Clients must first acquire a dedicated or shared shortcode from us before proceeding with the setup.

Setting Up Your Endpoint

Once you have acquired a shortcode, you need to provide an endpoint that accepts POST requests. This endpoint should be able to handle the following parameters:

ParameterDescription
shortcodeThe assigned shortcode.
mobileThe recipient's phone number.
messageThe message content.
Additional ParametersIf required, share any extra details such as authentication keys or specific request headers.

Sample Payload

Below is an example of the JSON payload that will be sent to your endpoint:

{
  "shortcode": "12345",
  "mobile": "2547XXXXXXXX",
  "message": "Hello, this is a test message."
}

Tips

Ensure your endpoint is capable of handling and processing these requests efficiently.

Prev
USSD GUIDE
Next
SMPP API