The Pagem API features a simple REST interface that's easy to use for automated mobile phone paging.
Pagem's Application Programming Interface (API) provides commands to allow other software programs to execute and automate mobile pages on your behalf. Use it to create an automated alert system or custom mobile paging service for your business or organization. The API uses the Representational State Transfer (REST) pattern to expose simple commands via the HTTP protocol at the following end-point:
This is the most basic command to test the ability to converse with the Pagem API. No authentication is required. It simply returns a timestamp, and a test message. Just paste the following string into your browser's URL bar, or otherwise make a GET request to the URL:
This command allows you to check the status of your api key. You'll need your API key which can be found under SETTINGS --> PROFILE on the Pagem website application (note, your API key is not displayed within the phone app). Here's an example performing the API key teset using command line curl:
If your API key is valid and the call to the endpoint was successful, you will receive a response body with success:true and a message.
This command allows you to page individuals and groups through the API. You'll need your API key which can be found under SETTINGS --> PROFILE on the Pagem website application (note, your API key is not displayed within the phone app). And you'll need the ID of your target Pagee (click on their name in your Pagees table and you'll see their 'Api id' displayed). Here's an example performing the page using command line curl:
When successful, you'll receive a response body with success:true and an event ID to track your page.
This command allows the sender of a page to check the status of the page. You'll need your API key which can be found under SETTINGS --> PROFILE on the Pagem website application (note, your API key is not displayed within the phone app). And you'll need the event ID that was returned from the /page/send endpoint. Note, there is automated blocklisting for overuse so please throttle your requests to no more than 1 request per 5 seconds. Here's an example of checking the status of a page using command line curl:
When successful, you'll receive a response body with success:true and useful information about the page and it's assoicated pagees.
We're working on additional api commands to add to our free pager app so feel free to send us requests on our HELP page.