OpenVox Document Center OpenVox Document Center
  • Home 
  • Products 
  • Solutions 
  • Resources 
    • Document Center 
    • Datasheets 
    • Firmwares 
    • Videos 
  • Partners 
  • Blog 
  • Company 
OpenVox Document Center OpenVox Document Center
OpenVox Document Center
  • Home 
  • Products 
  • Solutions 
  • Resources 
    • Document Center 
    • Datasheets 
    • Firmwares 
    • Videos 
  • Partners 
  • Blog 
  • Company 

Wireless Gateway

  • folder icon closed folder iconUser Manual
    • SWG-4032 User Manual V2.0
    • VS GWP Series Gateway User Manual V2.0
    • SWG-3008/3016/32 User Manual V2.0
    • SWG-M20X User Manual V2.0
    • GWM401 User Manual V2.0
    • SWG-3008/3016/32 User Manual
    • SWG-M20X User Manual
    • SWG-2016/32 User Manual
    • SWG-3016/32-4S User Manual
    • VoxStack Series Wireless Gateway
  • folder icon closed folder iconAPI
    • SMS API (Get Method)
    • SMS API (Post Method)
  • folder icon closed folder iconApplication Notes
    • GSM Gateways APP Note
      • Expand Callback Function
      • APP Note_AMI
      • How to Bind the GSM Gateway Ports with PBX Sip Extension
      • OpenVox GSM Gateway HTTP Interface
      • How to Integrate the Analog Gateway and the GSM Gateway in One OpenVox Box
      • OpenVox GSM Gateway Function User Manual
      • Openvox HTTP SMS API Demo
      • OpenVox Wireless Gateway Connect with playSMS Manual
      • Remote Server Get CDR from GSM Gateway by AMI
      • VoxStack GSM Gateway API 1.0.0
      • VoxStack GSM Gateway Connect with iCallDrid Manual
      • VoxStack GSM Module Upgrading Guide
  • folder icon closed folder iconFAQ
    • Frequently Asked Questions
  • folder icon closed folder iconFunction Guide
    • The difference between the GWP Series gateway and the old version VS-GW1600/2120 Series gateway
    • Default IP and login information of various Gateways
    • SWG30XX-4S card position switching
    • Cloud Management – How to Connect to Cloud Management
    • Balance Inquiry – How to check the balance of your card on your device
    • How to update firmware when there is a file over limit pop-up
    • how to use smpp via diafaan ?
    • Interaction docking Guide
      • Wireless Gateway connects with 3CX
      • Wireless Gateway connects with asterisk16.15.1
      • Wireless Gateway FAQ connect with UC
      • Wireless Gateway connects with Freepbx15
      • Wireless Gateway connects with FreeSwitch1.10.5
    • Modify secondary dialing voice prompts
    • Product Comparison
    • USSD API Sending – How to send USSD via API
    • Secondary Dialing – How to set up secondary dialing for outbound routing
    • Card switching strategy – how to make the sim card switch according to your expectations
    • Inbound routing, outbound routing
    • Call Forwarding – How to set up call forwarding
    • Call Waiting – How to set up call waiting
    • How to upgrade the system of the gateway
    • How to translate the language of a web page into the language you want
    • How to upload and download gateway configurations
    • How to restore factory settings via web or RST button
    • Turn on call logging and AT logging – How to turn on call logging and AT logging
    • Module Upgrade – How to Upgrade Module System
    • SMS API Delivery – How to send SMS through API
    • SMS Restrictions – How to set SMS restrictions
    • Gateway connection vpn – if connecting to vpn
    • How to Enable HTTPS Certification on Gateway Web
    • CalleeID and callerID Manipulation
    • how to adjust parameter when Volte gateway voice quality is not well
    • how to adjust parameter when gsm gateway voice quality is not well
    • SNMP Guide on Wireless gateway
    • GSM & LTE Modules Frequency and Supported Operators
loading
Popular Searches
  • Array
  • Array
  • Array
  1. Home
  2. Docs
  3. Wireless Gateway
  4. Application Notes
  5. GSM Gateways APP Note
  6. VoxStack GSM Gateway API 1.0.0
Updated on March 29, 2022

