SubscriptionService

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.

SubscriptionService

Provides operations for creating and managing CallFire subscriptions which listen for account events.

CallFire account events, such as TextSent or CallFinished, can be listened for (subscribed to) by registering a postback URI endpoint, either an email address or web service URL, that CallFire can publish the event info to. Subscription service is used for registering and managing these postback URI endpoints.

A typical use case would be for determining the status of a SendText request which is an asynchronous operation. The status of the Text can be obtained either by polling the GetText / QueryText operations (pull strategy) or more efficiently by registering with Subscription Service a postback internet endpoint URL for receiving 'textsent' and 'textfinished' events to.

Currently supports TextSent, TextFinished, CallFinished, and CampaignFinished events.

CreateSubscription

Creates a new subscription for CallFire event notifications

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

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

QuerySubscriptions

Get a list of registered subscriptions

Return a list of all subscriptions registered to an account. Subscriptions returned contain info like id, enabled, endpoint, filter, etc...

GetSubscription

Gets an existing individual subscription by ID

Return a subscription registered to an account using subscriptionId returned from CreateSubscription request. Subscription returned contain info like id, enabled, endpoint, filter, etc...

UpdateSubscription

Updates an existing subscription

Update existing subscription by ID

Use this to enable or disable notification events, change the notification endpoint URI, or change the filtering so only receive notification for a subset of events.

UpdateSubscription service call returns no response.

Testing this method using swagger doc REST interface (Try Me! button) does not work correctly. Please use curl or other rest client to test api call.

DeleteSubscription

Deletes a subscription by ID

Delete subscription to stop receiving CallFire notification events at the registered URI postback endpoint.