3CX WebAPI Documentation and examples

3CX WebAPI Postman Examples

Get Methods

Get Active Calls

https://{{3CXFQDN}}/webapi/{{AccessKey}}/pbx.callsinfo


                        

                    

                    

                        

                            
Get Number of Active Calls

                            

                            
https://{{3CXFQDN}}/webapi/{{AccessKey}}/pbx.calls

                            

                        

                    

                    

                        

                            
Get Active Calls By ID

                            

                            
https://{{3CXFQDN}}/webapi/{{AccessKey}}/pbx.activesbycallid

                            

                        

                    

                    

                        

                            
Get All Extensions

                            

                            
https://{{3CXFQDN}}/webapi/{{AccessKey}}/all.ext

                            

                        

                    

                    

                        

                            

                                Get All Registered Extensions
                            

                            

                            
https://{{3CXFQDN}}/webapi/{{AccessKey}}/all.registered

                            

                        

                    

                    

                        

                            

                                Get Ring Groups
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/all.group
                            

                            

                        

                    

                    

                        

                            

                                Get All Queue Numbers
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/all.queue
                            

                            

                        

                    

                    

                        

                            

                                Get All IVR Numbers
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/all.ivr
                            

                            

                        

                    

                    

                        

                            

                                Get All Trunk Numbers
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/all.line
                            

                            

                        

                    

                    

                        

                            

                                Get All Extension Groups
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/all.extgroup
                            

                            

                        

                    

                    

                        

                            

                                Get Extension Information
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/ext.info?num=1001
                            

                            

                        

                    

                    

                        

                            

                                Get Extension Current Information
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/ext.state?num=1001
                            

                            

                        

                    

                    

                        

                            

                                Get Queue Members
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/queue.members?num=820
                            

                            

                        

                    

                    

                        

                            

                                Get Free Queue Members That Logged In Queue
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/queue.free?num=8000
                            

                            

                        

                    

                    

                        

                            

                                Get Active Calls For Related Queue
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/queue.talk?num=8000
                            

                            

                        

                    

                    
                    

                        

                            

                                Is Queue Available?
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/queue.isfree?num=8000
                            

                            

                        

                    

                    

                        

                            

                                Get Ring Group Members
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/group.members?num=860
                            

                            

                        

                    

                    

                        

                            

                                Get Ring Group Members That Can Accept Call
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/group.free?num=860
                            

                            

                        

                    

                    

                        

                            

                                Get Ring Group Members That Can Accept Call
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/extgroup.members?name=__DEFAULT__
                            

                            

                        

                    

                    

                

            

            

            

                
Set Methods

                

                    

                        

                            

                                Set Extension Forwarding Status
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/ext.fwd.set?num=1010&status=Available
                            

                            

                        

                    

                    

                        

                            

                                Set Extension Global Queue Status
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/ext.queueglobal.set?num=1010&log=ON
                            

                            

                        

                    

                    

                        

                            

                                Set Extension Related Queue Status
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/ext.queue.set?num=1010&queue=8000&log=OFF
                            

                            

                        

                    

                    

                        

                            

                                Set Extension Recording Option
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/ext.options.set?num=1010&enabled=ON&external=ON&recording=OFF
                            

                            

                        

                    

                

            

            

            

                
Call Control Methods

                

                    

                        

                            

                                Make Call
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/makecall?firstnum=1010&secondnum=05554443322
                            

                            

                        

                    

                    

                        

                            

                                Answer Call
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/answer?num=1010
                            

                            

                        

                    

                    

                        

                            

                                Drop Call
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/drop?num=1000&contact
                            

                            

                        

                    

                    

                        

                            

                                Blind Transfer
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/transfer?num=1010&dest=05554443322&contact
                            

                            

                        

                    

                    

                        

                            

                                Join Calls
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/join?num=1010
                            

                            

                        

                    

                    

                        

                            

                                Desk Phone Information For Related Extension
                            

                            

                            

                                https://{{3CXFQDN}}/webapi/{{AccessKey}}/ext.devices?num=204