Wireless Gateway

  • folder icon closed folder iconUser Manual
    • SWG-4032 User Manual V2.0
    • VS GWP Series Gateway User Manual V2.0
    • SWG-3008/3016/32 User Manual V2.0
    • SWG-M20X User Manual V2.0
    • GWM401 User Manual V2.0
    • SWG-3008/3016/32 User Manual
    • SWG-M20X User Manual
    • SWG-2016/32 User Manual
    • SWG-3016/32-4S User Manual
    • VoxStack Series Wireless Gateway
  • folder icon closed folder iconAPI
    • SMS API (Get Method)
    • SMS API (Post Method)
  • folder icon closed folder iconApplication Notes
    • GSM Gateways APP Note
      • Expand Callback Function
      • APP Note_AMI
      • How to Bind the GSM Gateway Ports with PBX Sip Extension
      • OpenVox GSM Gateway HTTP Interface
      • How to Integrate the Analog Gateway and the GSM Gateway in One OpenVox Box
      • OpenVox GSM Gateway Function User Manual
      • Openvox HTTP SMS API Demo
      • OpenVox Wireless Gateway Connect with playSMS Manual
      • Remote Server Get CDR from GSM Gateway by AMI
      • VoxStack GSM Gateway API 1.0.0
      • VoxStack GSM Gateway Connect with iCallDrid Manual
      • VoxStack GSM Module Upgrading Guide
  • folder icon closed folder iconFAQ
    • Frequently Asked Questions
  • folder icon closed folder iconFunction Guide
    • The difference between the GWP Series gateway and the old version VS-GW1600/2120 Series gateway
    • Default IP and login information of various Gateways
    • SWG30XX-4S card position switching
    • Cloud Management – How to Connect to Cloud Management
    • Balance Inquiry – How to check the balance of your card on your device
    • How to update firmware when there is a file over limit pop-up
    • how to use smpp via diafaan ?
    • Interaction docking Guide
      • Wireless Gateway connects with 3CX
      • Wireless Gateway connects with asterisk16.15.1
      • Wireless Gateway FAQ connect with UC
      • Wireless Gateway connects with Freepbx15
      • Wireless Gateway connects with FreeSwitch1.10.5
    • Modify secondary dialing voice prompts
    • Product Comparison
    • USSD API Sending – How to send USSD via API
    • Secondary Dialing – How to set up secondary dialing for outbound routing
    • Card switching strategy – how to make the sim card switch according to your expectations
    • Inbound routing, outbound routing
    • Call Forwarding – How to set up call forwarding
    • Call Waiting – How to set up call waiting
    • How to upgrade the system of the gateway
    • How to translate the language of a web page into the language you want
    • How to upload and download gateway configurations
    • How to restore factory settings via web or RST button
    • Turn on call logging and AT logging – How to turn on call logging and AT logging
    • Module Upgrade – How to Upgrade Module System
    • SMS API Delivery – How to send SMS through API
    • SMS Restrictions – How to set SMS restrictions
    • Gateway connection vpn – if connecting to vpn
    • How to Enable HTTPS Certification on Gateway Web
    • CalleeID and callerID Manipulation
    • how to adjust parameter when Volte gateway voice quality is not well
    • how to adjust parameter when gsm gateway voice quality is not well
    • SNMP Guide on Wireless gateway
    • GSM & LTE Modules Frequency and Supported Operators

VoxStack GSM Gateway API 1.0.0

Estimated reading: 3 minutes 670 views

1. Configuring AMI in VoxStack GSM Gateway.

1.1 How to configure AMI interface?

Login your gateway with your user account and password, and please follow this flow to configure: ADVANCED–>Asterisk API. Please change the default to yours.

word image 1044

Concerning the ‘permit’ option, if you have one more IP addresses, then you should have junction with them by symbol ‘&’. In the demo test, allowing both servers 172.16.99.16 and 172.16.1.207 to have access to this GSM gateway.

1.2 Defining read/write authorization for various event classes.

word image 1045

In this illustration, you will be able to define custom authorization for various event classes. Read authorization permits you to receive asynchronous events, in general. Write authorization permits you to send commands and get back responses.

2. Monitoring and managing your Asterisk over Asterisk Manager Interface (AMI).

2.1 Using telnet to demonstrate AMI connectivity over TCP socket.

a. Connect to the AMI over a TCP socket on port 5038.

b. Log in using the login action and your user account.

c. Execute the Ping action .

Here’s how to get access to the gateway and some responds for the actions from AMI.

word image 1046

2.2 Introduction of SMS sending command

gsm send syncsms <span> <destination> <message> <timeout> [id]

word image 1047

 

2.2 Starting to send SMS over command action by value “gsm send syscsms …” .With regard to the SMS ID, you will be able to set it by yourself, or take ActionID to be your SMS ID.

word image 1048 word image 1049 word image 1050

 

2.3 Introduction of Manager Action Ping.

word image 1051

2.4 Completed transaction of AMI when a short message comes in.

word image 1052 word image 1053 word image 1054

In the whole transaction, you can find a code segment as the following. This section is the most important when you would like to monitor the incoming short message. Asterisk (Gateway core) will report a new event to the client.

word image 1055 word image 1056 word image 1057

If TCP socket connection is still alive. And you receive both parameters Newexten and sms, which indicate that there is a new short message comes in. You will be able to use Ping action to check if your connection is alive or not, and monitor the incoming short message by these two events.

2.5 AMI over TCP for Windows

Yes, you can get access to your GSM Gateway over AMI protocol in Windows system. Please follow thisflow: Click Start–>Run–>Open, at the input text box, type ‘cmd’ to enter a Windows console.

word image 1058

Hit the [Enter], and it will automatically skip to the next illustration.

word image 1059 word image 1060

In this demo, I sent a short message to be outside by action command.

2.6. Using PHP script to send short message over AMI protocol.

Before doing this, please download phpagi target from website: http://sourceforge.net/projects/phpagi/, and place it to /var/lib/asterisk/agi-bin. Give execute permission to the file. Based on my experience, if your PHP version is higher than 5.3, you MUST rename the function goto in phpagi.php.

Here’s demo script voxstack_sms.php:

word image 1061 word image 1062

3. Introduction of USSD sending command.

gsm send ussd <span> <message> [timeout]

word image 1063

 

 

Still stuck? How can we help?

Was this page helpful? Yes No

How can we help?

Leave a Comment Cancel reply

CONTENTS

Copyright © 2002-2024 OpenVox all rights reserved.