CallFire XML Campaign

How it Works

This rest api will enable you to create and modify CallFire XML Campaigns.

Creating a CallFire XML Campaign

Creates an inbound or outbound CallFire XML Campaign

URL

https://www.callfire.com/cloud/1/callfirexml/campaign

HTTP Method

POST

Content Type

application/x-www-form-urlencoded

Parameters

• apikey: Required. This is your account api key.
• campaignName: Required. A name for your campaign.
• isInbound: Optional. Set to "true" if you are setting up an inbound campaign.
• inboundPhoneNumber: Required if isInbound. For all inbound campaigns a number you own is required so we can point it to your XML.
• isOutbound: Optional. Set to "true" if you are setting up an outbound campaign.
• outboundCallerid: Required if isOutbound. Provide a valid caller id for your outbound calls.
• Require one of the following three:
  • xmlUrl: A URL to your CallFire XML that you host
  • callfireXml: The full CallFire XML String
  • callFireIvrFilename: The IVR filename of your CallFire IVR

Response

Content-Type = application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes">
<campaignResponse>
    <campaignid>898085</campaignid>
    <description>Campaign Created</description>
</campaignResponse>

Example Code

• PHP Create CallFire XML Rest API

Modify a CallFire XML Campaign

Modify the XML for an existing campaign

URL

https://www.callfire.com/cloud/1/callfirexml/campaign/{campaignid}

HTTP Method

PUT

Content Type

application/x-www-form-urlencoded

Parameters

• apikey: Required. This is your account api key.
• Require one of the following three:
  • xmlUrl: A URL to your CallFire XML that you host
  • callfireXml: The full CallFire XML String
  • callFireIvrFilename: The IVR filename of your CallFire IVR

Response

Content-Type = application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes">
<campaignResponse>
    <campaignid>898085</campaignid>
    <description>Campaign Created</description>
</campaignResponse>