CallFire has a new API!
We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
Return a list of all subscriptions registered to an account. Subscriptions returned contain info like id, enabled, endpoint, filter, etc...
Request Parameters
Parameter | Demo Value | Description | Data Type |
---|---|---|---|
QuerySubscriptions | Subscriptions request by query | object | |
MaxResults | Max number of results to return limited to 1000 (default: 1000) | long | |
FirstResult | Start of next result set (default: 0) | long |
* indicates choice value, bolded parameters are required
Response Parameters
Parameter | Description | Data Type |
---|---|---|
SubscriptionQueryResult | List of Subscriptions returned from query | |
TotalResults | Results count | long |
Subscription | Subscribe to a CallFire postback notification event, such as 'textnotification', by registering a callback URI endpoint where events will get published to. | |
id | Unique ID of Subscription | long |
Enabled | Enable publishing of postback notifications for subscribed events. | boolean |
NonStrictSsl | Enable posting to unknown ssl endpoints (ssl certificate verification will be disabled) | boolean |
Endpoint | Email or URI endpoint to publish notification event to. | anyURI |
NotificationFormat | [XML, JSON, SOAP, EMAIL, LEGACY] | NotificationFormat |
TriggerEvent | Event to trigger on[UNDEFINED_EVENT, INBOUND_CALL_FINISHED, INBOUND_TEXT_FINISHED, OUTBOUND_CALL_FINISHED, OUTBOUND_TEXT_FINISHED, CAMPAIGN_STARTED, CAMPAIGN_STOPPED, CAMPAIGN_FINISHED] | SubscriptionTriggerEvent |
ExpiresAt | Set when a Subscription will expire | long |
SubscriptionFilter | Filter the type of notification events published to postback URI endpoint. | |
BroadcastId | Broadcast ID to filter on | long |
BatchId | Batch ID to filter on | long |
FromNumber | From number (11 digit) or shortcode to filter on | PhoneNumber |
ToNumber | E.164 11 digit phone number | List[PhoneNumber] |
Inbound | Deprecated, use TriggerEvent | boolean |
<?php
/**
* You'll need your login/password pair when you create the SOAP client.
* Don't use the fake login/password provided here; it's just for show and won't work.
*/
$wsdl = "http://callfire.com/api/1.1/wsdl/callfire-service-http-soap12.wsdl";
$client = new SoapClient($wsdl, array(
'soap_version' => SOAP_1_2,
'login' => 'YourLoginId',
'password' => 'YourPassword'));
/**
* QuerySubscriptions. Get a list of existing subscriptions.
*/
$query = new stdclass();
$query->MaxResults = 2;
$response = $client->QuerySubscriptions($query);
print_r($response);
// Example output:
// stdClass Object
// (
// [TotalResults] => 1
// [Subscription] => stdClass Object
// (
// [Endpoint] => http://www.yourwebsite.com/somephpfile.php
// [NotificationFormat] => XML
// [SubscriptionFilter] => stdClass Object
// (
// )
//
// [id] => 1
// )
//
// )
?>