CallFire Solutions

Create Subscription

Follow

CREATE SUBSCRIPTION

Creates a new subscription for CallFire event notifications

CreateSubscription registers a URI endpoint to start receiving CallFire notification events. the subscriptionId is returned, and it can be used later to query, update, or delete the subscription. The subscriptionId is also returned as part of all notification events.

A URI endpoint will need to be provided that can handle the HTTP notification events coming from CallFire.com.

REQUEST PARAMETERS

ParameterDemo ValueDescriptionData Type
CreateSubscription   Create Subscription using attached info object
RequestId Unique ID of web request needed for de-duping anyURI
Subscription   Subscribe to a CallFire postback notification event, such as 'textnotification', by registering a callback URI endpoint where events will get published to. object
Id Unique ID of Subscription long
Enabled Enable publishing of postback notifications for subscribed events. boolean
Endpoint Email or URI endpoint to publish notification event to. anyURI
NotificationFormat [XML, JSON, SOAP, EMAIL] 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
SubscriptionFilter   Filter the type of notification events published to postback URI endpoint. object
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

RESPONSE PARAMETERS

ParameterDescriptionData Type
CreatedId Unique ID of resource long

EXAMPLE


using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string CreateSubscription()
        {
            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest("subscription", Method.POST);
            request.AddParameter("Endpoint", "example@test.com");
            request.AddParameter("NotificationFormat", "JSON");
            request.AddParameter("TriggerEvent", "INBOUND_CALL_FINISHED");

            var response = client.Execute(request);
            string content = response.Content;
            return content;
        }
    }
}

The XML returned is:

<?xml version="1.0" encoding="UTF-8"?>

<r:ResourceReference xmlns:r="http://api.callfire.com/resource" xmlns="http://api.callfire.com/data">

    <r:Id>222046003</r:Id>

<r:Location>https://www.callfire.com/api/1.1/rest/subscription/222046003</r:Location>

</r:ResourceReference>

 

Have more questions? Submit a request

Comments