Download 3CX WebAPI Postman example (Save as and import file in postman)
3CX Call-Control (Click-to-call)
Get key required
{
"product": "3CX REST API",
"version": "3.0.8 20.1",
"release": "Webhooks",
"licenseExpire": "14.10.2033 21:32:17",
"clientLicensesNum": "999",
"concurrentCalls": 32,
"sql": true,
"api": true,
"ai": true,
"quality": false
}
{
"result": 5
}
{
"count": 2,
"AConnByCallID": [
{
"callID": 46874,
"direction": "Internal",
"did": "",
"AConnList": [
{
"dnNum": "1739",
"dnType": "extension",
"externalParty": "1674",
"status": "Connected"
},
{
"dnNum": "1674",
"dnType": "extension",
"externalParty": "1739",
"status": "Connected"
}
]
},
{
"callID": 46883,
"direction": "Internal",
"did": "",
"AConnList": [
{
"dnNum": "1283",
"dnType": "extension",
"externalParty": "1126",
"status": "Connected"
},
{
"dnNum": "1126",
"dnType": "extension",
"externalParty": "1283",
"status": "Connected"
}
]
}
]
}
{
"count": 2,
"callsInfo": [
{
"callID": 46874,
"state": "Talking",
"startedAt": "2022-12-29T08:37:16Z",
"answeredAt": "2022-12-29T08:37:23Z",
"did": "",
"owner": {
"dnNum": "1739",
"dnType": "extension",
"externalParty": "1674",
"status": "Connected"
},
"talkTo": [
{
"dnNum": "1674",
"dnType": "extension",
"externalParty": "1739",
"status": "Connected"
}
],
"routingTo": []
},
{
"callID": 46864,
"state": "Talking",
"startedAt": "2022-12-29T08:23:58Z",
"answeredAt": "2022-12-29T08:24:01Z",
"did": "",
"owner": {
"dnNum": "1126",
"dnType": "extension",
"externalParty": "1283",
"status": "Connected"
},
"talkTo": [
{
"dnNum": "1283",
"dnType": "extension",
"externalParty": "1126",
"status": "Connected"
}
],
"routingTo": []
}
]
}
{
"nums": [
"90000",
"10002",
"10000",
"10001"
]
}
{
"nums": [
"100",
"101",
"102",
"103",
"104",
"105",
"106",
"520",
"521",
"522"
]
}
{
"nums": [
"100",
"101",
"102"
]
}
[
{
"num": "100",
"fwdName": "Available",
"fwdMessage": "Custom message1",
"qGlobalStatus": true,
"qStatus": [
{
"num": "801",
"status": true
},
{
"num": "805",
"status": true
}
]
},
{
"num": "103",
"fwdName": "Available",
"fwdMessage": "",
"qGlobalStatus": true,
"qStatus": [
{
"num": "801",
"status": false
}
]
},
{
"num": "106",
"fwdName": "Available",
"fwdMessage": "",
"qGlobalStatus": true,
"qStatus": []
},
{
"num": "104",
"fwdName": "Available",
"fwdMessage": "",
"qGlobalStatus": true,
"qStatus": [
{
"num": "801",
"status": false
}
]
}
]
{
"nums": [
"945",
"803"
]
}
{
"nums": [
"777",
"QCB",
"800",
"804"
]
}
{
"num": "102",
"name": "John",
"lastname": "Smith",
"email": "j.smith@creomate.com",
"mobile": "0629759787",
"enabled": true,
"externalCalls": true,
"recordType": "External",
"callerID": "",
"deliverAudio": false,
"sipID": "",
"reinvite": true,
"replaces": true,
"vmemail": "Notification",
"vmenabled": true,
"vmpin": "165679",
"vmplaycallerid": false,
"vmplaydatetime": "None",
"internal": false,
"noAnswerTimeout": 0
}
{
"num": "100",
"registered": true,
"status": "Free",
"fwdName": "Available",
"fwdMessage": "Custom message1",
"qGlobalStatus": true,
"qStatus": [
{
"num": "801",
"status": true
},
{
"num": "805",
"status": true
}
]
}
{
"count": 3,
"members": [
"520",
"521",
"522"
]
}
{
"count": 2,
"members": [
"520",
"521"
]
}
Set key required
{
"result": true
}
{
"result": true
}
{
"result": true
}
{
"result": true
}
{
"result": true
}
3CX Department management
{
"extGroups": [
"__DEFAULT__",
"Company0",
"Sales",
"___FAVORITES___000"
]
}
{
"count": 3,
"members": [
"101",
"102",
"520"
]
}
{
"result": "system_owners"
}
{
"add": [
"102"
],
"remove": [],
"change": []
}
{
"result": true
}
{
"result": true
}
3CX queue management
{
"count": 2,
"members": [
{
"num": "102",
"name": "Tom",
"lastname": "Smith",
"loggedIn": true
},
{
"num": "104",
"name": "Alex",
"lastname": "Mulder",
"loggedIn": false
}
]
}
{
"nums": [
"100",
"103"
]
}
{
"count": 1,
"members": [
{
"num": "102",
"name": "Tom",
"lastname": "Smith",
"loggedIn": true
}
]
}
{
"count": 1,
"members": [
{
"num": "102",
"name": "Tom",
"lastname": "Smith",
"loggedIn": true
}
]
}
{
"result": true
}
{
"nums": [
"820",
"802",
"804"
]
}
{
"result": true
}
{
"result": true
}
{
"result": true
}
{
"result": true
}
{
"result": true
}
{
"result": true
}
{
"result": "Create queue"
}
{
"result": "Update queue"
}
{
"result": "Delete queue"
}
Full key required
{
"first": "102",
"second": "420774852529"
}
{
"count": 2,
"devices": [
{
"userAgent": "3CX Mobile Client",
"contact": "sip:102@127.0.0.1:5483;rinstance=5a6cb7ecb40359bf"
},
{
"userAgent": "3CX WebRTC proxy",
"contact": "sip:102@127.0.0.1:5063;rinstance=b206569d67c8dd02"
}
]
}
{
"result": "Drop"
}
{
"result": "Answer"
}
{
"result": "Transfer"
}
{
"result": "Join"
}
{
"result": "Barge in"
}
Set or Full key required
{
"id": [
6,
7
]
}
{
"id": 5
}
{
"result": "Delete contact"
}
{
"result": "Update contact"
}
{
"name": "FirstName",
"lastName": "LastName",
"company": "Company",
"crmContactData": "",
"tag": "",
"phone": "Mobile",
"data0": "Mobile2",
"data1": "Home",
"data2": "Home2",
"data3": "Business",
"data4": "Business2",
"data5": "Email",
"data6": "Other",
"data7": "Businessfax",
"data8": "Homefax",
"data9": "Pager"
}
Full key required
{
"result": "Create extension"
}
{
"result": "Delete extension"
}
{
"result": "Update extension"
}
Set or Full key required
{
"count": 6,
"minPriority": 1,
"maxPriority": 6,
"rules": [
{
"priority": 1,
"name": "99 creomate.3cx.eu"
},
{
"priority": 2,
"name": "CZ"
},
{
"priority": 3,
"name": "Serbia"
},
{
"priority": 4,
"name": "North Macedonia 381"
},
{
"priority": 5,
"name": "USA/Canada"
}
{
"priority": 6,
"name": "UK"
}
]
}
{
"name": "UK",
"priority": 13,
"prefix": "44",
"numberLength": "9,10,11",
"groups": [
"__DEFAULT__"
],
"ranges": [
"101",
"102"
],
"numberOfRoutes": 5,
"routes": [
"Zadarma OUT +381 21 322 0030.0..",
".0..",
".0..",
".0..",
".0.."
]
}
{
"result": "Changed outbound rule."
}
{
"result": "Created outbound rule."
}
{
"result": "Deleted outbound rule."
}
{
"type": "IVR",
"internal": "809",
"external": "",
"name": "DID-3810042213220030"
}
{
"result": "Changed inbound rule."
}
{
"result": "Outbound rule moved."
}
{
"result": "Outbound rule moved."
}
System key required
{
"result":"Success"
}
{
"result":"CFD scripts have been reset"
}
{
"name": "VERSION",
"description": "Version",
"value": "20.0.5.384",
"type": 0
}
{
"result": true
}
{
"result": "The parameter list has been removed"
}