Hoiio Open API logo Hoiio Open API

Definition

https://secure.hoiio.com/open/sms/query_status

Parameters

app_id* string
Application ID assigned to your application.
access_token* string
Access Token assigned to your application.
txn_ref* string
The unique reference ID for the required transaction.

Result Format

{
    "status":"success_ok",
    "txn_ref":"AA-S-141147",
    "tag":"id_1",
    "sms_status":"delivered",
    "date":"2010-01-01 10:10:00",
    "dest":"+6511111111",
    "split_count":"2",
    "currency":"SGD",
    "rate":"0.038",
    "debit":"0.076"
}

Documentation

This API allows you to query the current status of a SMS sent previously via sms/send API.

Response Parameters

status The result of your request. Refer to Result Status for details.
sms_status Status of the SMS delivery. Possible values are:
  • queued: The SMS has been queued for sending. For carriers which do not provide SMS Delivery Reports, the status will remain as "queued", even after the SMS has be received by the recipient.
  • delivered: The SMS has been delivered to the recipient's telco.
  • failed: The SMS sending has failed.
  • error: An internal error has occurred.
txn_ref The unique reference ID for this transaction.
tag Your own reference ID submitted in the initial sms/send request. This parameter will not be present if it wasn't included in the initial request.
src The incoming Caller ID of the SMS. Phone numbers start with a "+" and country code (E.164 format), e.g. +6511111111. In an Outgoing SMS, the phone number shown is the one associated with the developer's account. If SMS Rebranding is activated, the rebranding name used will be shown.
dest The recipient number of the SMS. Phone numbers start with a "+" and country code (E.164 format), e.g. +6511111111.
date Date/time (GMT+8) of the call in "YYYY-MM-DD HH:mm:SS" format.
split_count The number of multipart SMS that this message has been split into.
msg Text contained in the SMS message that was sent/received.
currency Currency used for this transaction. Refer to [Currency Code](doc:currency-codes) for the list of currency code.
rate Per-minute charges for this call transaction.
debit Total amount billed for this transaction.

Result Status

success_ok The request has been processed successfully.
error_invalid_http_method Invalid HTTP method. Only GET or POST are allowed.
error_malformed_params HTTP POST request parameters contains non-readable bytes.
error_X_param_missing A required parameter is missing. X is the name of the parameter that is missing.
error_invalid_txn_ref txn_ref parameter is invalid or you do not have the permission to access this transaction.
error_invalid_access_token Your Access Token is invalid, expired or has been revoked.
error_invalid_app_id Your Application ID is invalid or has been revoked.
error_rate_limit_exceeded You have exceeded your request limit for this API. Refer to API Limits for details.
error_internal_server_error There is an unexpected error. Please contact Hoiio support for assistance.

Notifications

None.

API Limits

60 request per minute per application

Charges

None.