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

{"errors": [{"message": "Invalid Authentication Credentials", "code": 17}]}

You can use POST /api/v2/push/message endpoint to send message template to your customers. In order to use this feature, you need to create message template. You can request message template to our customer service.

Message template holds your text message and you can put dynamic data to get more personalize message, like Hi {{name}}, how are you today? Etc

Body

{
    "message": {
        "type": "template",
        "template": {
            "template_code_id": "{{fill_your_template_code_id}}",
            "payload": [
                {
                    "position": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "{{fill_value_varibale_on_body}}"
                        }
                    ]
                }
            ]
        }
    },
    "phone_number": "{{fill_your_recipient_number}}"
}

{
    "message": {
        "type": "template",
        "template": {
            "template_code_id": "{{fill_your_template_code_id}}",
            "payload": [
                {
                    "position": "button",
                    "parameters": [
                        {
                            "sub_type": "quick_reply",
                            "index": 0,
                            "parameters": [
                                {
                                    "type": "payload",
                                    "payload": "{{fill_value_on_quick_reply}}"
                                }
                            ]
                        },
                        {
                            "sub_type": "url_dynamic",
                            "index": 1,
                            "parameters": [
                                {
                                    "type": "text",
                                    "text": "{{fill_value_varibale_on_url_dynamic}}"
                                }
                            ]
                        }
                    ]
                },
                {
                    "position": "body",
                    "parameters": []
                }
            ]
        }
    },
    "phone_number": "{{fill_your_recipient_number}}"
}

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

A successful message will appear as a response value if the HTTP Status code returns 200

(OK). It has a format like the code below

{
    "msgid": "dgyt46exxxxx-h9xxx-d3xx-adf1xxxxx",
    "success": true
}

The status of messages can be grabbed through this endpoint GET /api/v2/message/{{msgid}}/status.

There are 4 types of status that you can get from this endpoint submitted, delivered, read, failed/rejected.

{
    "msgid": "5caexxxx-23xx-f1xx-adf12f36xxxx"
    "phone_number": "+6281234xxxxx"
    "history_status":[
        {
            "timestamp": "2024-03-01T03:22:58.073Z"
            "status": "submitted"
        },
        {
            "timestamp": "2024-04-01T03:22:58.073Z"
            "status": "rejected"
        }
    ],
    "additional_info": {
        "code": 1340,
        "reason": "Send Outside Allowed Window"
    }
}

You can use POST /api/v2/push/message endpoint to send message template to your customers. In order to use this feature, you need to create message template. You can request message template to our customer service.

With this media message template, you can send media like image, video & document along with your message text.

Body:

{
  "message": {
    "type": "template",
    "template": {
      "template_code_id": "{{fill_your_template_code_id}}",
      "payload": [
        {
          "position": "header",
          "parameters": [
            {
              "type": "{{your_can_fill_[document||image||video]}}",
              "document": {
                "url": "{{fill_your_url_[document||image||video]}}",
                "caption": "{{fill_value_caption_on_media}}"
              }
            }
          ]
        },
        {
          "position": "body",
          "parameters": []
        }
      ]
    }
  },
  "phone_number": "{{fill_your_recipient_number}}"
}

The main Object

The message Object

The template Object

The payload Object

The body parameters Object

The header parameters Object

The image, video & document Object

OCA WA API provides an authorization method for you to access our resources, which we primarily use Access Token JSON Web Token (JWT). We will provide you the JWT token.

Whatsapp telah merelease fitur baru yaitu template Authentication With One Time Password Buttons, fitur ini dikhususkan untuk pengiriman pesan yang digunakan untuk keperluan autentikasi dan verifikasi menggunakan kode OTP, berikut beberapa hal terkait kapabilitas template Authentication.

1. Template Authentication sudah memiliki kalimat pesan default dari Meta, dimana user tidak dapat melakukan perubahan kalimat pesan, untuk contoh kalimat pesan Bahasa Indonesia akan seperti di bawah ini:

“123456 adalah kode verifikasi anda. Demi keamanan, jangan bagikan kode ini.”

1. Template Authentication menyediakan “Copy Button” yang akan memudahkan penerima untuk melakukan copy kode otp untuk dimasukkan ke website atau applikasi pada saat proses verifikasi.

1. Tidak diperbolehkan menggunakan media pada pesan template Authentication

2. Konten dinamis hanya boleh berisi number, text dan tidak boleh menggunakan symbol ataupun karakter

Langkah-langkah penggunaan whatsapp template Authentication

Untuk dapat menggunakan whatsapp template Authentication terdapat beberapa hal yang harus dilakukan oleh user, berikut Langkah-langkah dan penjelasannya

1. Request Whatsapp template Authentication

User dapat melakukan request template melalui dashboard developer api, silahkan kunjungin website di https://developer.ocaindonesia.co.id, lalu klik menu Whatsapp Template dan klik tombol Add Template, lalu akan muncul pop up dialog, silahkan untuk mengisi language dan memilih template Authentication lalu klik tombol Continue.

1. Silahkan masukkan wording berikut “[kode] adalah kode verifikasi anda. Demi keamanan, jangan bagikan kode ini.”. Perlu diingat secara default whatsapp sudah menetapkan wording untuk setiap Bahasa yang dipilih, dalam step ini pemberian wording digunakan untuk pencatatan di system OCA saja.

2. Silahkan tunggu proses pengajuan sampai status pengajuan berubah menjadi Approved.

3. Selanjutnya untuk penggunaan API dapat menggunakan payload request seperti ini:

API URL: /whatsapp/v2/send/message

METHOD: POST

AUTHENTICATION: Bearer {{jwt_token}}

Payload Body

{
    "phone_number": "6281345xxxxxx",
    "message": {
        "type": "template",
        "template":{
            "template_code_id": "{{fill_with_template_code}}",
            "payload": [
             {
                "position": "body",
                "parameters": [
                {
                  "type": "text",
                  "text": "{{fill_with_otp_code}}"
                }
               ]
             },
             {
                "position": "button",
                "parameters": [
                {
                  "sub_type": "url",
                  "index": "0",
                  "parameters":  [
                   {
                     "type": "text",
                     "text": "{{fill_with_otp_code}}"
                   }
                 ]
                }
               ]
             }
            ]
        }
    }
}

This document provides information on how to use Whatsapp Bussiness API, in order to you send notification and messages to your customers.

OCA Endpoint URL : https://wa01.ocatelkom.co.id

Before you start

You will need :

• Verified whatsapp business account

• A username and password of Oca’s account

• Registered message template (please contact our customer service to register your template

Postman: