Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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.
OCA Endpoint URL : https://webapigw.ocatelkom.co.id
Before you start
You will need :
OCA API Dashboard account username and password
The OCA EMAIL Gateway attempts to return the appropriate HTTP Status Codes for every request
| Code | Text | Description |
|---|---|---|
OCA EMAIL 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.
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.
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.
HTTP Method : POST
Endpoint URL :
Form Data (Body)
| Property | Type |
|---|
Response:
| Property | Type |
|---|
HTTP Method : GET
Endpoint URL :
Response:
| Property | Type |
|---|
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 |
|---|
200
OK
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
429
To Many Request
Returned when a request cannot be served due to the system's rate limit having been exhausted for the resource
500
Internal Server Error
Something is broken. This is usually a temporary error in server
5 | low-balance | Indicationg that your account has no enough balance left |
9 | Too Many Request Code | Due to the api rate limit, you have to wait until the currently window wxpires, the default api rate limit is in 25 request per seconds. You can check http headers reaponse in order to know the remaining limit of your request. - X-RateLimit-limit : the rate limit of endpoint - X-RateLmit-Remaining : the number of request left - X-RateLimit-Reset : the remaining window before the rate limit resets |
13 | Internal Error | Corresponds with HTTP 500. An unknown internal error occured |
19 | Missing Authorization Header | Corresponds with HTTP 401. It indicates Authorization header is not set properly |
33 | Data doesn't exist | Corresponds with HTTP 404. The certain data is not found |
39 | [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 |
43 | Auth token is not supplied | Corresponds with HTTP 401. It indicates Authorization header is not set properly |
45 | Auth token is not valid | Corresponds with HTTP 401. It indicates Authorization token is not valid |
59 | Whatsapp Template doesn't exist Code | Corresponds with HTTP 406. Your message template doesn't exist |
| String (Destination email - To) |
| Base64Function(String) (Message body – HTML code) |
| String (Sender email - From) |
| String (Sender name - From) |
| String (Subject of email) |
| file - optional |
| Boolean |
| String |
String (Destination email) |
message_body | String |
created_at | ISO Date |
status | String (status of email. opened, delivered, failed, etc) |
msg_id | String |
HTTP Method : GET
Endpoint URL : https://webapigw.ocatelkom.co.id/email/v2/email/history?page={{fill_page_number}}&limit={{fill_limit_data_per_page}}
Response
| Property | Type |
|---|---|
*The Data Array:
| Property | Type |
|---|---|
page
Number
pages
Number
total_inpage
Number
limit
Number
data
Array List Data*
email
String (Destination email)
message_body
String
created_at
ISO Date
status
String (status of email. opened, delivered, failed, etc)
msg_id
String
