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

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

API Documentation Email API V1

OCA EMAIL 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}]}

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

HTTP Method : GET

Endpoint URL : https://email.ocatelkom.co.id/api/v1/email/status/(fill_with_email_id)

Response

In order to hit OCA EMAIL OTP API Gateway Endpoint, client must be authenticated. OCA EMAIL 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:

HTTP Method : POST

Content_Type : application/json

Endpoint URL : https://email.ocatelkom.co.id/api/v1/send-single

FORM DATA:

Response

HTTP Method : GET

Endpoint URL : https://email.ocatelkom.co.id/api/v1/email/history

Response : In Array/LIst

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