Home > API Center > API interface guide

 

Status Report Push

POST

User configured HTTP push address

After the user configures the HTTP push address on the Account Management - Voice App Management page, the platform will actively push the status report of the voice accessed via HTTP API to the user configured address.
 
Push Parameters
Parameter Description Type
array Collection LIST
voiceId Record unique ID String
type Business type: 1-AI Agent Group Call Int
callee Called number String
displayNum Display number String
submitTime Submit time yyyyMMddHHmmSS (millisecond timestamp) String
callTime Call time yyyyMMddHHmmSS (millisecond timestamp) String
ringingTime Ringing time yyyyMMddHHmmSS (millisecond timestamp) String
answerTime Answer time yyyyMMddHHmmSS (millisecond timestamp) String
hangupTime Hangup time yyyyMMddHHmmSS (millisecond timestamp) String
billPeriod Line billing period: 20+20, 60+60 String
code Regional operator String
recordingFileId Call recording ID String
ringDuration Ring duration Int
currency Quoted currency, EUR/USD (Has value when quoted currency is not USD) String
quoteExchange Client side quoting exchange rate (Has value when quoted currency is not USD) String
chargedDuration Line billed duration (seconds) Int
rate Line rate (quoted currency) String
cost Line consumption amount (quoted currency) String
settleRate Line local currency rate (Has value when quoted currency is not USD) String
settlePay Line local currency consumption amount (Has value when quoted currency is not USD) String
aiAgentChargedDuration AI Agent product billed duration (seconds) Integer
aiAgentBillPeriod AI Agent product billing period: 60+60 String
aiAgentRate AI Agent product local currency rate (Has value when quoted currency is not USD) String
aiAgentFee AI Agent product local currency consumption amount (Has value when quoted currency is not USD) String
aiAgentQuoteRate AI Agent quote rate (quoted currency) String
aiAgentQuoteFee AI Agent product consumption amount (quoted currency) String
terminationCode Status code: 0 implies success, other failures String
terminationReason Description of status code String
sipCode SIP code String
calledInfo Called info, 0-1000 characters String
scriptId AI Agent template ID Integer
intent Final intent, please see the intent code table for details String
intentCode Final intent Code, please see the intent code table for details String
taskId Task ID Integer
sourceTaskId Parent group call task ID Integer
callStatusNew Call status (1-Connected, 2-Connected Abnormal, 3-Unconnected, 4-Unconnected Abnormal)
Note: Data recorded after (UTC+8) 2026-03-24 12:00:00
Integer
callDescription Call description (1-Valid call, 2-Voicemail, 3-Short hangup, 4-Silence, 5-Caller hangup, 6-Callee busy/rejected, 7-Callee out of service area, 8-Timeout unanswered, 10-Line balance broadcast)
Note: Data recorded after (UTC+8) 2026-03-24 12:00:00
Integer
 
Push Example
Request URL:
    User configured HTTP push address
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
Request Body:
{
    "array": [
        {
            "answerTime": 1774509748000,
            "sipCode": "200",
            "callDescription": 1,
            "callee": "2222222228613200000007",
            "type": 1,
            "voiceId": "260326152224160100152",
            "displayNum": "5034040",
            "terminationReason": "Called hang up",
            "submitTime": 1774509744963,
            "intentCode": "302",
            "aiAgentChargedDuration": 60,
            "calledInfo": null,
            "billPeriod": "60-60",
            "callDuration": 35,
            "code": null,
            "aiAgentQuoteRate": "0.1",
            "costEur": "0",
            "recordingFileUrl": null,
            "terminationCode": "0",
            "rate": "0",
            "callStatus": 50,
            "hangupTime": 1774509783000,
            "recordingFileId": "260326152224160100152.wav",
            "aiAgentQuoteFee": "0.1",
            "cost": "0",
            "chargedDuration": 60,
            "intent": "Connected-Customer No Responsern",
            "callStatusNew": 1,
            "ringingTime": 1774509747000,
            "scriptId": 63,
            "aiAgentBillPeriod": "60+60",
            "ringDuration": 1,
            "callTime": 1774509747000,
            "taskId": 5034040
        }
    ]
}
 
Response Example
HTTP response 200 implies success, the platform does not verify response content.