Admin

MIRS

Sending a Text Message to a Caller

Overview
When sending a text message to a caller, your HTTP endpoint sends the data via a GET method to the NGGT service endpoint. The GET method sends information via the HTTP URL as name=value pairs in the query string of the HTTP request.
GET Request
With the programming language of your choice, you send request.

    {NggtServiceEndpoint}/send.mir.php?auth={AuthorizationCode}&stid={StationId}&body={Text+Message+to+Caller}&tn={CallerPhoneNumber}
Query String Parameters (complete list upon Registration)
Parameter Name Description
Authorization Code

auth

Unique access key for your HTTP endpoint (URL)
Caller Phone Number

tn

Country Code + 10 digits (e.g. +14071234567)
Station Id

stid

Unique identifier for your HTTP endpoint (URL)
Text

body

Message to Caller (maximum 140 characters, encoded)
Notes
  • Please Register for access to the complete MIRS API Documentation
  • The NGGT MIRS service sends and receives 8-bit Unicode (UTF-8) characters, including letters with diacritical marks (accents)

Receiving a Text Message from a Caller

Overview
When a caller sends a text/media message, your HTTP Endpoint receives the data via a POST method from the NGGT service. The POST method sends information via the HTTP header as name/value pairs sent within the body of the HTTP request.
Accessing POST Values
With the programming language of your choice, you access the POST values. For example, in PHP:

    $callerPhoneNumber = $_POST['from'];
Response Parameters (complete list upon Registration)
Parameter Name Description
Authorization Code

auth

Unique access key for your HTTP endpoint (URL)
Caller Phone Number

from

Country Code + 10 digits (e.g. +14071234567)
Station Id

stid

Unique identifier for your Http Endpoint (URL)
Text

body

Message from Caller (maximum 140 characters, encoded)
Content type of media

MediaContentType0

e.g. image/jpeg
Location of media

MediaUrl0

e.g. {NggtMediaUrl}/MediaFilename
Number of media

NumMedia

e.g. 1
Notes
  • Please Register for access to the complete MIRS API Documentation
  • The NGGT MIRS service sends and receives 8-bit Unicode (UTF-8) characters, including letters with diacritical marks (accents)

Sending a Text Message with Media to a First Responder

Overview
After receiving a text with media from a caller, you send a text/media message to a First Responder. To accomplish this, your HTTP endpoint sends the data via a GET method to the NGGT service endpoint. The GET method sends information via the HTTP URL as name=value pairs in the query string of the HTTP request.
GET Request
With the programming language of your choice, you send request.

    {NggtServiceEndpoint}/send.mir.mms.php?auth={AuthorizationCode}&stid={StationId}&body={Text+Message+to+Caller}&tn={CallerPhoneNumber}
Query String Parameters (complete list upon Registration)
Parameter Name Description
Authorization Code

auth

Unique access key for your HTTP endpoint (URL)
Caller Phone Number

tn

Country Code + 10 digits (e.g. +14071234567)
Station Id

stid

Unique identifier for your HTTP endpoint (URL)
Text

body

Message to Responder (maximum 140 characters, encoded)
File Location

files

The location of the media file on your server
Notes
  • All parameters are required except files
  • Please Register for access to the complete MIRS API Documentation
  • The NGGT MIRS service sends and receives 8-bit Unicode (UTF-8) characters, including letters with diacritical marks (accents)

Delete Caller Media from NGGT Server

Overview
After receiving media from a Caller, you may choose to delete the media from the NGGT server. To accomplish this, your HTTP endpoint sends a request via a GET method to the NGGT service endpoint. The GET method sends information via the HTTP URL as name=value pairs in the query string of the HTTP request.
GET Request
With the programming language of your choice, you send request.

    {NggtServiceEndpoint}/delete.media.php?auth={AuthorizationCode}&stid={StationId}&tn={CallerPhoneNumber}&media={FileName.Ext}
Query String Parameters (complete list upon Registration)
Parameter Name Description
Authorization Code

auth

Unique access key for your HTTP endpoint (URL)
Caller Phone Number

tn

Country Code + 10 digits (e.g. +14071234567)
Station Id

stid

Unique identifier for your HTTP endpoint (URL)
Filename with Extension

media

e.g. ME0115.png
Notes
  • All parameters are required
  • Only send one media filename per request
  • Please Register for access to the complete MIRS API Documentation
  • The NGGT MIRS service sends and receives 8-bit Unicode (UTF-8) characters, including letters with diacritical marks (accents)