Overview
The following operations allow you to work with calls and SMS alerts. 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 alerts, see Sample configuration.
Operation | Description |
---|---|
Lists the users who will receive call alerts for the given session tracker. | |
Working with Send the message to brokers | Lists the users who will receive text message alerts for the given session tracker. |
Working with Send the message to brokers | Lists the users who will receive call alerts for the given source tracker. |
Working with Send the message to brokers | Lists the users who will receive text message alerts for the given source tracker. |
Operation details
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.
<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:
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 listUsersForSessionTrackerCallAlerts operation.
{ "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
Listing text message alert receivers for the session tracker
The listUsersForSessionTrackerSmsAlerts
operation lists the users who will receive text message alerts for a particular session tracker.
<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.
{ "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
Listing call alert receivers for the source tracker
The listUsersForSourceTrackerCallAlerts
operation lists the users who will receive call alerts for a particular source tracker.
<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.
{ "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
Listing text message alert receivers for the source tracker
The listUsersForSourceTrackerSmsAlerts
operation lists the users who will receive text message alerts for a particular source tracker.
<callrail.listUsersForSourceTrackerSmsAlerts> <companyId>{$ctx:companyId}</companyId> <trackerId>{$ctx:trackerId}</trackerId> <perPage>{$ctx:perPage}</perPage> <page>{$ctx:page}</page> </callrail.listUsersForSourceTrackerSmsAlerts>
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 listUsersForSourceTrackerSmsAlerts
operation.
{ "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
Sample configuration
Following is a sample proxy service that illustrates how to connect to CallRail with the init
operation and use the listUsersForSessionTrackerCallAlerts
operation. The sample request for this proxy can be found in listUsersForSessionTrackerCallAlerts sample request. You can use this sample as a template for using other operations in this category.
<proxy xmlns="http://ws.apache.org/ns/synapse" name="callrail_listUsersForSessionTrackerCallAlerts" transports="https,http" statistics="disable" trace="disable" startOnLoad="true"> <target> <inSequence onError="faultHandlerSeq"> <property name="apiUrl" expression="json-eval($.apiUrl)"/> <property name="apiKey" expression="json-eval($.apiKey)"/> <property name="companyId" expression="json-eval($.companyId)"/> <property name="trackerId" expression="json-eval($.trackerId)"/> <property name="perPage" expression="json-eval($.perPage)"/> <property name="page" expression="json-eval($.page)"/> <callrail.init> <apiUrl>{$ctx:apiUrl}</apiUrl> <apiKey>{$ctx:apiKey}</apiKey> </callrail.init> <callrail.listUsersForSessionTrackerCallAlerts> <companyId>{$ctx:companyId}</companyId> <trackerId>{$ctx:trackerId}</trackerId> <perPage>{$ctx:perPage}</perPage> <page>{$ctx:page}</page> </callrail.listUsersForSessionTrackerCallAlerts> <respond/> </inSequence> <outSequence> <send/> </outSequence> </target> <description/> </proxy>