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

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

Upload audio file is method to store your audio file in OCA’s cloud storage, you can retrieve your audio by url that oca provide after you successfully upload your audio.

HTTP Method : POST

Endpoint URL : https://call.ocatelkom.co.id/api/v1/upload-audio

Form Data (Body)

Response:

{
    "id": "xxxxf03d61fae4001267xxxx",
    "filename": "df82xxxx-a5xx-44xx-86xx-57f4e7e8xxxx.mp3",
    "name":"OCA Audio Rekam.mp3",
    "url": "https://webapigw.ocatelkom.co.id/audio/play/df82xxxx-a5xx-44xx-86xx-57f4e7e8xxxx.mp3"
}

HTTP Method : DELETE

Endpoint URL : https://call.ocatelkom.co.id/api/v1/delete-audio/{{fill with audio id}}

Response:

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

OCA Provides a collection of numbers that can be used as the caller id number for each call that is made

HTTP Method : GET

Endpoint URL : https://call.ocatelkom.co.id/api/v1/number-collection

Response List (Array)

{
        "phone_number": [
                "02181235xxxx",
                "02181234xxxx",
                "02181233xxxx",
                "02181239xxxx",
                "02181237xxxx",
        ]
}

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

HTTP Method : GET

Endpoint URL : https://call.ocatelkom.co.id/api/v1/call-status/(fill_with_call_id)

Response:

Response:

{
    "from_number": "62857xxxxxxx",
    "to_number":"081212xxxxxxxx",
    "ivr_id": "xxxxgyutfgv6767768hgxxxx",
    "call_id": "xxxxkya9iv6767768hgxxxx",
    "application_id": "xxxx708875682700297dxxxx",
    "call_start": "2024-07-31T18:01:06.000Z",
    "call_answer": "2024-07-31T18:01:26.000Z",
    "call_end": "2024-07-31T18:01:32.000Z",
    "duration": 26,
    "talk_duration": 6,
    "tta": 20,
    "hangup_cause": "NORMAL_CLEARING",
    "status": "answered",
    "created_at": "2024-07-31T18:01:32.680Z",
    "updated_at": "2024-07-31T18:01:32.000Z"
    "result": [...
    ]
}

*Sample Result : (Arrray Objects)

[
    {
        "question":"Sebutkan nama anda setelah tanda beep berikut, dan akhiri dengan menekan tanda pagar",
        "type":"record_speach",
        "answer":[
            "https://storage.oca.co.id/audio/xxxxgh78uj-xxxhu-60xx-5ff2ff69xxxxx.wav"
        ]
        
    },
    {
        "question":"Apakah anda sehat hari ini, tekan 1 jika sehat, tekan 2 jika kurang sehat",
        "type":"multiple_choice",
        "answer":[
            {
                "key": "1",
                "title": "Key 1",
                "total": 1 
            },
            {
                "key": "2",
                "title": "Key 2",
                "total": 0 
            }
        ]
        
    },
    {
        "question":"masukkan nomor rekening anda",
        "type":"collect_number",
        "answer":[
            "854672xxx"
        ]
        
    }
]

After you design your IVR, you can use the ivr to make call to your customer. Remember, you can add dynamic content in your ivr design. In order to use ivr you have to see what ivr that available in your account, the ivr list will show you ivr name, ivr id, and variable (data you must provide when you make a call).

HTTP Method : GET

Endpoint URL : https://call.ocatelkom.co.id/api/v1/ivr-list

Response List (Array)

[
    {
        "ivr_id": "xxxxf03d61fae4001267xxxx",
        "ivr_name": "Testing Call Recording",
        "required_variable":[],
        "created_at": "2020-03-01T03:22:58.073Z",
        "deleted_at": "2020-03-01T03:22:58.073Z",
    },
    {
        "ivr_id": "xxxxghyuikae4001267xxxx",
        "ivr_name": "IVR Resti",
        "required_variable":[
                "name",
                "nomor_inet"
        ],
        "created_at": "2020-03-01T03:22:58.073Z",
        "deleted_at": "2020-03-01T03:22:58.073Z",
    },
]

HTTP Method : GET

Endpoint URL : https://call.ocatelkom.co.id/api/v1/list-recording

Response List (Array)

[
    {
        "id": "xxxxf03d61fae4001267xxxx",
        "filename": "df82xxxx-a5xx-44xx-86xx-57f4e7e8xxxx.mp3",
        "name":"OCA Audio Rekam.mp3",
        "url": "https://wstaging-call.ocatelkom.co.id/api/v1/audio/play/df82xxxx-a5xx-44xx-86xx-57f4e7e8xxxx.mp3"
    },
    {
        "id": "xxxx8c71g1fae4001267xxxx",
        "filename": "adaaxxxx-a5xx-44xx-86xx-85f4e7e8xxxx.mp3",
        "name":"OCA Audio Rekam.mp3",
        "url": "https://staging-call.ocatelkom.co.id/api/v1/audio/play/df82xxxx-a5xx-44xx-86xx-57f4e7e8xxxx.mp3"
    },
]

OCA CALL Gateway provide solution to make a robot call with dynamic caller id number and interactive voice response technology. In order to hit the OCA CALL Gateway, we provide Endpoint url, so client can hit and use the API.

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

IVR Designer

Before you can make a call, you need to make the IVR (Interactive Voice Response) first. In order to make ivr you should log in to dashboard, you can visit https://dashboard.ocatelkom.co.id. Please provide your username and password to log in.

To start making ivr please select IVR menu OCA Blast -> Voice -> IVR and Press Add ivr button to start design your ivr.

We want to show you how to build ivr with dynamic audio, so you can play audio dynamicallya from api trigger call. You can start with choose component Play External Audio, drag and drop the component to the board, as shown in the picture below.

In the component editor, on the right side, you will see the form for specific component, please fill the Audio Url with dynamic variable start with “{{“ symbol and end with “}}” symbol, as shown in the picture below.

API Documentation IVR API V1

Please get your audio url from the process upload audio above and put the url in variable field in the request body

HTTP Method : POST

Endpoint URL :

Request Body:

Response: