API Docs

  • Introduction

    Jusibe API allows you interact with your account in Jusibe. It is a simple REST API that allows you to send SMS, check your SMS credit balance and check the delivery status of a sent SMS.

  • Client Libraries

    Below are links to community developed libraries, extensions and plugins that will make integrating Jusibe into your apps and sites easier.

  • Jusibe API Endpoint


    Base URL

    The Web API Base URL is https://jusibe.com/smsapi/

  • Authentication

    All requests needs to be authenticated using HTTP Basic Authentication.

    You need to authenticate using your public key as the username and your access token as the password.

    Your public key and access token can be seen in the API Keys page in your Control Panel.

  • Response Format & Status Code.

    A JSON response is sent back by the Jusibe SMS API for every request

    • Successful requests will return a 200 OK HTTP status code
    • Trying to authenticate with an invalid public key or access token will return a 401 Unauthorized HTTP status code
    • All other unsuccessful requests will return a 400 Bad Request HTTP status code


  • Available Endpoints

    Five endpoints are available for use in Jusibe API.

    1. /send_sms - for sending a message to a single mobile number (Single SMS)
    2. /bulk/send_sms - for sending a message to multiple mobile numbers (Bulk SMS)
    3. /get_credits - for retrieving your available SMS credits
    4. /delivery_status - for checking the delivery status of a single sent message (Single SMS)
    5. /bulk/status - for checking the status of a sent bulk message (Bulk SMS)
  • 1. Send Single SMS

    The /send_sms endpoint allows you to send a message to a single mobile number using the Jusibe API.

    URL: https://jusibe.com/smsapi/send_sms

    METHOD: POST

  • Parameters

    • to: (Required) This is the Nigerian GSM number you are sending the SMS to. You are to pass a single GSM number.
    • from: (Required) This is the Sender ID for the SMS that is being sent, maximum of eleven (11) characters. A mobile number or any combination of numbers is not allowed as the Sender ID. You can always use any alphanumeric or alphabetic characters as the Sender ID.
    • message: (Required) This is the text message that you want to send
  • Response

    {
    	"status": "Sent",
    	"message_id": "xeqd6rrd26",
    	"sms_credits_used": 1
    }
  • 2. Send Bulk SMS

    The /bulk/send_sms endpoint allows you to send a message to multiple mobile numbers (Bulk SMS) using the Jusibe API.

    URL: https://jusibe.com/smsapi/bulk/send_sms

    METHOD: POST

  • Parameters

    • to: (Required) This is a comma , separated list of Nigerian GSM numbers you are sending the SMS to. Example: 08033333333,08044444444,08055555555
    • from: (Required) This is the Sender ID for the SMS that is being sent, maximum of eleven (11) characters. A mobile number or any combination of numbers is not allowed as the Sender ID. You can always use any alphanumeric or alphabetic characters as the Sender ID.
    • message: (Required) This is the text message that you want to send
  • Response

    {
    	"status": "Submitted",
    	"bulk_message_id": "xeqd6rs3d26"
    }
  • 3. Check SMS Credits

    The /get_credits endpoint allows you to get the available SMS credits left in your Jusibe account

    URL: https://jusibe.com/smsapi/get_credits

    METHOD: GET

  • Response

    {
    	"sms_credits": "182"
    }
  • 4. Check Single Message Delivery Status

    The /delivery_status endpoint allows you to check the delivery status of a message sent to a single phone number (Single SMS)

    URL: https://jusibe.com/smsapi/delivery_status

    METHOD: GET

    Paramaters

    • message_id: (Required) The message ID that was returned when the SMS was sent initially
  • Response

    {
    	"message_id": "xeqd6rd268",
    	"status": "Delivered",
    	"date_sent": "2015-05-19 04:34:48",
    	"date_delivered": "2015-05-19 04:35:05"
    }
  • 5. Check Bulk Message Status

    The /bulk/status endpoint allows you to check the status of a message sent to multiple mobile numbers (Bulk SMS)

    URL: https://jusibe.com/smsapi/bulk/status

    METHOD: GET

    Paramaters

    • bulk_message_id: (Required) The bulk message ID that was returned when the bulk SMS was sent initially
  • Response

    {
        "bulk_message_id": "xeqd6rs3d26",
        "status": "Completed",
        "created": "2019-04-02 15:23:13",
        "processed": "2019-04-02 15:25:03",
        "total_numbers": "2",
        "total_unique_numbers": "2",
        "total_valid_numbers": "2",
        "total_invalid_numbers": "0"
    }
  • Test API

    Click on the Run In Postman button below to test the API in Postman