Rate this page:

Campaigns

Methods

[POST]

appendToCampaign

Copy URL

Append contacts to the existing campaign. It is possible to add a maximum of 100 entries in one request.

appendToCampaign example

appendToCampaign example

Append contacts to the existing campaign. It is possible to add a maximum of 100 entries in one request.

Parameters

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

  • campaign_id:

    integer

    Campaign ID. The ID can be retrieved via the searchCampaigns method

  • rows:

    string

    Data to append in JSON format.
    Example: [{"phone": "+79101234567", "UTC": "Europe/Moscow", "custom_field": "custom_value"}]

Returns

[POST]

deleteCampaign

Copy URL

Delete the specified campaign. The method only works for the campaigns with the ‘draft’ status.

deleteCampaign example

deleteCampaign example

Delete the specified campaign. The method only works for the campaigns with the ‘draft’ status.

Parameters

  • id:

    integer

    Optional

    Campaign ID. The ID can be retrieved via the searchCampaigns method

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

[GET]

downloadStatReport

Copy URL

Get the download link to the stats file (.XSLS).

downloadStatReport example

downloadStatReport example

Get the download link to the stats file (.XSLS).

Parameters

  • report_id:

    integer

    Optional

    Report ID. The ID can be retrieved via the exportStatReport method

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

  • 200:

    Link to the stats file is successfully retrieved

  • default:

    ErrorType

    Command execution error

[POST]

exportStatReport

Copy URL

Start processing the stats of the specified campaign. To check if the processing is over, use the getStatReportStatus method; use the downloadStatReport method to get the download link.

exportStatReport example

exportStatReport example

Start processing the stats of the specified campaign. To check if the processing is over, use the getStatReportStatus method; use the downloadStatReport method to get the download link.

Parameters

  • campaign_id:

    integer

    Optional

    Campaign ID. The ID can be retrieved via the searchCampaigns method

  • format:

    string

    Optional

    Report format. The following values are possible: csv, xlsx

  • locale:

    string

    Optional

    Document language (example: 'en' or 'ru')

  • from:

    string

    Optional

    Start date (example: 'YYYY-MM-DD HH:mm:ss')

  • to:

    string

    Optional

    End date (example: 'YYYY-MM-DD HH:mm:ss')

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

[POST]

getStatReportStatus

Copy URL

Get info about stats processing. If the response parameter "processed" is True, the stats can be downloaded via the downloadStatReport method.

getStatReportStatus example

getStatReportStatus example

Get info about stats processing. If the response parameter "processed" is True, the stats can be downloaded via the downloadStatReport method.

Parameters

  • report_id:

    integer

    Optional

    Report ID. The ID can be retrieved via the exportStatReport method

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

[POST]

initCampaign

Copy URL

Create a new campaign for automatic calls and start campaign. Use the appendToCampaign method to added contacts.

initCampaign example

initCampaign example

Create a new campaign for automatic calls and start campaign. Use the appendToCampaign method to added contacts.

Parameters

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

  • Optional

    Create a new campaign for automatic calls and start campaign. Use the appendToCampaign method to added contacts.

Returns

[POST]

pauseCampaign

Copy URL

Pause the specified campaign. You can make the campaign active again via the resumeCampaign method.

pauseCampaign example

pauseCampaign example

Pause the specified campaign. You can make the campaign active again via the resumeCampaign method.

Parameters

  • id:

    integer

    Campaign ID. The ID can be retrieved via the searchCampaigns method

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

[POST]

resumeCampaign

Copy URL

Resume the specified campaign which was paused via the pauseCampaign method.

resumeCampaign example

resumeCampaign example

Resume the specified campaign which was paused via the pauseCampaign method.

Parameters

  • id:

    integer

    Campaign ID. The ID can be retrieved via the searchCampaigns method

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

[GET]

searchAttempts

Copy URL

Search for the call attempts. The method without specifying the parameters returns the last 20 call attempts performed.

searchAttempts example

searchAttempts example

Search for the call attempts. The method without specifying the parameters returns the last 20 call attempts performed.

Parameters

  • id:

    integer

    Attempt ID. The ID can be retrieved via the searchAttempts method

  • campaign_id:

    integer

    Campaign ID. The ID can be retrieved via the searchCampaigns method

  • datetime_start:

    string

    Start date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’

  • datetime_end:

    string

    End date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’

  • fields:

    string

    List of the returned fields (comma separated). If it’s not specified, the response will contain the full list of fields.
    IMPORTANT: the parameter can be used only in GET requests

  • sort:

    string

    Sorting data by field(s), add '-' to DESC sort, (example: ‘sort=id’ or ‘sort=-id’).
    IMPORTANT: the parameter can be used only in GET requests

  • page:

    integer

    Page to show as a response: the first one, second, etc. API methods return 20 records (one page) by default.
    IMPORTANT: the parameter can be used only in GET requests

  • per-page:

    integer

    Number of records per page (default value is 20, min = 1, max = 50).
    IMPORTANT: the parameter can be used only in GET requests

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

[GET]

searchCampaigns

Copy URL

Search for the campaigns. The method without specifying the parameters returns the last 20 campaigns created.

searchCampaigns example

searchCampaigns example

Search for the campaigns. The method without specifying the parameters returns the last 20 campaigns created.

Parameters

  • id:

    integer

    Campaign ID. The ID can be retrieved via the searchCampaigns method

  • status:

    string

    Campaign status. The possible values are draft, error, processing, ready, canceled, completed, paused, started

  • date_start:

    string

    Start date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’

  • date_end:

    string

    End date. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’

  • date_create:

    string

    Date of the campaign creation. The format is 24-h ‘YYYY-MM-DD HH:mm:ss’

  • title:

    string

    Title of the campaign

  • fields:

    string

    List of the return fields (comma separated). If it’s not specified the response will contain the full list of fields.
    IMPORTANT: the parameter can be used only in GET requests

  • sort:

    string

    Sorting data by field(s), add '-' to DESC sort, (example: ‘sort=id’ or ‘sort=-datetime_start’).
    IMPORTANT: the parameter can be used only in GET requests

  • page:

    integer

    Page to show as a response: the first one, second, etc. API methods return 20 records (one page) by default.
    IMPORTANT: the parameter can be used only in GET requests

  • per-page:

    integer

    Number of records per page (default value is 20, min = 1, max = 50).
    IMPORTANT: the parameter can be used only in GET requests

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

Returns

[POST]

stat

Copy URL

Get the statistics of the specified campaign(s). Campaign_ids is a JSON array with the campaign ID(s). ID(s) can be retrieved via the searchCampaigns method (example: [1,2,3]).

stat example

stat example

Get the statistics of the specified campaign(s). Campaign_ids is a JSON array with the campaign ID(s). ID(s) can be retrieved via the searchCampaigns method (example: [1,2,3]).

Parameters

  • domain:

    string

    Your account name

  • access_token:

    string

    Unique access token

  • Optional

    Get the statistics of the specified campaign(s). Campaign_ids is a JSON array with the campaign ID(s). ID(s) can be retrieved via the searchCampaigns method (example: [1,2,3]).

Returns