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 | Required | Description |
---|---|---|---|
direction | Number | No | 1: Call in, 0: Call out |
queue_id | Text | No | Queue ID |
call_to_queue | Number | No | 1: Call routed to queue, 0: Call routed IVR |
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 | Required | Description |
---|---|---|---|
time | Text | No | "from millisecond - to millisecond" |
agent_id | Text | No | Agent ID |
page | Number | No | Default: 1 |
limit | Number | No | Default: 20 |
sort_order | Text | No | asc or desc |
sort_by | Text | No | ex: agent_name |
Sample response:
{
"data": {
"rows": [
{
"agent_name": "Avong Alexander Eric",
"agent_id": "AC2YECX3RX",
"average_talk_time": 0,
"total_talk_time": 0,
"answered_call": 0,
"missed_call": 0,
"answered_call_out": 0
},
{
...
}
],
"totalPages": 2,
"totalCount": 28
},
"r": 0,
"msg": "Success"
}
URL: https://api.stringeex.com/v1/acdperformance/list?start_time=0&end_time=1548586506
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,
"queues": [
{
"id": "queue_1",
"name": "queue 1",
"total_call": 2,
"call_abandoned": 2,
"callAnsweredWithinSla": 0
},
{
"id": "queue_2",
"name": "queue 2",
"total_call": 0,
"call_abandoned": 0,
"callAnsweredWithinSla": 0
}
],
"message": "Load Acdperformance success"
}
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 | Required | Description |
---|---|---|---|
time | Text | No | 27/07/2020 00:00-27/07/2020 23:59 => Range time format dd/MM/yyyy HH:mm - dd/MM/yyyy HH:mm |
hotline | Array | No | Hotline number, ex: ["09111111111","09222222222"] |
queues | Array | No | List queue ID, ex: ["QUEUE1","QUEUE2"] |
Sample response:
{
data: {
00:00-00:30 27/07/2020: {
average_answer_duration: 0
average_duration: 0
average_hold_time: 0
average_ivr_duration: 0
average_queue_duration: 0
average_speed_answer: 0
average_talk_time: 0
total_answer_call: 0
total_answer_callin: 0
total_answer_duration: 0
total_call: 0
total_call_in: 0
total_call_in_duration: 0
total_call_out: 0
total_call_out_duration: 0
total_duration: 0
total_ivr_call: 0
total_ivr_duration: 0
total_miss_call: 0
total_queue_call: 0
total_queue_duration: 0
total_speed_duration: 0
total_talk_duration: 0
},
00:30-01:00 27/07/2020: {
...
},
...
},
msg: "Success",
r: 0
}
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 | Required | Description |
---|---|---|---|
call_id | Text | No | Call ID |
time | Text | No | From millisecond - to millisecond, ex: 1595782800000-1595869199999 |
answer_duration | Array | Number | Larger than answer duration by seconds |
queue_duration | Array | Number | Larger than queue duration by seconds |
direction | Array | No | 1: Call in, 2: Call out, 3: Internal call |
agent_id | Array | No | Agent's ID |
status | Array | No | 1: Answered, 2: Missed, Stop at IVR, Stop at Survey |
stringee_number | Array | No | Stringee's number |
customer_number | Array | No | Customer's number |
page | Array | No | Default: 1 |
limit | Array | No | Default: 10 |
sort_order | Array | No | desc | asc, Default: desc |
sort_by | Array | No | Default: start_time |
enable_ivr_survey | Array | No | 1: Call enabled IVR survey, 0: Call unabled IVR survey |
has_voicemail | Array | No | 1: Has voicemail, 0: Don't have voicemail |
Sample response:
{
"data":{
"rows":[
{
"object_type":"call",
"id":"call-vn-1-YH5IYSF7SN-1595782362275",
"project_id":1120,
"customer_number":"video_tien-stringee-com",
"stringee_number":"842873030094",
"direction":1,
"start_time":1595835886432,
"end_time":1595836144865,
"answer_time":1595835891435,
"enqueue_time":1595835886451,
"duration":258,
"ivr_duration":0,
"queue_duration":4,
"answer_duration":253,
"portal":"PT8LB2FD3Q",
"account":"ac_qgnfcao5dha2ai75",
"queue_id":"QU1F90VR",
"hold_duration":0,
"talk_duration":253,
"recorded":true,
"have_voice_mail":false,
"ticket_serial":10733,
"contact_id":"CTZ6LATI9Y",
"end_call_reason":"MEDIA_TIMEOUT",
"end_call_by":"INTERNAL",
"route_to_agent":true,
"acw_duration":10,
"account_name":"Tran Tien",
"contactname":"Li\u00ean h\u1ec7 video_tien-stringee-com",
"company_id":null,
"companyname":null,
"from_user_id":null,
"record_path":null,
"participants":null,
"answer_duration_minutes":null,
"first_answer_time":null,
"callee":null,
"video_call":null
},
{
...
}
],
"totalPages":1,
"totalCount":7
},
"r":0,
"msg":"Success"
}