imx-sms-post

POST

Send SMS

Send new SMS to any mobile phone number through the Blinke API.

 

To send an SMS, every request must pass in the access_token value in the header. For more information on how to generate an access_token, please refer to this section.

 

 

Request

Method URL
POST https://blinke-stage.apigee.net/imx/sms

 

 

Request Headers

Name Description Mandatory
Authorization Bearer access_token Yes
Content-Type value = application/json Yes

 

 

Request Body

Request body is a JSON formatted text containing the following fields:

Name Description Mandatory
msisdn
string
The destination phone number. Format with msisdn e.g., 628150000001 (MSISDN format). Yes
message
string
Message content to be sent Yes

 

 

Response

Result of the successful request contains following information:

Name Description
success
boolean
Return true if success.
transId
string
The Transaction ID from Blinke API.
message
string
The message information if the request has been successfully processed.

 

 

Response (Example)

HTTP Code Response
200
{
    "transId": "9000364791991406",
    "success": true,
    "message": "Message has been successfully processed"
}
400
{
    "success": false,
    "error": {
        "code": "IMX-107",
        "message": "Invalid prefix number (e.g. valid prefix number: 628xxx)"
    }
}

Depending on the request, other error code may occurs. Please refer to the following error code:

  • IMX-103 : Invalid MSISDN
  • IMX-105 : Invalid request
  • IMX-107 : Invalid prefix number (e.g. valid prefix number: 628xxx)
  • IMX-109 : Message not send
  • IMX-130 : Over limit
  • IMX-197 : Permission denied
401
{
    "fault": {
        "faultstring": "Invalid Access Token",
        "detail": {
            "errorcode": "keymanagement.service.invalid_access_token"
        }
    }
}

 

 

Sandbox limitation
  • Limited to 10 sms per developer.
  • SMS will only be sent to Indosat Ooredoo mobile phone number only.
  • The remaining sms balance can be observed from Available-SMS-Quota response header.

Resource URL

https://blinke-stage.apigee.net /imx/sms

Header Parameters


Name Values Description
Content-Type
(required)

application/json

Authorization
(required)

Bearer access_token

Body Parameters


Name Values Description
Content

Message content and msisdn

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security

Content Type

application/json

Working...