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 API 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.

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.

OCA Endpoint URL : https://webapigw.ocatelkom.co.id

Before you start

You will need :

• OCA API Dashboard account username and password

OCA SMS API 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}]}

HTTP Method : GET

Endpoint URL : https://webapigw.ocatelkom.co.id/sms/v2/sms/history

Response List (Array)

[
    {
        "phone_number": "+6281xxxxxxx",
        "message_body": "test message",
        "status": "send",
        "operator_cell": "TELKOMSEL",
        "status_description": "",
        "aditional_data": null,
        "country": "ID",
        "source": "api",
        "uuid": "xxxx961fc19f4aefi54fxxxx",
        "total_sms": 1,
        "created_at":"2024-03-01T03:22:58.073Z", 
        "updated_at": "2024-03-01T03:22:58.073Z",
        "history_status": [],
        "msgid": "xxxx961fc19f4aefi54fxxxx"
    },
    {
        "phone_number": "+6281xxxxxxx",
        "message_body": "test message",
        "status": "send",
        "operator_cell": "TELKOMSEL",
        "status_description": "",
        "aditional_data": null,
        "country": "ID",
        "source": "api",
        "uuid": "xxxxd31fc19f4aefi54fxxxx",
        "total_sms": 1,
        "created_at":"2024-03-01T03:22:58.073Z", 
        "updated_at": "2024-03-01T03:22:58.073Z",
        "history_status": [],
        "msgid": "xxxxd31fc19f4aefi54fxxxx"
    }
]

HTTP Method : POST

Endpoint URL :

Requesst Body:

Response:

OCA SMS API provides an authorization method for you to access our resources, which we primarily use Access Token JSON Web Token (JWT). You can get the Access Token by generating it on our API dashboard.

Generate Access Token

This is the initial display for users who have never generated an access token

Select the channel you want to generate an access token, then click the red button that says "Generate". then access token will be downloaded to your computer in the form of a .txt file.

HTTP Method : GET

Endpoint URL :

Response:

Response:

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