API service for automatically calling customers, https://callo.com.
Maximum RPS when accessing the API: 20 req/sec.
If RPS is exceeded, the API returns a page with a 429 error status.
RPS shortages usually occur with high call volumes.
(!) Try to use mass creation of calls and mass uploading of call results.
Access key, can be generated in Profile Settings
Client phone number in format +380123456789 (international format)
Campaign ID, can be viewed in in the campaign list
(Optional) text of the generated clip in UTF-8 encoding. You can also use special markup for synthesis
(Optional) Voice, by default, if not specified, is taken from the corresponding campaign (list of all voices)
(Optional) Individual SMS text when pressing button 1
(Optional) Individual SMS text when pressing button 2
(Optional)
(Optional) In UTF-8 encoding. You can use special markup
(Optional) Number in format +380123456789 (international format)
(Optional) \n• To send a reaction, the word must already be configured in the IVR. \n• Your word is transmitted in lowercase only. \n• Only one word is allowed per reaction. \nIf multiple words are specified, an error will occur. If the reaction itself contains several words, specifying just one is sufficient. \n• If the word contains spaces, keep them. Example: ivr_lvl_1_btn_disagree_sms_text
(Optional) Emotional tone of the voice. By default, if not set, 'neutral' is used — neutral (list of all emotions)\n
(Optional) Label for identifying the call. The label must be unique within the campaign, regular expression: \\w+
(Optional) Integer. For a 'PIN code' campaign type, if not specified in the parameters, it is generated automatically
(Optional) Integer
It is also possible to specify an individual SMS text for each number through parameters; see the example below.
Attention! When creating a campaign via API and configuring on-press events, the SMS text is specified as the default text.
See the example for individual on-press e-mails.
Possible errors are also shown in the example.
When adding a call, you can specify individual actions and/or parameters for the subscriber.
audioclip_text – text of the synthesized clip for this button
email_subject – subject for an individual e-mail
email_text – message to send in an e-mail
sms_text – individual SMS text
status_name – label of the pressed key
to_email – address for an individual e-mail
to_phone – forwarding to a phone number
to_sipname – forwarding to a SIP line
webhook – URL for a webhook for this button
https://callo.com/manager/cabapi_external/api/v1/phones/call/?public_key=your_public_key&phone=customer_phonenumber&campaign_id=your_campaign_id
Attention! The example uses a GET request, but in production it is recommended to use only POST requests.
Phone campaign ID, can be viewed in in the campaign list
(Optional) Integer. If not specified in the parameters, it is generated automatically
Used in campaign types Code entry during the call, Confirmation by call, Call to a verification number.
https://callo.com/manager/cabapi_external/api/v1/phones/confirm/?public_key=your_public_key&phone=customer_phonenumber&campaign_id=your_campaign_id
Attention! The example uses a GET request, but in production it is recommended to use only POST requests
Used in the campaign type Code dictated by the robot.
https://callo.com/manager/cabapi_external/api/v1/phones/tellcode/?public_key=your_public_key&phone=customer_phonenumber&campaign_id=your_campaign_id
(Optional) Integer. A code that will be transmitted in the last four digits of the phone number. If not specified in the parameters, it is generated automatically.\nWe recommend avoiding the use of this parameter, as the phone_suffix you provide may be unavailable for the call
Used in the campaign type Flash Call.
https://callo.com/manager/cabapi_external/api/v1/phones/flashcall/?public_key=your_public_key&phone=customer_phonenumber&campaign_id=your_campaign_id
Customer numbers in the format +380123456789 (international format), each number on a new line
Customer phone numbers provided as a CSV or Excel file
(Optional) Column number (numbered starting from 0) from the CSV file containing text for generating audio clips (only for campaigns of the \"Free Text\" type). You can also use special markup for synthesis
(Optional) Column number (numbered starting from 0) from the CSV file containing the call label (only for campaigns of the \"Free Text\" type)
Attention! Bulk call addition works asynchronously, and calls are not added immediately. You can obtain the call_id values for your new calls by making a request to export campaign calls by phone numbers or by labels.
call_id
phone numbers
labels
(!) Not used in campaign types Code entry during the call, Confirmation by call, Code dictated by the robot, Flash Call.
Take a look:
Status reference
.
You can get the status of one or several calls. To obtain the status of multiple calls, use the call_ids parameter instead of call_id. Sending both parameters simultaneously is not allowed.
call_ids
https://callo.com/manager/cabapi_external/api/v1/phones/call_by_id/?public_key=your_public_key&call_id=your_call_id&expand=0_or_1
Call ID (in the format 999999999999999) that you received via the API when creating the call
(Optional) Flag that allows displaying all call attempts (field attempts)
(Optional) Multiple call IDs obtained via the API, separated by commas
Look:
Decoding statuses
You can get the status of one or more calls. To get the status of multiple calls, use the parameter phones instead of phone. It is prohibited to send both parameters at the same time.
phones
phone
Simple examplehttps://callo.com/manager/cabapi_external/api/v1/phones/calls_by_phone/?public_key=your_public_key&campaign_id=your_campaign_id&phone=customer_phonenumber&from_created_date=from_created_date&to_created_date=to_created_date&from_updated_date=from_updated_date&to_updated_date=to_updated_date
Clients phone number in format +380123456789 (international format), {{urlencode_comment}}.
(Optional) Call creation date in the format 2017-12-23 23:59:59
(Optional) Date in the format 2017-12-23 23:59:59
(Optional) Date the call status was updated in the format 2017-12-23 23:59:59
(Optional) A flag that allows you to display all call attempts (fieldattempts)
(Optional) Multiple customer numbers in the format +380123456789, separated by comma
Attention! Number of calls on one page - maximum 1000, change the parameter page=1, 2, 3, etc. orfrom_created_dateto move through the list of campaign calls.
from_created_date
Important! Calls for this request are sorted by creation date in descending order.
02/01/2025 the obsolete status parameter will be removed from the API response. We recommend using the call_status parameter, which is its current replacement. The call_status parameter contains the status code as a string and is described in the call_status_display field. Please make sure your code handles call_status instead of status to avoid problems in the future.
Decoding statuses.
{{base_url}}/phones/all_calls/?public_key=your_public_key&campaign_id=your_campaign_id&page=page_num&from_created_date=from_created_date&to_created_date=to_created_date&from_updated_date=from_updated_date&to_updated_date=to_updated_date
Page number for uploading (optional), default is 1
(Optional) Call creation date in the format 2019-06-01
(Optional) Date in the format 2019-06-20
(Optional) Date the call status was updated in the format 2019-06-01
(Optional) A parameter that allows you to filter calls by the specified status.Decoding statuses
You can get the status of one or more calls. To get the status of multiple calls, use the parameterlabelsinstead oflabel. It is prohibited to send both parameters at the same time.Additionally, as a result of dialing in the parameterlabelThe label of each call is indicated.
label
Simple example--------------{{base_url}}/phones/calls_by_label/?public_key=your_public_key&label=your_label&campaign_id=your_campaign_id&expand=0_or_1
Ring tag specified when added via API
(Optional) Multiple call labels specified when added, separated by commas
Call creation date in the format 2019-11-24 20:35:24
Date in the format 2019-11-24 20:35:24
Don't forget about encoding parameters in URLs GET request.
You can find out the result of one or more calls. A maximum of 200 calls can be checked.
There is a common flag expand, which allows you to display all call attempts (attempts field).
expand
(Optional if phone is specified) - Call ID (in the format 999999999999999) that you received via the API when creating the call
(Optional, if call_id is specified) - client number in the format +380123456789
During a running campaign, it is possible to remove a number from the call if the corresponding call was not completed
Clip name
Audio file
(Optional) Speaker
(Optional) Description
{{base_url}}/audio/info/?public_key=your_public_key&audioclip_id=your_audioclip_id&campaign_id=your_campaign_id
Audio ID
You can get call_id of calls in a specific campaign added to a specific phone list. The phone list ID can be found in
telephone lists
or in the response when adding bulk API calls.The response is provided as a CSV file with fields phoneval, ats_call_id, created. The rows are sorted by creation date in descending order. If a campaign contains several different phone calls to one number, all such calls will be returned.
phoneval
ats_call_id
created
Phone campaign ID, can be found inin the campaign list
Phone list ID, can be obtained in your account or in the response when bulk uploading numbers
{{base_url}}/users/balance/?public_key=your_public_key
You can find out the expenses for a specific campaign for all time
You can get a list of your campaigns
Campaign status. Options: