How Can We Help?

API Action Reference

Action: SMS.Send

This action can be used to send SMS or MMS messages, to any Salesforce record of any object type, as well as to any phone number (i.e. doesn’t need an existent record in Salesforce to get the call initiated).

Parameters

  • fromPhone – String – Optional. Phone number used as the outbound Caller ID when sending the message. If not provided, Fastcall will look for a suitable phone number with SMS capabilities and enabled for sending outbound SMS, to which the user has access either directly, or through a group (see Assignment / Available For, in the phone number detail page in the Fastcall Settings tab).
  • toPhone – String – Required. The destination phone number for the message, this is usually a phone number from a Salesforce record phone number field.
  • bodyText – String – Required. Body of the SMS/MMS message.
  • mediaURL – String – Optional. URL of the media you want to include with your message. Supported media formats are GIF, PNG, and JPEG.
  • recordId – String – Optional. Salesforce record Id, associated to the phone number specified in “toPhone”. If provided, Fastcall will associate the SMS record to the Salesforce record, and will also create a Task record associated with this record.
  • userId – String – Optional. If not provided the Apex executing context user will be assumed. It should be provided if the method is invoked from inside “system context”. E.g., inside triggers, async apex, etc.

Returns

Map<String, Object> with the following properties:

  • id – String – Salesforce record Id for the FastCall__SMS_Message__c record.
  • smsId – String – VoIP provider resource Id for the message.
  • taskId – String – Salesforce Task Id for the message.
  • relatedRecordId – String – Salesforce Id of the record associated with the message (Lead, Contact, any record from any standard or custom object type).
  • direction – String – Outbound or Inbound.
  • status – String – Initial delivery status for the message.
  • phoneNumberId – String – Salesforce Id of the Fastcall Phone Number used as Caller Id for sending the message.
  • owner – String – Id of the Salesforce User or Group set as owner for the message.
  • createdDate – String – DateTime when the message was initially enqueued for delivery.

NOTE: The delivery status for the message is updated in real-time in the FastCall__Status__c field of the FastCall__SMS_Message__c record. So you can track the delivery status of the message by inspecting the FastCall__SMS_Message__c record having the id value provided in the response.

Throws

FastCall.SubscriberAPI.APIException – If an error occurs, an instance of APIException is thrown, with one of the following error codes:

  • 100 – SMS could not be sent. Check the VoIP error logs.
  • 101 – Body text not provided.
  • 103 – Caller ID not found. The Fastcall Admin should provision an SMS capable phone number as Caller ID for the user sending the message.
  • 104 – SMS could not be sent. A generic message, will contain a more detailed explanation about the issue.
  • 105 – The Fastcall setup is missing the SMS capability. Contact Fastcall Support to enable the SMS capability.

Action: Call.Start

Starts an outbound call using Fastcall. When the called party answers, it is connected to a Fastcall IVR (Menu, ACD Call Transfer, Voice Mail, etc).

Parameters

  • fromPhone – String – Optional. Phone number used as the outbound Caller ID. If not provided, Fastcall will try to select one among the phone numbers assigned to the user directly or through a group, that are available for usage as Caller IDs.
  • toPhone – String – Required. The destination phone number for the Call. This is usually a value taken from a Salesforce record phone number field.
  • ivrId – String – The Salesforce Id of a Fastcall IVR. This IVR will be executed when the called party answers. It can be an IVR of any type.
  • recordId – String – Optional. If provided Fastcall will associate the FastCall__Call__c record with this Salesforce record. The Task created will also be associated with this same record.
  • userId – String – Optional. If not provided the Apex executing context user will be assumed. It should be provided if the method is invoked from inside “system context”. E.g., inside triggers, async apex, etc.

Returns

Map<String, Object> with the following properties:

  • id – String – Salesforce record Id for the FastCall__Call__c record.
  • callId – String – VoIP provider resource Id for the call.
  • taskId – String – Salesforce Task Id for the call.
  • relatedRecordId – String – Salesforce Id of the record associated with the call (Lead, Contact, any record from any standard or custom object type).
  • direction – String – Outbound or Inbound.
  • status – String – Initial status for the call.
  • ivr – String – Salesforce Id of the Fastcall IVR that the call was connected to.
  • owner – String – Id of the Salesforce User or Group set as the owner of the call.
  • startTime – String – DateTime when the call was initially enqueued for dialing.