POST

Send

POST https://sms.hollatags.com/api/send This endpoint allows you to send SMS Message.

The POST parameters should be sent as x-www-form-urlencoded

Properties

  • Name
    user
    Type
    string
    Description

    Account username.

  • Name
    pass
    Type
    string
    Description

    Account Password.

  • Name
    from
    Type
    string
    Description

    SMS SenderID input must be no more than 11 characters for alphanumeric values and no more than 16 characters for numerical values.

  • Name
    to
    Type
    string
    Description

    Phone number must be in international format and no prefix e.g 2348030000000, Separate with comma if you are sending to multiple recipients (e.g 234805*,234803*)

  • Name
    msg
    Type
    string
    Description

    SMS Message Content (must not exceed 905 chars)

  • Name
    type
    Type
    string
    Description

    Message Format 0 = Normal SMS, 1 = Flash SMS, 2 = Unicode SMS (Arabic, Chinese etc)

  • Name
    callbackURL
    Type
    string
    Description

    If specified, sms status notifications would be sent to this URL by HTTP POST. You can include paths in the url but all query parameters are ignored.

  • Name
    enable_msg_id
    Type
    bolean
    Description

    If TRUE, the API response will contain a unique message_id for your sms Sample response 2348030000000, 24137cf8-eccc-469c-80af-109538857e53 Tilde () will be used to separate multiple destination numbers. e.g 2348030000000, 42138969-09f9-434d-a3c6-db5733fba7362348030000011,974790b3-e598-41a8-939b-772d16860fb4

  • Name
    message_uuid
    Type
    string
    Description

    This serves as the idempotency unique client message reference ID for safely retrying failed or timeout requests without accidentally executing the same transaction twice. (automatically expire after 30days) (Length is 24 to 64 characters ) We suggest the reference ID should be a V4 UUIDs (e.g 58c0d0f9-7dc6-4ce0-91ae-2d84c5880713), or another random string that can guarantee uniqueness to avoid collisions.

Only sms_message is required in your json response. You do not need to define sms_from or sms_to. Your sms_message will by default go to the originating mobile number i.e the current session sms_to.

Request

POST
  curl --location 'https://sms.hollatags.com/api/send' \
        --header 'Content-Type: application/x-www-form-urlencoded' \
        --data-urlencode 'user={USERNAME}' \
        --data-urlencode 'pass={PASSWORD}' \
        --data-urlencode 'from=API_COMPANY' \
        --data-urlencode 'to=2347000000000' \
        --data-urlencode 'msg=Hello, This is a test' \
        --data-urlencode 'type=0' \
        --data-urlencode 'callback_url=https://ClientApplicationURL.com/' \
        --data-urlencode 'enable_msg_id=1' \
        --data-urlencode 'message_uuid=f3930050-9fce-4e07-9859-9ec24d8c511f'

Response

200 OK
sent
POST

Receive

To use this feature, you will need to purchase an inbound (MO) shortcode or longcode number. Then provide us with your URL for the inbound (MO) 2way messages.

All incoming messages from your shortcode would be routed to your provided URL.

  • Name
    sms_from
    Type
    integer
    Description

    Originating mobile.

  • Name
    sms_to
    Type
    string
    Description

    Your short or longcode number.

  • Name
    sms_message
    Type
    string
    Description

    SMS message content.

Only sms_message is required in your json response. You do not need to define sms_from or sms_to. Your sms_message will by default go to the originating mobile number i.e the current session sms_to.

Request

POST
  curl --location 'http://ClientSMSChatURL.com/' \
        --header 'Content-Type: application/x-www-form-urlencoded' \
        --data-urlencode 'sms_from=2347000000000' \
        --data-urlencode 'sms_to=2348000000000' \
        --data-urlencode 'sms_message=Hello, This is a test'

Response

200 OK
{"sms_message":"Thank you"}
POST

Status

POST https://sms.hollatags.com/api/report/ This endpoint allows you to check the delivery status of the messages sent. You will need to enable the parameter enable_msg_id at the time of sending the SMS via https://docs.hollatags.com/send The POST parameters should be sent as x-www-form-urlencoded

  • Name
    user
    Type
    string
    Description

    Account username.

  • Name
    pass
    Type
    string
    Description

    Account password.

  • Name
    msgid
    Type
    string
    Description

    Message ID (e.g 24137cf8-eccc-469c-80af-109538857e53)

Request

POST
curl --location 'https://sms.hollatags.com/api/report/' \
      --header 'Content-Type: application/x-www-form-urlencoded' \
      --data-urlencode 'user={USERNAME}' \
      --data-urlencode 'pass={PASSWORD}' \
      --data-urlencode 'msgid=f3930050-9fce-4e07-9859-9ec24d8c511f'

Response

200 OK
DELIVRD
POST

Credit

POST https://sms.hollatags.com/api/credit/ This endpoint allows you to check how much credit you have.

The POST parameters should be sent as x-www-form-urlencoded

  • Name
    user
    Type
    string
    Description

    Account username.

  • Name
    pass
    Type
    string
    Description

    Account password.

Request

POST
curl --location 'https://sms.hollatags.com/api/credit/' \
      --header 'Content-Type: application/x-www-form-urlencoded' \
      --data-urlencode 'user={USERNAME}' \
      --data-urlencode 'pass={PASSWORD}'

