Suggestions

close search

Call Events

When the state of the call changes, Stringee Server sends a HTTP POST request to Your Server:

{
    "call_status": "started",
    "project_id": 25,
    "request_from_user_id": "huydn",
    "account_sid": "ACab9b9bcf6391c6af9fe1663c729e3a6b",
    "timestamp_ms": 1515859261381,
    "from": {
        "number": "84899199866",
        "alias": "84899199866",
        "is_online": false,
        "type": "internal"
    },
    "to": {
        "number": "84909985668",
        "alias": "84909985668",
        "is_online": false,
        "type": "external"
    },
    "clientCustomData": "CLIENT_CUSTOM_DATA",
    "type": "stringee_call",
    "call_id": "call-vn-1-ZD3IDIXS1J-1515820305477"
}

HTTP Method: POST Content-Type: application/json

Field Type Description
call_status String Call status:
- created
- started
- ringing
- answered
- ended
- agentEnded
project_id Long Project ID
request_from_user_id String Request from this User ID
account_sid String Your account_sid
timestamp_ms Long timestamp in millisecond
from JSON from
to JSON to
type String - stringee_call
call_id String Call ID
clientCustomData String Corresponding to the custom parameter which passed to the makeCall() method at Client.

End Call Events

When the state of the call changes to ended, Stringee Server sends a HTTP POST request to Your Server:

{
    "call_status": "ended",
    "project_id": 25,
    "request_from_user_id": "huydn",
    "account_sid": "ACab9b9bcf6391c6af9fe1663c729e3a6sdfdsf",
    "timestamp_ms": 1538369461077,
    "type": "stringee_call",
    "call_id": "call-vn-1-ZD3IDIXS1J-1515820305478",
    "clientCustomData": "",
    "callCreatedReason": "CLIENT_MAKE_CALL",
    "endCallCause": "486 Busy Here",
    "endedBy": "EXTERNAL",
    "callType": "CALL",
    "duration": 9,
    "answerDuration": 0,
    "from": {
        "number": "84899199866",
        "alias": "84899199866",
        "is_online": false,
        "type": "internal"
    },

    "to": {
        "number": "84909985668",
        "alias": "84909985668",
        "is_online": false,
        "type": "external"
    }
}

HTTP Method: POST Content-Type: application/json

Field Type Description
call_status String Call status: - ended
project_id Long Project ID
request_from_user_id String Request from this User ID
account_sid String Your account_sid
timestamp_ms Long timestamp in millisecond
from JSON from
to JSON to
type String - stringee_call
call_id String Call ID
clientCustomData String Corresponding to the custom parameter which passed to the makeCall() method at Client.
callCreatedReason String Reason create call:
- CLIENT_MAKE_CALL
- EXTERNAL_CALL_IN
- SERVER_CALL_OUT_BY_MAKE_CALL_TO_APP_BEFORE
- SERVER_CALL_OUT_BY_MAKE_CALL_TO_EXTERNAL_BEFORE
endCallCause String End call cause:
- USER_END_CALL
- CAN_NOT_MAKE_CALL
- MAX_CONNECT_TIME
- Or Sip code (https://en.wikipedia.org/wiki/List_of_SIP_response_codes). Example: 486 Busy Here, 480 Temporarily Unavailable ...
endedBy String Ended by:
- EXTERNAL
- INTERNAL
callType String Call type:
- IVR
- CALL
- CONFERENCE
duration Integer Call duration (in seconds)
answerDuration Integer Answer duration (in seconds)