Suggestions

close search

Call Management

Call History

URL: https://api.stringeex.com/v1/call/history

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT) see StringeeX API REST Authentication

GET params:

Field	Type	Default	Description
version	Number	1	1 = supports pagination (deprecated); 2 = supports search_after
search_after[]	Array		Used for pagination in version 2. Example: search_after[]=1751236747978&search_after[]=call-vn-1-N88JMCZ5ES-1751236617730
call_id	String		Call ID
time	String		Time range in milliseconds. Format: fromTime-toTime
answer_duration	Number		Answer duration in seconds
queue_duration	Number		Time in queue in seconds
direction	Number		0: callout, 1: callin, 2: internal
agent_id	String		ID of agent
status	Number		1: connected, 2: missed, 3: stop at IVR, 4: stop at survey IVR
stringee_number	String		Stringee number
customer_number	String		Customer number
sort_order	String	desc	asc or desc
sort_by	String	start_time	Field to sort by
has_voicemail	Number		1: has voicemail, 0: no voicemail

Sample request:

GET https://api.stringeex.com/v1/call/history?call_id=&time=1626627600000-1626713999999&direction=1&version=2
X-STRINGEE-AUTH: json_web_token

Response code:

Code	Description
r = 0	Success
r = 12	sort_order not allowed

Sample response:

{
  "r": 0,
  "msg": "Success",
  "data": {
    "totalCount": 1,
    "totalPages": 0,
    "search_after": [
      1751236747978,
      "call-vn-1-N88JMCZ5ES-1751236617730"
    ],
    "rows": [
      {
        "id": "call-vn-1-N88JMCZ5ES-1751236617730",
        "customer_number": "84976415857",
        "stringee_number": "842473030658",
        "direction": 1,
        "start_time": 1751236747978,
        "end_time": 1751236762147,
        "answer_time": 1751236756840,
        "answer_duration": 5,
        "talk_duration": 5,
        "queue_duration": 8,
        "ivr_duration": 0,
        "hold_duration": 0,
        "acw_duration": 10,
        "recorded": 1,
        "have_voice_mail": 0,
        "end_call_reason": "USER_END_CALL",
        "end_call_by": "EXTERNAL",
        "route_to_agent": 1,
        "status": 1,
        "account": "ac_qgnfcao5dha2ai75",
        "account_name": "Mr Join",
        "account_email": "[email protected]",
        "contactname": "Contact 84976415857",
        "company_id": null,
        "companyname": null,
        "ticket_id": "TKIVX0UCJ5",
        "ticket_subject": "Call from contact 84976415857",
        "ticket_answer_duration": 5,
        "ticket_assignee": "ac_qgnfcao5dha2ai75",
        "ticket_status": 0,
        "participants": null,
        "video_call": null
      }
    ]
  }
}

Realtime call

URL: https://api.stringeex.com/v1/call/list

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT) see StringeeX API REST Authentication

Sample response:

{
    "r": 0,
    "data": {
        "totalCount": 2,
        "totalPages": 1,
        "currentPage": 1,
        "limit": 200,
        "calls": [
            {
                "callId": "call-vn-1-MC88W0DJQD-1544614208296",
                "stringeeNumber": "842473082686",
                "agent": "huy",
                "startTime": 1544697312327,
                "answeredTime": 0,
                "stringeeNumberNickname": "Number 112",
                "customerNumber": "84909982668",
                "direction": "callout"
            },
            {
                "callId": "call-vn-1-MC88W0DJQD-1544614208297",
                "stringeeNumber": "+842473082686",
                "agent": "ac_g3wwkjog1xjrxknz",
                "startTime": 1544697315140,
                "answeredTime": 0,
                "stringeeNumberNickname": "Number 112",
                "customerNumber": "84909982668",
                "direction": "callin"
            }
        ]
    },
    "message": "Load call(s) success"
}

Transfer call

URL: https://api.stringeex.com/v1/call/transfer

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

Sample response:

{
    "callId": "CALL_ID",
    "to": {
        "type": "internal",
        "number": "AGENT_STRINGEE_USER_ID",
        "alias": "AGENT_STRINGEE_USER_ID"
    }
}

Stop call

URL: https://api.stringeex.com/v1/call/stop

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

Sample response:

{
    "callId": "YOUR_CALL_ID"
}

Add participant to call

URL: https://api.stringeex.com/v1/call/addparticipant

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

Sample response:

{
    "callId": "call-vn-1-PODRUT8HZA-1544701351185",
     "from": {
        "type": "external",
        "number": "842473082686",
        "alias": "842473082686"
    },

    "to": {
        "type": "internal",
        "number": "500",
        "alias": "500"
    }
}

Download file record

URL: https://api.stringeex.com/v1/recordfile/play?callId=CALL_ID&access_token=AUTH_TOKEN

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

Upload greeting file

<form action="https://api.stringeex.com/v1/greetingfileupload?access_token=AUTH_TOKEN" method="post" enctype="multipart/form-data">

    <input type="input" name="desc" id="desc" value="desc 123"><br><br>

    <input type="file" name="file_upload" id="file_upload">

    <input type="submit" value="Upload Image" name="submit">
</form>

Delete file record

URL: https://api.stringeex.com/v1/call/deleterecord?callid=CALL_ID&access_token=AUTH_TOKEN

HTTP method: DELETE

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication