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:

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 OTP 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 Provides a collection of numbers (Masking) that can be used as the sender id number for each sms otp will be sent

HTTP Method : GET

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

Response:

{
    "sender_id":[
        "OCA Telkom"
    ]
}

HTTP Method : GET

Endpoint URL : https://mainapi.ocatelkom.co.id/sms/api/v1/otpstatus/(fill_with_msg_id)

Response

{
    "sender_id": "Telkom",
    "receipent_number": "+628123xxxxx",
    "message_body": "Message",
    "status": "sent",
    "created_at": "2023-03-01T03:22:58.073Z",
    "updated_at": "2023-03-01T03:22:58.073Z",
    "msg_id": "xxxx0a123d4ref543xxxx"
}

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

OCA SMS OTP 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 : POST

Endpoint URL : https://mainapi.ocatelkom.co.id/sms/api/v1/send-otp

Request Body

{
    "sender_id": "Telkom"
    "receipent_number": "+628123xxxxx"
    "message_body": "Message"
}

Response:

{
    "sender_id": true,
    "msg_id": "xxxxx898hr47yxxxx"
}

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

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

SMS Premium API V1