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

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.

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

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:

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

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

Response

Property

Type

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

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