1 of 1

Call Detail / Status

HTTP Method : GET

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

Response:

Property

Type

from_number

String (Phone numbers that get from numbers collection)

to_number

String (Destination phone number)

ivr_id

String (IVR ID )

call_id

Object (filled with required variable and the value)

call_start

ISO Date (call start ringing)

call_answer

ISO Date (call picked up by destination)

call_end

ISO Date (call ended by destination)

duration

Number (total duration from call made until call ended)

talk_duration

Number (total talk duration from call picked up by user until call hangup, Billing will be counting by talk_duration)

tta

Number (time to answer)

hangup_cause

String (status from system)

status

String (status of call. submitted, success, failed)

created_at

ISO Date

updated_at

ISO Date

result

Array Objects*

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

Call Detail / Status

HTTP Method : GET

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

Response:

Property

Type

from_number

String (Phone numbers that get from numbers collection)

to_number

String (Destination phone number)

ivr_id

String (IVR ID )

call_id

Object (filled with required variable and the value)

call_start

ISO Date (call start ringing)

call_answer

ISO Date (call picked up by destination)

call_end

ISO Date (call ended by destination)

duration

Number (total duration from call made until call ended)

talk_duration

Number (total talk duration from call picked up by user until call hangup, Billing will be counting by talk_duration)

tta

Number (time to answer)

hangup_cause

String (status from system)

status

String (status of call. submitted, success, failed)

created_at

ISO Date

updated_at

ISO Date

result

Array Objects*

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