All docs This doc

Versions Compared

Key

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

...

The following operations allow you to work with calls and SMS alertsthe messages. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with calls and SMS alertssending the messages to brokers, see Sample configuration.

...

This section provides details on the operations.

...

Listing call alert receivers for the session tracker

The listUsersForSessionTrackerCallAlerts operation lists the users who will receive call alerts for a particular session tracker.

Code Block
languagexml
titlelistUsersForSessionTrackerCallAlerts
<callrail.listUsersForSessionTrackerCallAlerts>
	<companyId>{$ctx:companyId}</companyId>
    <trackerId>{$ctx:trackerId}</trackerId>
    <perPage>{$ctx:perPage}</perPage>
    <page>{$ctx:page}</page>
</callrail.listUsersForSessionTrackerCallAlerts> 
Properties
  • companyId: Required - The ID of the company.
  • trackerId: Required - The ID of the tracker.
  • perPage: The number of users that will be returned for this request (default 100, maximum 1000).
  • page: T he page number that should be returned for this request (the first page is 1).

...

Following is a sample REST/JSON request that can be handled by the listUsersForSessionTrackerCallAlerts operation.

Code Block
languagexml
titleSample Request for listUsersForSessionTrackerCallAlerts
{
	"apiUrl":"https://api.callrail.com",
	"apiKey":"b90746ad2d256cb75ef19663e8e24bd7",
	"companyId":"219945013",
	"trackerId":"169748483",
	"perPage":"5",
	"page":"1"
} 
Related CallRail documentation

http://apidocs.callrail.com/objects/alerts.html#listing-alerts-for-a-tracker

...

The listUsersForSessionTrackerSmsAlerts operation lists the users who will receive text message alerts for a particular session tracker.

Code Block
languagexml
titlelistUsersForSessionTrackerSmsAlerts
<callrail.listUsersForSessionTrackerSmsAlerts>
	<companyId>{$ctx:companyId}</companyId>
    <trackerId>{$ctx:trackerId}</trackerId>
    <perPage>{$ctx:perPage}</perPage>
    <page>{$ctx:page}</page>
</callrail.listUsersForSessionTrackerSmsAlerts> 
Properties
  • companyId: Required - The ID of the company.
  • trackerId: Required - The ID of the tracker.
  • perPage: The number of users that will be returned for this request (default 100, maximum 1000).
  • page: The page number that should be returned for this request (the first page is 1).
Sample request

Following is a sample REST/JSON request that can be handled by the listUsersForSessionTrackerSmsAlerts operation.

Code Block
languagexml
titleSample Request for listUsersForSessionTrackerSmsAlerts
{
	"apiUrl":"https://api.callrail.com",
	"apiKey":"b90746ad2d256cb85ef196f63e8e24bd7",
	"companyId":"219945013",
	"trackerId":"169748483",
	"perPage":"5",
	"page":"1"
}
Related CallRail documentation

http://apidocs.callrail.com/objects/alerts.html#listing-alerts-for-a-tracker

...

The listUsersForSourceTrackerCallAlerts operation lists the users who will receive call alerts for a particular source tracker.

Code Block
languagexml
titlelistUsersForSourceTrackerCallAlerts
<callrail.listUsersForSourceTrackerCallAlerts>
	<companyId>{$ctx:companyId}</companyId>
    <trackerId>{$ctx:trackerId}</trackerId>
    <perPage>{$ctx:perPage}</perPage>
    <page>{$ctx:page}</page>
</callrail.listUsersForSourceTrackerCallAlerts> 
Properties
  • companyId: Required - The ID of the company.
  • trackerId: Required - The ID of the tracker.
  • perPage: The number of users that will be returned for this request (default 100, maximum 1000).
  • page: The page number that should be returned for this request (the first page is 1).
Sample request

Following is a sample REST/JSON request that can be handled by the listUsersForSourceTrackerCallAlerts operation.

Code Block
languagexml
titleSample Request for listUsersForSourceTrackerCallAlerts
{
	"apiUrl":"https://api.callrail.com",
	"apiKey":"f0d9e966cfp19af35b86dde005d3028ae",
	"companyId":"195726064",
	"trackerId":"312892004",
	"perPage":"5",
	"page":"1"
} 
Related CallRail documentation

http://apidocs.callrail.com/objects/alerts.html#listing-alerts-for-a-tracker

...

The listUsersForSourceTrackerSmsAlerts operation lists the users who will receive text message alerts for a particular source tracker.

Code Block
languagexml
titlelistUsersForSourceTrackerSmsAlerts
<callrail.listUsersForSourceTrackerSmsAlerts>
	<companyId>{$ctx:companyId}</companyId>
    <trackerId>{$ctx:trackerId}</trackerId>
    <perPage>{$ctx:perPage}</perPage>
    <page>{$ctx:page}</page>
</callrail.listUsersForSourceTrackerSmsAlerts> 
Properties

...

 

Sample request

Following is a sample REST/JSON request that can be handled by the listUsersForSourceTrackerSmsAlerts operation.

Code Block
languagexml
titleSample Request for listUsersForSourceTrackerSmsAlerts
{
	"apiUrl":"https://api.callrail.com",
	"apiKey":"f0d9e966cf19af35db86dde005d3028ae",
	"companyId":"195726064",
	"trackerId":"312892004",
	"perPage":"5",
	"page":"1"
} 
Related CallRail documentation

http://apidocs.callrail.com/objects/alerts.html#listing-alerts-for-a-tracker

...