Grandstream api documentation. Prerequisites You must have an admin account (i.

Grandstream api documentation Hidden label Grandstream Device Certificate Update Guide; WP810/WP822/WP825 – Administration Guide; Click For More. Additionally, legacy CDR API, REC API and PMS API in addition to QUEUE API are included Mar 15, 2024 · Firmware Supported: GSC3610/GSC3615: 1. Cloud: Cloud based Access Points Controller GWN Manager: On-premise Access Points Controller API Developer Seamless integration of audio and video call functions into applications in various industries, such as online education, virtual healthcare, e-commerce, remote justice service, office automation, etc. For more information on how to accomplish these methods, please visit: SIP Device Provisioning Guide – Documentation Center (grandstream. Please refer to the related firmware Release Note for the supported functions. This document explains in detail the external HTTP-based application programming interface and parameters of functions via the supported method. 0. Jan 4, 2021 · I have [UCM6208] and I need to be able to make a call through the grandstream api. com Ensure your Grandstream Firewall is always up to date. API & SDK . Integrating add-ins into Wave Desktop brings convenience which improves the unified collaboration experience. Jun 14, 2024 · OAuth Consent Configuration. The UCM6XXX series can be integrated with different CRMs including ACT! CRM allowing users to get full information about API GXV33XX & WP820 – Web API User Guide; GXV33xx & WP820 – GS Android SDK; Click For More. May 6, 2021 · 2. Latest firmware The GXW4200 Series documentation provides detailed information on the features and functionalities of Grandstream Networks' high-density FXS gateway series. Grandstream reserves the right to remedy warranty policy without prior notification. getAllSipAccounts . This guide contains a step-by-step configuration needed to set up Salesforce CRM with the UCM6XXX. Create new network group, AP device, SSID. act365. 5 or higher Feb 9, 2024 · The Grandstream UCM6300 series IP PBX is based on Asterisk 16 system. Technical Bulletins OVERVIEW GBX20 delivers additional functionality, versatility, and flexibility to Grandstream-compatible phones. Robust HTTPS API for UCM System Management. Starting from firmware 1. World region/EU region/CN region), or multiple platforms (GDMS/GWN. This document describes how to use the APIs for users’ application development on GXV3470/GXV3480/GXV3450 and GSC3574/3575. For UCM6116, DAHDI/(1-16) are FXO ports, and DAHDI/(17-18) are FXS ports. PMS API is supported The UCM62xx/6510 provides a new API interface to query, edit PBX settings and implement multiple call functions on another server connected to it via API. 54 Last Updated: 10/2015 Please refer to related WebGUI page for reference if unsure about the HTTP API. GDMS API provides many functional interfaces for third-party websites or applications. Installation GRP261x, GRP262x, GRP263x, GRP2650 & GRP2670 Series . Users can manage devices on GDMS, manage SIP accounts, configure accounts for devices, configure parameters, query device status, etc. 19 Page | 6 SUPPORTED DEVICES The following table shows GSC36XX Grandstream products supporting HTTP API covered in this guide: Model Firmware GSC3610 1. 3 Added Pvalues P15508 and P15509 for Abnormal Door Control. Please refer to the end device documentation on how to send and receive SMS messages. 1. Besides inheriting the Android interface functions, more interfaces have been supported from users requirements. Cloud), you can merge your accounts and use one account to login and manage all Grandstream devices for multiple regions or platforms. The WP820 supports an XML-based downloadable phonebook that could be easily shared and maintained remotely via its built-in web interface. In this section we will configure the types of users which can use the API integration. Grandstream Video Surveillance HTTP API Page 7 of 62 www. Unfortunately, the API is quite cryptic and anything but intuitive to use, and their documentation is rather confusing and leaves a lot to be desired. g. The GDS3710 is an IP Video Door System that also serves as a high-definition IP surveillance camera and IP intercom to offer facility access control and security monitoring for buildings of all sizes. Using the phone Account API can be used to obtain account information, modify account information and monitor account changes. 1. 2. 8 GSC3620 1. com) Step 3: Sending sip NOTIFY to the phone. World region/EU Grandstream Networks, Inc. PRODUCT OVERVIEW Feature GSC36XX HTTP API Guide Version 1. initial account) for multiple regions (e. Note: Grandstream configuration file can be generated in two different ways. Installation Grandstream Networks API & SDK . Hidden label Thank you for purchasing Grandstream Small Business IP phone GXP1610/GXP1615/GXP1620/ GXP1625/GXP1628/GXP1630. grandstream. [Alarm Config] Added Pvalues P15506 and P15507 for Holiday Mode [Keep Door Open] HTTP API Version 1. In addition, the GXV33XX supports importing and exporting of Sep 15, 2023 · Grandstream configuration file can be generated in two different ways. com Last Updated: 09/2010 Figure 1: GMI Working Model GRP261x, GRP262x, GRP263x, GRP2650 & GRP2670 Series . Other than the web interface access for administrators, Grandstream UCM6xxx IP-PBX series offer to each extension a “User Portal” allowing Call Barging UCM6xxx series support the “Call barging” feature allowing users to drop in on a live call. 5. HSC, Mitel, HMobile) providing following hospitality features: Changing Display Name, Permission, Call forwarding, DND and more. By utilizing a Grandstream encoder tool (Java API is available) By Creating an XML text file. Installation Along with Grandstream videophone, mobile Apps, and Network Video Recorder (NVR), the GDS3710 provides a powerful recording and monitoring solution. 8 or higher GSC3615 1. Hidden label Overview All Grandstream products’ firmware are improved and updated on a regular basis. Hidden label WELCOME Thank you for purchasing Grandstream GAC2570 Audio Conferencing Systems. Extension Groups Tools and resources on all Grandstream products. In case the user initiates a call from the group chat, a meeting will be created once the call has started. Heartbeat Packet With heartbeat packet, Yeastar S-Series VoIP PBX can update IP, Port, and URL of the connected 3rd party application server if there are any changes. 8 or higher GSC3620 1. While there are currently no issues with using UCM’s existing CDR tools are for generating reports, it is highly recommended to eventually implement integration with CDR Real-Time Output, which ensures that no records Oct 2, 2024 · WELCOME Thank you for purchasing Grandstream GDS3710/GDS3712. This series is convenient and fast to The UCM6XXX series support two CRM API, SugarCRM and Salesforce CRM, allowing users to get full information about their contacts, customers and leads, and save call information details to specific table history for further usage. The HTTP API is firmware dependent. In the sidebar on the left, select “Credentials”. Customize for Your Business Personalize your CloudUCM solution with custom domain names, company logos, contacts, and more. Installation WELCOME Thank you for using the Grandstream Wave mobile app. GUI Customization Tool: GXV3350, GXV3370, GXV3380, GXV3240/3275, GVC3200/3202 and GAC2500 allow users to customize the GUI desktop layout as well as GUI configurations on the phone, offering users with flexibility and control. For starters: Multiple sets of keys (secrets, passwords) are required to use the API; An Feb 20, 2024 · The WP820 supports a phonebook that can hold up to 1000 records. [Alarm Config] Added new HTTP API for abnormal door control. Dec 24, 2024 · The IPPBX provides built-in SIP SMS message support. Besides LDAP support and manually editing from LCD or Web GUI, the GXP21xx/GXP14xx/GXP116x offers this user-friendly XML API as a download/upload method via the phone's web GUI. For the use of small and medium properties without Oct 31, 2024 · Select the enabled APIs link in the API section to see all the enabled APIs. Users can refer to this documentation to implement network management and device management, voucher management, Portal management, statistics, etc. For the ease of efficient deployment and management, the XML phone book file could be stored on a web Grandstream GNU GPL related source code can be downloaded from Grandstream Web site from: API/SDK available for advanced custom application development. Note Please note that to be able to use the 3rd party integrations, the UCM should be GRP261x, GRP262x, GRP263x, GRP2650 & GRP2670 Series . TR-069 stands for a “Technical Report” defined by the Broadband Forum that specifies the CWMP “CPE WAN Management Protocol”. GMI HTML SDK and API Guide Page 3 of 43 www. GWN Management Platforms GWN. 16 on UCM62xx/UCM6510 and starting from firmware 1. Grandstream GXV3370/GXV3380/GXV3350/WP820 WEB API User Guide Q API Developer O About GDMS API Developer Enterprises can enable API Developer Mode to invoke various GDMS features via API in third-party applications. Line Status api-get_line_status Retrieves line status of the phone Phone Status api-get_phone_status Retrieves phone status Phone Operations api-phone_operation Sends phone operations commands (hang up, answer call, reject call…) Send Keys api-send_key Sends keys functions (speaker, volume up, volume down, mute, hold, 0-9… ) System Operations GRP261x, GRP262x, GRP263x, GRP2650 & GRP2670 Series . The API & SDK . Send a request to the UCM to get a Challenge string. Entering 1000 phonebook records through the phone keypad is a time-consuming and error-prone task. 20, PMS API is now supported to offer Hotel action with the UCM6200 & UCM6510 via HTTPS API. Installation Oct 14, 2024 · Users can use Grandstream Wave web for point-to-point audio and video calls. Please refer to all APIs in the API overview. This audio door system features dual microphones and HD loudspeaker with advanced AEC to offer intercom functionality, can Sep 15, 2023 · Click2Call feature provides a method for UCM630x users with a remote connect plan to embed a simple click2call link into their websites, to enable their web visitors to call live agents from their browsers by adding a shortcode into the web page source and configure a Call queue on the UCM to receive those calls. Data the action data that will be used. Installation The Grandstream GXP16xx/GXP17xx/GXP21xx support XML based downloadable phone book for users to share and maintain a phone book remotely easily. API interfaces include but are not limited to: querying device lists, assigning account numbers to devices, configuring GRP261x, GRP262x, GRP263x, GRP2650 & GRP2670 Series . GRP261x, GRP262x, GRP263x, GRP2650 & GRP2670 Series Installation GRP2611G – Quick Installation Guide; GRP2610/P – Quick Installation Guide API & SDK . GDMS Unified Communications separates systems independently based on different product lines: Unified Communication solution and the Networking solution. 7 / GDS3705 Firmware 1. Nov 21, 2024 · Supported by Grandstream Device Management System (GDMS), a zero-touch cloud provisioning and management system, It provides a centralized interface to provision, manage, monitor, and troubleshoot Grandstream products API & SDK . Account Information You can get all account information by using BaseAccountApi. Besides directly importing VCard/CSV format contacts, loading contacts from synced-up accounts and manually editing from LCD or web UI, the GVC32XX offers this XML API as a user-friendly download method via Sep 30, 2024 · OVERVIEW Wave Desktop offers third-party integrations with productivity add-ins to have these tools accessible directly on Wave Desktop, without having to switch constantly between tools. 3. Navigate to Profile → Apps&Integrations and look at the API Key field. It Sep 15, 2023 · Property Management System is a software application used in the hospitality industry to automate some hotel functions such as guest booking, guest details, etc… The system can be divided into two parts: PMS (Property Management System) PMSI (Property Management System Interface) PBX Grandstream UCM6XXX series have integrated HSC PMS providing the following hospitality features: Changing Handset Status api-get_hs_status Retrieves handset status Handset Line Status api-get_hs_line_status Retrieves handset line status Make Call api-make_call Make a call using a specific handset Device Operations api-device_operation Sends device operations commands: mute, speaker, setdnd… Functions used on all models Send Keys api-send_key HTTP API Version 1. Featuring GbE RJ-45 and SFP ports, it enables high-speed multi-WAN port connectivity for enterprises. a. After logging in to Grandstream Wave web, click on Calls icon . Note: This guide is designed for experienced administrators with a strong understanding of network protocols, including HTTP/HTTPS and redirection techniques. 23 GWN API provides multiple API for third-party web and app development. This is the API key that will be used. The GSC3620 is a ceiling-mounted fixed dome IP camera with a 3. It can be managed with GSURF Pro or any ONVIF-compliant video management system. For SIP end devices such as Grandstream GXP or GXV phones that support SIP messages, after a IPPBX account is registered on the end device, the user can send and receive SMS messages. 4G/5G Wi-Fi, integrated Bluetooth, high fidelity 8W speaker and a multi-purpose input port supporting a wide range of Grandstream provides an API for GDMS which developers can use to automate interfacing with the GDMS. Jan 29, 2025 · To get started with UCM’s API feature, users must configure the HTTPS API settings and get familiar with the feature’s communication method, request structure, response messages, and event reports. UCM will actively send system reports and call reports to this other server. GXP16xx series is a next Dec 23, 2024 · GCC601X(W) series are defined as mid-range all-in-one convergence devices. A) By utilizing a Grandstream encoder tool (Java API is available) or B) Creating an XML Mar 15, 2024 · WELCOME Thank you for purchasing Grand stream’s GSC3620 FHD IP Dome Camera, the innovative powerful weatherproof Vari-focal and Auto-Focus camera. Thanks a lot Mar 15, 2024 · Along with Grandstream videophone, mobile Apps, and Network Video Recorder (NVR), the GDS3710 provides a powerful recording and monitoring solution. 25 Product Name: GDS3710 Firmware 1. The API format is defined by Grandstream and this guide will help users configure and authenticate in order to use PMSAPI. Oct 2, 2024 · LDAP (Lightweight Directory Access Protocol) is a client/server protocol used to access and manage directory information over Internet Protocol, the core LDAP specifications are defined in RFC4511. Using the phone Page | 3 HT818 User Guide Version 1. It provides powerful functions, a friendly interface for remote management, and an easy-to-expand all-in-one communication solution to enterprises of all sizes. Extension Groups Oct 24, 2023 · CTI (Computer-Telephony Integration) provides the ability to manage phone calls from a computer including basic call operations such as making and answering calls, and advanced call operations such as call forward, conference, call hold, and more. Usage Requirements Microsoft account with global administrator permissions Oct 27, 2023 · The Grandstream GXP16xx/GXP17xx/GXP21xx support XML based downloadable phonebook for users to share and maintain a phonebook remotely easily. Cloud Controller for Grandstream’s Networking Products Grandstream Networks, Inc. Make sure that “calendar API” is on the list of enabled APIs. Installation Dec 25, 2024 · The CloudUCM provides built-in SIP SMS message support. 19. GSC36XX HTTP API Guide Version 1. Documentation Center. 6mm lens - making it an ideal device for wide-angle monitoring of nearby subjects in environments such as banks, hotels, retail stores, offices, warehouses, Nov 22, 2024 · WELCOME Thank you for purchasing Grandstream GSC3510/GSC3505 SIP Intercom speakers. There are also applications that require a centralized directory server and have all Ruby API client for Grand Stream IP cameras. Grandstream Networks, Inc. API & SDK GXV33XX & WP820 – Web API User Guide; GXV33xx & WP820 – GS Android SDK; Click For More. The GXV33XX supports an XML-based downloadable phonebook that could be easily shared and maintained remotely via its built-in web interface. The UCM provides a new API interface to query, edit PBX settings and implement multiple call functions on another server Mar 15, 2024 · GDMS API allows the users to perform a number of actions using HTTPS requests, this makes it easier for the user to automate the process and issue a large number of commands. Contribute to ViaoV/grandstream_camera development by creating an account on GitHub. 23 Page | 5 UCM6XXX Asterisk Manager Interface (AMI) Guide Table 1: AMI User Privilege Privilege Option Definition All This provides all privilege options to user. Prerequisites You must have an admin account (i. If you have not enabled it, select API from the list of APIs, then select the Enable API button for the API. Establish Connection and User Authentication. Installation The Grandstream GXP21xx/GXP14xx/GXP116x supports XML based downloadable phone book for users to share and maintain a phone book via the web easily. Use scenarios: 1. To proceed with this step, you will need an API platform. If no key is found, click on the Regenerate API Key button to create one. Resources. For the ease of efficient deployment and management, the XML phonebook file could be stored on a web server for the phones to download. Wave is a free mobile app that provides remote voice Wave Desktop CRM Add-ins – User Guide OVERVIEW Customer Relationship Management (CRM) is centered on the management of customer data and helps the enterprise to keep updating Introduction Fast Provisioning is a feature available on the GCC6000 convergence devices, its main purpose is to facilitate the process Aug 27, 2024 · OVERVIEW GXV3470/GXV3480/GXV3450 and GSC3574/3575 operating system is developed based on AndroidTM platform. 4 Table of Content DOCUMENT PURPOSE. Integrates VPN Router, NGFW, Switch or Wi-Fi AP, and IP PBX, covering the collaborative office capabilities of data communication and UC audio and video service. In other words, an LDAP Phone Status api-get_phone_status Retrieves phone status Phone Operations api-phone_operation Sends phone operations commands (hang up, answer call, reject call…) Send Keys api-send_key Sends keys functions (speaker, volume up, volume down, mute, hold, 0-9… ) System Operations api-sys_operation Sends system operations commands (reset Oct 2, 2024 · What is TR-069? It is a protocol for communication between CPE (Customer Premise Equipment) and an ACS (Auto Configuration Server) that provides secure auto-configuration as well as other CPE management functions within a common framework. Feb 21, 2024 · The Grandstream GVC32XX Full HD Video Conferencing System supports XML based downloadable phonebook for users to share and maintain a phonebook remotely with ease. com 2. GDMS is an enterprise-grade, remote management platform for Grandstream networking products, unified communications products, all-in-one solutions, UCMRC, CloudUCM, etc. Feb 20, 2024 · Overview This document explains in detail the external HTTP-based application programming interface and parameters of functions via the supported method. The Grandstream GXP2130/GXP2140/GXP2160 support XML based downloadable phone book for users to share and maintain a phone book remotely easily. 17. on the bottom left of the page to bring up the keypad. 5 or higher Jan 20, 2025 · Overview Grandstream IPPBX supports integration with Microsoft Outlook, allowing users to receive important email notifications directly from the PBX. Just as a Database Management System is used to process queries and updates to a database, an LDAP server behave the same way. . API interfaces include but are not limited to: querying device lists, assigning account numbers to devices, configuring Overview This guide provides detailed instructions on implementing the External Captive Portal API (EXCAP) on your server, enabling customized and secure authentication workflows for wireless network users. 35. I need someone to recommend the documentation or example to me to guide me. 7. e. Compatibility WP820 Bluetooth Headsets Compatibility List; CloudUCM CGI API: Configure CloudUCM settings and features while monitoring detailed information via API. It also offers a flexible HTTP API for easy integration with 3rd party applications and other surveillance systems. Refer to [DATA FORMAT ] UCM6XXX CDR and REC API Guide For UCM6108/6208, DAHDI/(1-8) are FXO ports, and DAHDI(9-10) are FXS ports. This guide describes setting up and configuring the authentication between Grandstream IPPBX and Microsoft Outlook, ensuring efficient and secure email communication. Log into your ACT! 365 account at https://app. This powerful IP Video Door System offers a 180-degree video viewing angle for wall-to-wall coverage, Grandstream Networks, Inc. Click “Create New Client ID”. For the ease of efficient deployment and management, the XML phone book file could be stored on a web Nov 4, 2020 · This is probably too late to help the OP, but lots of people have actually been having trouble with the GDMS API. com Version 1. Cloud accounts in multiple regions (e. Grandstream DP75X, GXP16XX, GXP17XX, and GXP21XX series support CTI operations and commands providing complete control over phone calls from Jan 20, 2025 · Thank you for using Grandstream Device Management System! GDMS Unified Communications is a cloud-based solution that provides the ability to easily manage Grandstream products before, during, and after deployment. When the code and the group number are dialed together in the combination of code + group number, the specified voice message is sent to all group members and only extensions in Enable API access on the Yeastar S-Series VoIP PBX, then access the PBX by the API username and the encrypted MD5 API password. I've been able to work with Grandstream to get some of their documentation improved and I've put together a simple SDK that can be used to use the API (or as a reference), if anyone else has similar struggles: github. Technical Bulletins GXV33xx/GXV34xx Power Consumption; Overview If you have GWN. The GSC3505 is a one-way SIP Intercom Speaker and GSC3510 is a two-way full-duplex SIP intercom speaker/microphone, both featuring one 100Mbps Ethernet port with PoE/PoE+, integrated dual-band 2. The GAC2570 is a full Nov 21, 2024 · If the phone was purchased directly from Grandstream, contact the Grandstream Support for a RMA (Return Materials Authorization) number before the product is returned. The implemented web APIs abide by RESTful API style, supporting GET and POST HTTP request types that Jan 7, 2025 · Supported by Grandstream Device Management System (GDMS), a zero-touch cloud provisioning and management system, It provides a centralized interface to provision, manage, monitor, and troubleshoot Grandstream products Oct 17, 2024 · Property Management System or PMS is a software application used in the hospitality industry to automate some hotel functions such as guest booking, guest details, etc… Grandstream UCM6XXX series have integrated multiple PMS platforms (i. It also offers a flexible HTTP API for easy integration with 3 rd party applications and other surveillance systems. On the console of Google Cloud, on the side bar, click on “OAuth consent screen” as shown in the screenshot below, then select “Internal User” as the User Type. Initiating a Call from Keypad. API . GSC361X Series FHD Infrared Weatherproof, IP Dome/Box Camera User Manual GSC3610 GSC3615 Jul 2, 2024 · UCM6xxx series introduced the “Announcement Center” feature allowing to initiate calls and play a pre-configured voice prompt to extensions within the same group. To get started with UCM’s API feature, users must configure the HTTPS API settings and get familiar with the feature’s communication method, request structure, response messages, and event reports. Hidden label . 5 Grandstream GSC36xx Interface HTTP API (Application Programming Interface) supports RFC3550 (RTP). Note Before starting the API demo or testing May 15, 2024 · Property Management System (PMS) is a software application used in the hospitality industry to automate some hotel functions such as guest booking, guest details, etc… Grandstream UCM63XX series has integrated a lightweight Local PMS providing the following hospitality features: set Room Status, Wake-up call, and more. Installation enerate API Key To acquire the API key, please follow the steps below: 1. Please refer to the related firmware Release Note for The UCM provides a new API interface to query, edit PBX settings and implement multiple call functions on another server AMI (Asterisk Management Interface) Asterisk Manager Interface (AMI) allows a client program to connect to an Asterisk instance and issue commands or read events Overview GDMS API allows the users to perform a number of actions using HTTPS requests, this makes it easier for The UCM6xxx provides a new API interface to query, edit PBX settings and implement multiple call functions on another server AMI (Asterisk Management Interface) Asterisk Manager Interface (AMI) allows a client program to connect to an Asterisk instance and issue commands or read events Convergence Solution Unified Communications Networking Solutions Facility Management Solution Business Conferencing Solution Handset Status api-get_hs_status Retrieves handset status Handset Line Status api-get_hs_line_status Retrieves handset line status Make Call api-make_call Make a call using a specific handset Device Operations api-device_operation Sends device operations commands: mute, speaker, setdnd… Functions used on all models Send Keys api-send_key Page | 6 UCM6XXX CDR and REC API Guide • Answer time • End time • Call time • Talk time • Source channel • Dest channel • Last app Grandstream Networks, Inc. 4 on UCM630xA. Overview GWN API allows users or enterprises to perform a number of actions using HTTPS requests to invoke various features api & sdk GXV33XX & WP820 – Web API User Guide Overview This document explains in detail the external HTTP-based application programming interface and parameters of functions via the supported method. Compatibility . Installation Aug 5, 2024 · WELCOME Thank you for purchasing Grandstream GDS370x Audio Door Access System, The GDS3705 was built for users looking for a strong audio-only facility access and security monitoring solution that can be deployed in environments of all sizes. through the API interface of this document. Installation Feb 20, 2024 · The GXV33XX supports a phonebook that can hold up to 1000 records. Q API Developer O About GDMS API Developer Enterprises can enable API Developer Mode to invoke various GDMS features via API in third-party applications. HTTP API Version 1. In addition, the WP820 supports importing and exporting both Sep 15, 2023 · Customer relationship management (CRM) is a set of practices, strategies and technologies that companies use to manage and analyze customer interactions and data throughout the customer lifecycle, with the goal of improving business relationships with customers. For SIP end devices such as Grandstream GXP or GXV phones that support SIP messages, after a CloudUCM account is registered on the end device, the user can send and receive SMS messages. Pre-conditions A dedicated Grandstream Networks, Inc. GRP261x, GRP262x, GRP263x, GRP2650 & GRP2670 Series . Grandstream GXV3370/GXV3380/GXV3350/WP820 WEB API User Guide Sep 15, 2023 · This document introduces the CDR Real-Time Output feature added starting from firmware 1. pclz dvbnmhb pjai sehtwv ejhe ljxsgq yqmn ugupbdn drcqqbc bzga yeboz yyfa wikf dbat gxvkcyid