AMCONFIG_AM_ONLY
AMCONFIG_AM_ONLY
CreateSubscription(\CallFire\Api\Rest\Request\CreateSubscription $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.
| \CallFire\Api\Rest\Request\CreateSubscription | $CreateSubscription | = null |
QuerySubscriptions(\CallFire\Api\Rest\Request\QuerySubscriptions $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...
| \CallFire\Api\Rest\Request\QuerySubscriptions | $QuerySubscriptions | = null |
GetSubscription(int $Id)
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...
| int | $Id | Unique ID of resource |
UpdateSubscription(int $Id, \CallFire\Api\Rest\Request\UpdateSubscription $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.
| int | $Id | |
| \CallFire\Api\Rest\Request\UpdateSubscription | $UpdateSubscription |
get(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a GET request against an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
post(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a POST request against an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
put(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a PUT request against an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
delete(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a DELETE request again an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
buildPostData(array $parameters) : string
Construct the POST fields data for a POST/PUT request, according to CallFire conventions
Reformats any array parameters to be a space-concatenated list of items. Any object parameters will be casted to a string, as possible.
| array | $parameters | POST data |
Encoded POST data
setHttp(\CallFire\Api\Rest\Http\Request $http)
| \CallFire\Api\Rest\Http\Request | $http |