Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagexml
titleResponse example on a query getelement for GSM modem elementgetgsm
<gsm imei="123456" state="normal" pin="1111" status="registered, home network" creg="1" csq="12" cops="Aqua3" allowed="+65214567788 +32154897744" smsc="59537322611" >
	 signal="54%" operator="Aqua3" smsc="59537322611" modem_lte="1" state_lte="normal" >
	<operators_list>
		<operator select="1" disp="Automatic selection" name="auto" num="0" act="0" />
		<operator select="0" disp="Operator1 2G/2G+" name="opone" num="12345" act="0" />
		<operator select="0" disp="Operator2 3G" name="optwo" num="56789" act="7" />
	</operators_list>
	<sms_list>
		<sms id="2545109407" to="+65214567788" textmessage="test message 1" status="failed" date="1563176384" />
		<sms id="3784153937" to="+98521141100" textmessage="test message A" status="pending" date="1563176803" />
		<sms id="1598774555" to="+98521563322" textmessage="test message 3" status="sent" date="1563177201" />
	</sms_list>
</gsm>

...

  • gsm - SGM modem settings and status:
    • imei - IMEI unique code;
    • state - state of modem (alarm, normal, not connected);
    • pinSIM's PIN code;
    • allowed - list of numbers from which SMS commands are allowed, separator - space (example: +72224443434, +72224443435);
    • smsc - the number of the SMS center, this field is empty if the number is determined automatically;
    • creg status - network registration status code:
      0 - not registered, modem is not currently searching a new operator to register tostring;
    • 1 - registered, home networksignal - signal strength in the network string;
    • 2 - not registered, but modem is currently searching a new operator to register to;
    • 3 - registration denied;
    • 4 - unknown;
    • 5 - registered, roaming.
    • csq - signal strength in the network:
      • 0 – -113 dBm or less;

      • 1 – -111 dBm;
      • 2...30 – -109... -53 dBm;
      • 31 – -51 dBm or greater;
      • 99 – not known or not detectable;
      • 100 – -116 dBm or less;
      • 101 – -115 dBm;
      • 102...191 – -114... -26dBm.
    • cops - current operator nameoperator - current operator name;
    • modem_lte - modem LTE support;
    • state_lte - if modem is supported LTE mode, then it is state of LTE connection (alarm, normal, not connected).
  • operators_list - list of available GSM network operators, for user selection:
    • operator - operator selection parameters:
      • select - actual select (0 / 1);
      • disp - text string for user view;
      • name - internal name of operator;
      • num - internal numeric code of operator;
      • act - connection mode.
  • sms_list - queue of sent SMS;:
    • sms - SMS in the queue:
      • id - identifier of SMS in the queue;
      • status - SMS status:
        • pending - added to the queue, waiting for sending;
        • failed - could not be sent;
        • send - sent.
      • to - phone number of the SMS's recipient;
    text
      • message - SMS text;
      • date - the time when added to the queue in UTS.


setgsm - set GSM modem parameters, additional fields are:

  • k - user session ID;
  • pin - SIM's PIN code;
  • smsc - the number of the SMS center, leave this field blank for automatic determination;

    allowed - list of numbers from which SMS commands are allowed, separator - space (example: +72224443434, +72224443435);

    .


setoperators - selecting of corresponding operator, parameters:

  • k - user session ID;
  • name - internal name of operator, from <operators_list>;
  • num - internal numeric code of operator, from <operators_list>;
  • act - connection mode, from <operators_list>.

newoperators - renew list of available operators. The list of operators requires a long time to update (30 second and more). This request should not be called frequently.

  • k - user session ID.


send_sms_message - send SMS via GSM modem, message add to SMS queue, parameters:

...

  • k - user session ID;
  • to_phone - the balance service number.


Code Block
languagexml
titleAnswerResponse example on a USSD request
<ussd text="Account balance 55.6$. Some kind of advertisement here" />
<ussd text="Error parsing ussd answer" />
<ussd text="Request not supported in LTE mode" />

...