1 of 10

V1

Getting Started

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

Response Code

HTTP Status Codes

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

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

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

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

Password: test123

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

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

Endpoint

Send Email

HTTP Method : POST

Content_Type : application/json

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

FORM DATA:

Property

Type

email

String (Destination Email To)

message

Base64Function(String) (Message body – HTML code)

sender_email

String (Sender email - From)

sender_name

String (Sender name - From)

subject

String (Subject of email)

attachment

file - optional

Response

Property

Type

success

Boolean

msg_id

String

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

Email History

HTTP Method : GET

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

Response : In Array/LIst

Property

Type

email

String (Destination Email)

message_body

String

created_at

ISO Date

status

String (status of email. opened, delivered, failed, etc)

msg_id

String

[
    {
        "email": "ocaxxxxx@gxxx.com",
        "message_body": "<h1>Oca Message</h1>",
        "created_at": "2020-03-10T11:00:00.000Z",
        "status": "delivered",
        "msg_id": "xxxxhu7f900sdr8xxxx"
    },
    {
        "email": "ocaxxxxx@gxxx.com",
        "message_body": "<p>Oca Message</p>",
        "created_at": "2020-03-10T11:00:00.000Z",
        "status": "opened",
        "msg_id": "xxxxhu7f900sdr8xxxx"
    },
]

Email Detail / Status

HTTP Method : GET

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

Response

Property

Type

email

String (Destination Email)

message_body

String

created_at

ISO Date

status

String (status of email. opened, delivered, failed, etc)

msg_id

String

{
    "status": true,
    "data": {
        "email": "ocaxxxxx@gxxx.com",
        "message_body": "<p>Oca Message</p>",
        "created_at": "2020-03-10T11:00:00.000Z",
        "status": "opened",
        "msg_id": "xxxxhu7f900sdr8xxxx"
    }
}

Send Email

HTTP Method : POST

Content_Type : application/json

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

FORM DATA:

Property

Type

email

String (Destination Email To)

message

Base64Function(String) (Message body – HTML code)

sender_email

String (Sender email - From)

sender_name

String (Sender name - From)

subject

String (Subject of email)

attachment

file - optional

Response

Property

Type

success

Boolean

msg_id

String

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