Response

200 OK

  "amount you have in your wallet e.g 1000"
POST

Callback_url

POST https://your-callback-url.com/ If you specify a callback_url when sending your message, we will perform a http request to the provided url with the following message status data.

Request Body

  • Name
    message_id
    Type
    string
    Description

    The unique message ID allocated to the message when originally submitted.

  • Name
    status
    Type
    string
    Description

    he final status of the message, in all-caps, ie. DELIVRD, UNDELIV, EXPIRED etc

  • Name
    status_code
    Type
    string
    Description

    The DLR status success or error code associated with the delivery status.

  • Name
    done_date
    Type
    string
    Description

    The date and time at which the sms message reached it's final state.

  • Name
    operator
    Type
    string
    Description

    The mobile network operator and country.

  • Name
    length
    Type
    string
    Description

    Total number of characters for the sms.

  • Name
    page
    Type
    string
    Description

    Number of pages for the message. The character limit for a single page SMS message is 160 characters.

  • Name
    cost
    Type
    string
    Description

    The cost of sending this message.

Request

POST
curl --location 'https://your-callback-url.com/' \
      --header 'Content-Type: application/x-www-form-urlencoded' \
      --data-urlencode 'message_id=API_COMPANY' \
      --data-urlencode 'status=EXPIRED' \
      --data-urlencode 'status_code=err:206' \
      --data-urlencode 'done_date=1-15-2024' \
      --data-urlencode 'operator=MTN-NIGERIA' \
      --data-urlencode 'length=140' \
      --data-urlencode 'page=1' \
      --data-urlencode 'cost=100'

Response

200 OK
{
"message_id": "e70b1903-c877-4d9a-9ec0-ab73b9d7b1db",
"status": "DELIVRD",
"status_code": "000",
"done_date": "2020-10-01 00:15:50",
"operator": "Nigeria - 9MOBILE",
"length": "157",
"page": "1",
"cost": "3.00"
}
POST

OTP

POST https://sms.hollatags.com/api/otp/

This endpoint allows you to send OTP SMS messages

The POST parameters should be sent as x-www-form-urlencoded

Request Body

  • Name
    user
    Type
    string
    Description

    Account username

  • Name
    pass
    Type
    string
    Description

    Account Password

  • Name
    brand_name
    Type
    string
    Description

    Your company, product or service as a brand name. Character length between 3 and 20. This has to be a pre-approved brand name. Please contact help@hollatags.com The recipient will get a message like "Your OTP for [ABC Ltd] is: 1234"

  • Name
    to
    Type
    string
    Description

    Destination number (must be in international format and no prefix e.g. 2348030000000) Numeric with character length between 4 and 8

  • Name
    otp_code*
    Type
    string
    Description

    The OTP code you intend to use for verification. Numeric with character length between 4 and 8

  • Name
    callback_url
    Type
    string
    Description

    If specified, sms status notifications will be sent to this URL. You can include paths in the url but all query parameters would be ignored. See https://docs.hollatags.com/send/callback for a full list of message status parameters that will be sent back to your url.

  • Name
    enable_msg_id
    Type
    string
    Description

    If TRUE, the API response will contain a unique message_id for your sms. Sample response 2348030000000,24137cf8-eccc-469c-80af-109538857e53 Tilde will be used to separate multiple destination numbers. e.g 2348030000000,42138969-09f9-434d-a3c6-db5733fba736~2348030000011,974790b3-e598-41a8-939b-772d16860fb4

  • Name
    hash_string
    Type
    string
    Description

    11-character hash string
    This is only useful for mobile app specific automatically phone number verification. Please leave blank if this is not relevant to you

Request

POST
curl --location --request GET 'https://sms.hollatags.com/api/otp/' \
      --header 'Content-Type: application/x-www-form-urlencoded' \
      --data-urlencode 'user={USERNAME}' \
      --data-urlencode 'pass={PASSWORD}' \
      --data-urlencode 'brand_name=API_COMPANY' \
      --data-urlencode 'to=234700000000' \
      --data-urlencode 'otp_code=456053' \
      --data-urlencode 'callback_url=https://your-callback-url.com/' \
      --data-urlencode 'enable_msg_id=974790b3-e598-41a8-939b-772d16860fb4' \
      --data-urlencode 'hash_string=hash-string'

Response

200 OK
sent
POST

Lookup

POST https://sms.hollatags.com/api/lookup/ The Lookup API provides a way to retrieve additional information about a mobile number like the Carrier information and Ported status. This is only available for Nigerian mobile numbers at this time.
The POST parameters should be sent as x-www-form-urlencoded

  • Name
    user
    Type
    string
    Description

    Account username.

  • Name
    pass
    Type
    string
    Description

    Account password.

  • Name
    msisdn
    Type
    integer
    Description

    Mobile number (must be in international format e.g 23480**)

Request

POST
curl --location 'https://sms.hollatags.com/api/lookup/' \
      --header 'Content-Type: application/x-www-form-urlencoded' \
      --data-urlencode 'user={USERNAME}' \
      --data-urlencode 'pass={PASSWORD}' \
      --data-urlencode 'msisdn=2347000000000'

Response

200 OK
{
  "country": "Nigeria",
  "msisdn": "234703*******",
  "operator": "MTN",
  "ported": "FALSE"
}

Was this page helpful?