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 CALL Gateway provide solution to send SMS. In order to hit the OCA CALL 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

• you have created IVR on blast dashboard

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.

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://webapigw.ocatelkom.co.id/call/v2/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"
}

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

Generate Access Token

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 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://webapigw.ocatelkom.co.id/call/v2/number-collection

Response List (Array)

{
        "phone_number": [
                "021812345678",
                "021812345679",
                "021812345677",
                "021812345674",
                "021812345672",
        ]
}

HTTP Method : GET

Endpoint URL : https://webapigw.ocatelkom.co.id/call/v2/list-recording

Response List (Array)

[
    {
        "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"
    },
    {
        "id": "xxxx8c71g1fae4001267xxxx",
        "filename": "adaaxxxx-a5xx-44xx-86xx-85f4e7e8xxxx.mp3",
        "name":"OCA Audio Rekam.mp3",
        "url": "https://webapigw.ocatelkom.co.id/audio/play/df82xxxx-a5xx-44xx-86xx-57f4e7e8xxxx.mp3"
    },
]

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.

If the Variable used is "name", simply fill in the "name" variable in the variable field in the request body with the String data type. If the Variable used is "audio", please get your audio url from the audio upload process above and enter the url in the variable field in the request body

HTTP Method : GET

Endpoint URL : https://webapigw.ocatelkom.co.id/call/v2/call

Request Body:

{
    "from_number":"02184788xxx",
    "to_number":"081211122xxxx",
    "ivr_id":"xxxxgyutfgv6767768hgxxxx",
    "variable":{
        "name": "galih",
        "audio_1": "https://webapigw.ocatelkom.co.id/audio/play/df82xxxx-a5xx-44xx-86xx-57f4e7e8xxxx.mp3"
    }
}

Response:

{
    "success": true,
    "to_number":"xxxxfghjji10gdd112xxxx",
}

HTTP Method : GET

Endpoint URL :

Response:

Response:

*Sample Result : (Arrray Objects)

HTTP Method : DELETE

Endpoint URL :

Response:

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

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 :

Response List (Array)