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. Shared shortcodes will always be configured using keywords.

Setting Up Your Endpoint

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

Non-interactive Shortcode

Parameter	Description
shortcode	The assigned shortcode.
mobile	The recipient's phone number.
message	The message content.
Custom	Extra details such as authentication keys or headers, if required.

Interactive Shortcode

Parameter	Description
shortcode	The assigned shortcode.
msisdn	The recipient's phone number.
message	The message content.
partnerId	The SMS Account Id.
Custom	Extra details such as authentication keys or headers, if required.

Sample Payload

GET

Non-Interactive Shortcode:

https://{{yourCallBack}}?shortcode=12345&mobile=2547XXXXXXXX&message=JOIN

Interactive Shortcode:

https://{{yourCallBack}}?shortcode=12345&msisdn=2547XXXXXXXX&message=JOIN&partnerId=XYZ123

POST

Non-Interactive Shortcode:

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

Interactive Shortcode:

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

Tips

• Ensure your endpoint is capable of processing requests efficiently. Our timeout is 15 seconds.
• You can return an auto-response that we will send via your SMS account, or trigger responses using the SMS API.
• If using the auto-response option, inform us so we can enable it on our side.