CallFire Solutions

Introduction

Follow

CallService

This set of operations provide the capabilities for sending and receiving calls, uploading IVRs, and managing sound files. The operations defined here should be preferred over BroadcastService methods when appropriate since the CallService operations are more concise and allow finer granularity in the input parameters.

SendCall

Creates a call broadcast, adds numbers to it, and sends it immediately You can start sending calls using VoiceBroadcastConfig or by setting up an IVR using IvrBroadcastConfig. Sending a call requires at least a ToNumber and a soundId or an IVR. The returned broadcastId can be passed to QueryCalls to get the state of call actions in a campaign and to get a list of individual callIds for use in a GetCall request. The broadcastId can also be passed to GetBroadcastStats to get information about the call campaign, incliuding BilledAmount, Duration, State, and more.

QueryCalls

Lists inbound and outbound calls This operation queries for calls using standard ActionQuery which filters on batchId, broadcastId, toNumber, etc. It returns a list of calls and all associated information. See GetCall if you need to return just a single call action by id.

GetCall

Gets a call by id This operation returns an individual call action. See QueryCalls to return a list of call actions and to get individual callIds.

The general usage is to start a call campaign using SendCall, then to pass the returned broadcastId to QueryCalls to get the callIds of the call actions created. GetCall can then be called with a unique callId to get the information and state of the call action.

CreateSound

Creates a new CallFire-hosted sound for use in calls There are two ways to create a sound: (1) by uploading a pre-recorded WAV or MP3, or (2) by initiating a call to record a sound over the phone.

Duplicate uploads are not allowed. If a duplicate sound data file is provided, a new sound is not created. Instead, the id of the previous sound is returned.

Recording a sound over the phone works by first creating a sound asset using the RecordingCall option, then call the ToNumber to record live voice as sound. If a sound is created using RecordingCall, you need to wait for the sound to be active by calling GetSoundMeta until Status is 'ACTIVE'.

You can use the returned soundId in a subsequent SendCall request.

QuerySoundMeta

Lists sounds available for use in calls This operation returns a list of sound metadata that includes id, status, name, length, and other data. This operation only returns metadata, not the actual sound data. The raw binary sound data can be obtained using the GetSoundData operation.

GetSoundMeta

Gets metadata for a sound for use in calls This operation returns sound metadata for a specified sound including its id, status, name, length, etc. This operation only returns metadata, not the actual sound data. The raw binary sound data can be obtained using the GetSoundData operation.

GetSoundData

Gets binary data for a sound that's available for use in calls This operation returns the raw binary data in the specified format for the selected sound. If no format is specified, it returns MP3 data.

GetRecordingData

Gets the binary data for a sound recorded from a past call Recordings from calls can be retrieved using CallId / Name pairs. Sounds may be given a name in the IVR, unique within a call, using the record tag and varname attribute.

Have more questions? Submit a request

Comments