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

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

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: test@gmail.com

Password: test123

Base64Function(test@gmail.com:test123) => dGVzdEBnbWFpbC5jb206dGVzdDEyMw==

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

curl \ 
    --header "Content-Type: application/json" \
    --header "Authorization: Basic dhu7ujuejxxxxxxxxxx==" \
    --request GET \
    https://call.ocatelkom.co.id/api/v1

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": "081255xxxxxx",
    "message": "OCA Message"
}

Response

Property

Type

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

SMS History

HTTP Method : GET

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

Response: In Array/List

Property

Type

[
    {
        "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

{
    "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"
    }
}