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.
Retrieve info on individual Contact Batch using contactId returned from CreateContactBatch
Request Parameters
| Parameter | Demo Value | Description | Data Type |
|---|---|---|---|
| GetContactBatch | ContactBatch request by unique ID | object | |
| Id | Unique ID of resource | long |
* indicates choice value, bolded parameters are required
Response Parameters
| Parameter | Description | Data Type |
|---|---|---|
| ContactBatch | ||
| id | long | |
| Name | Name of Contact Batch | string |
| Status | [NEW, VALIDATING, ERRORS, SOURCE_ERROR, ACTIVE] | BatchStatus |
| BroadcastId | ID of Broadcast this Batch is attached to | long |
| Created | dateTime | |
| Size | Contact count in this Batch | int |
| Remaining | int |
<?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'));
/**
* GetContactBatch
*/
$request = new stdclass();
$request->Id = 332; // required
$response = $client->GetContactBatch($request);
print_r($response);
// Sample $response:
//
// stdClass Object (
// [Name] => My Test API ContactBatch Numbers List
// [Status] => ACTIVE
// [BroadcastId] => 3
// [Created] => 2013-03-08T09:51:08-08:00
// [Size] => 2
// [Remaining] => 0
// [id] => 332
// )
?>