1 of 10

V1

Getting Started

OCA SMS Gateway provide solution to send SMS. In order to hit the OCA SMS Gateway, we provide Endpoint url, so client can hit and use the API.

URL ENDPOINT : https://sms.ocatelkom.co.id/api/v1

API Documentation SMS Regular API V1

Response code

HTTP Status Codes

The OCA SMS Gateway attempts to return the appropriate HTTP Status Codes for every request

Code

Text

Description

200

Success

401

Unauthorized

Missing or Incorrect authentication details

404

Not Found

There is no data available, like user setting etc

406

Not Acceptable

Response when there is invalid format in request

500

Internal Server Error

Something is broken. This is usually a temporary error in server

Error Messages

OCA SMS error messages are returned in JSON Format. Each HTTP Status Code will be accompanied by descriptive error text and code. For example, an error might occur.

{"errors": [{"message": "Invalid Authentication Credentials", "code": 17}]}

Error Codes

This error codes is additional information to explain what happened when some errors occured. The following table describe the code which may appear when working with OCA SMS Gateway. If an error is not listed in the table, going back to HTTP status codes above in order to determine the best way to address the issues.

Code

Text

Description

Internal Error

Corresponds with HTTP 500. An unknown internal error occured

Invalid Authentication Credentials

Corresponds with HTTP 401. It indicates the credential is missing or incorrect

Missing Authorization Header

Corresponds with HTTP 406. It indicates Authorization header is not set properly

[object]

Corresponds with HTTP 406. There are incorrects or missing parameter in request body, it is like the message_value is not same as the template message - invalid input country code

Destination of phone number Values : country code + phone number

valid example : (+6281381475159, 6281381475159)

User Is Not Exist

Corresponds with HTTP 404. The certain user setting is not found

Account Expired

Corresponds with HTTP 401. It indicates the client Account is Expired.

Your Quota Is not Enough

Corresponds with HTTP 401. It indicates the client Quota is Runs Out.

Authentication

In order to hit OCA SMS OTP API Gateway Endpoint, client must be authenticated. OCA SMS OTP API Gateway uses Basic Authentication. Username and password must be encoded with base64 separated by colon and put the encoded credentials into Authorization Header.

Example:

Username: [email protected]

Password: test123

Base64Function([email protected]:test123) => dGVzdEBnbWFpbC5jb206dGVzdDEyMw==

Please attach Credentials in Authorization header in your http request like this:

Endpoint

Send SMS

HTTP Method : POST

Content_Type : application/json

Endpoint URL : : https://sms.ocatelkom.co.id/api/v1/sms

Request Body:

Property

Type

phone

String (Destination phone number) Values : country code + phone number (+6281381475159, 6281381475159)

message

String (Message body)

{
    "phone": "081255xxxxxx",
    "message": "OCA Message"
}

Response:

{
    "status": "sent",
    "msg_uid": "d3a925xxxxxxxxxxxxd2f2d"
}

{
    "errors": [
        {
            "message": [
                {
                    "value": "89694353628",
                    "msg": "Invalid country code",
                    "param": "phone_number",
                    "location": "body"
                }
            ],
            "code": "39"
        }
    ]
}

Property

Type

success

String

msg_uid

String

SMS History

HTTP Method : GET

Endpoint URL : : https://sms.ocatelkom.co.id/api/v1/sms

Response: In Array/List

Property

Type

phone_number

String (Destination phone number)

message_body

String

created_at

ISO Date

status

String

msg_uid

String

total_sms

Number (total sms per 160 characters)

[
    {
        "phone_number": "+62812xxxxxxx",
        "message_body": "Hi OCA",
        "created_at": "2020-05-31T10:00:00.000Z",
        "status": "sent",
        "msg_uid": "xxxxxd7yhu9i0098ixxxxx",
        "total_sms": 1
    },
    {
        "phone_number": "+62812xxxxxxx",
        "message_body": "Hi OCA",
        "created_at": "2020-06-4T10:00:00.000Z",
        "updated_at": "2020-06-4T11:00:00.000Z",
        "status": "sent",
        "msg_uid": "xxxxxd7yhu9i0098ixxxxx",
        "total_sms": 1
    }
]

SMS Detail / Status

HTTP Method : GET

Endpoint URL : https://sms.ocatelkom.co.id/api/v1/sms/status/(fill_with_sms_id)

Response:

Property

Type

phone_number

String (Destination phone number)

message_body

String

created_at

ISO Date

status

String

msg_uid

String

application

String

total_sms

Number (total sms per 160 characters)

{
    "status": true,
    "data": {
        "msg_uid": "xxxxxd7yhu9i0098ixxxxx",
        "application": "yhu9i0098ixxxxx",
        "phone_number": "+62812xxxxxxx",
        "message_body": "Hi OCA",
        "status": "sent",
        "total_sms": 1,
        "created_at": "2020-06-4T10:00:00.000Z"
    }
}