API docs by Redocly

Design for Platform API (0.0.1)

URL: https://ipscape.com.au/ License: Commercial

activities

Activities related endpoints

List of activities

Authorizations:
authorization
query Parameters
cursor
string or null

Pagination Cursor

campaignId
integer or null

Campaign unique identifier

leadId
integer or null

Lead unique identifier

createdTimestampFrom
string or null

Filter for start call datetime (not earlier than)

createdTimestampTo
string or null

Filter for start call datetime (not later than)

activityType
string or null

Limit output to specified activity type

Responses

Response samples

Content type
application/json

Generic example

{
  • "metadata": {
    },
  • "items": [
    ]
}

Activity details by id.

Authorizations:
authorization
path Parameters
activityId
required
integer

Activity unique identifier.

Responses

Response samples

Content type
application/json

Generic example

{
  • "type": "call.inbound",
  • "data": {
    }
}

campaign

Campaign Statistics

Authorizations:
authorization
path Parameters
campaignId
required
integer

Campaign unique identifier

query Parameters
period
string or null

Statistic Period (hour, day) hour is a default value

Responses

Response samples

Content type
application/json

Generic example

{
  • "campaignId": 1,
  • "campaignName": "Support Inbound",
  • "maxCallWaitingTime": 18,
  • "averageWaitingTime": 9,
  • "estimatedCallWaitingTime": 270,
  • "agents": {
    },
  • "callsWaiting": 0,
  • "callsReceived": 2,
  • "callsAbandonedInWorkflow": 0,
  • "callsAbandonedInQueue": 0,
  • "timestamp": "2020-07-06T13:55:06+10:00",
  • "timezone": "Australia/Sydney"
}

Campaign Statistics

Authorizations:
authorization
path Parameters
campaignId
required
integer

Campaign unique identifier

Responses

Response samples

Content type
application/json

Generic example

{
  • "campaignId": 1,
  • "campaignName": "Support Outbound",
  • "agents": {
    },
  • "isActive": true,
  • "createdDate": "2020-07-06T13:55:06+10:00",
  • "lastUpdated": "2020-07-06T13:55:06+10:00",
  • "lists": [
    ],
  • "timestamp": "2021-08-01T13:55:06+10:00",
  • "timezone": "Australia/Sydney"
}

List of Campaigns

Authorizations:
authorization
query Parameters
cursor
string or null

Pagination cursor

campaignId
integer or null

Campaign unique identifier

campaignType
string or null

Type of campaign

Responses

Response samples

Content type
application/json

Generic example

{
  • "pageNo": 0,
  • "inPage": 1,
  • "perPage": 50,
  • "data": [
    ]
}

media

Media-related endpoints

Get Recording metadata

Authorizations:
authorization
path Parameters
mediaId
required
integer

Media unique identifier

Responses

Response samples

Content type
application/json

Generic example

{
  • "mediaId": 5364,
  • "mediaUri": "/platform-api/v3.0/media/5364",
  • "duration": 9,
  • "deleted": true,
  • "deletedTimestamp": "2023-11-14T09:37:10+11:00",
  • "deletedBy": 1059,
  • "deletionReason": "Removal reason"
}

Get voicemails metadata

Authorizations:
authorization
path Parameters
mediaId
required
integer

Media unique identifier

Responses

Response samples

Content type
application/json
{
  • "mediaId": 0,
  • "mediaUri": "string",
  • "duration": 0
}

Handles a GET request for download voice recording data by a specified media ID.

Authorizations:
authorization
path Parameters
mediaId
required
object

The identifier of the media (voice recording) to be retrieved.

Responses

Response samples

Content type
application/json
"string"

leads

Lead-related endpoints

Get the status of the bulk import process

Authorizations:
authorization
path Parameters
uuid
required
string or null

UUID generated by the /v3.0/leads/bulk/ endpoint

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "status": "string",
  • "error_link": "string",
  • "result": {
    }
}

Get error message of failed imports

Authorizations:
authorization
path Parameters
uuid
required
string or null

UUID generated by the /v3.0/leads/bulk/ endpoint

Responses

Response samples

Content type
application/json
{
  • "pageNo": 0,
  • "limit": 0,
  • "errorList": { },
  • "totalPages": 0,
  • "nextPageLink": "string"
}

List of lists

Authorizations:
authorization
query Parameters
cursor
string

Pagination Cursor

campaignId
integer

Campaign unique identifier

Responses

Response samples

Content type
application/json

Generic example

{
  • "metadata": {
    },
  • "items": [
    ]
}

Create lead list

Authorizations:
authorization
Request Body schema: application/json
required

Create lead list

listName
required
string

List name

campaignId
required
integer

Campaign id of list

Responses

Request samples

Content type
application/json
{
  • "listName": "string",
  • "campaignId": 0
}

Response samples

Content type
application/json
{
  • "listName": "string",
  • "campaignId": 0,
  • "listId": 0
}

Bulk Lead Create

Authorizations:
authorization
Request Body schema: application/json
required

Bulk Lead Create

Array of objects or null (RequestCreateLead)

Lead Data

Responses

Request samples

Content type
application/json
{
  • "leads": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "status": "string"
}

Get lead details

Authorizations:
authorization
path Parameters
leadId
required
integer

Lead Id

Responses

Response samples

Content type
application/json

Generic example

{
  • "leadId": 999,
  • "campaignId": 2,
  • "campaignName": "Sales Outbound",
  • "listId": 100,
  • "listName": "List One",
  • "timezone": "Australia/Sydney",
  • "completed": false,
  • "customerKey": "10000001",
  • "agentId": 1002,
  • "agentFullName": "John Doe",
  • "dataFields": {
    },
  • "lastStatusCode": 3,
  • "lastStatusDescription": "Abandoned",
  • "phones": [
    ],
  • "outcomeType": "preview",
  • "outcomesInfo": {
    },
  • "timestamps": {
    }
}

Update lead details

Authorizations:
authorization
path Parameters
leadId
required
integer

Lead Id

Request Body schema: application/json
required

Update lead details

listId
integer or null

List Id

customerKey
string or null

Customer Key

timezone
string or null

Time Zone

phone1
string or null

Phone 1

phone2
string or null

Phone 2

phone3
string or null

Phone 3

isCompleted
boolean or null

Whether to complete lead or no. Note: lead can only be completed. It can not be marked as non completed.

leadData
object or null

Lead Data

statusCode
integer or null

Status code

agentId
integer or null

Agent Id

nextAttemptTimestamp
string or null

Next Attempt Timestamp

Responses

Request samples

Content type
application/json
{
  • "listId": 0,
  • "customerKey": "string",
  • "timezone": "string",
  • "phone1": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "isCompleted": true,
  • "leadData": { },
  • "statusCode": 0,
  • "agentId": 0,
  • "nextAttemptTimestamp": "string"
}

Delete Lead

Authorizations:
authorization
path Parameters
leadId
required
integer

Lead Id

Responses

Get list detail

Authorizations:
authorization
path Parameters
listId
required
integer

List Id

Responses

Response samples

Content type
application/json

Generic example

{
  • "id": 1,
  • "name": "List One",
  • "campaignId": 99,
  • "campaignName": "Campaign Ninty Nine",
  • "inDialler": true,
  • "weight": 1,
  • "timestamps": {
    }
}

List of Leads

Authorizations:
authorization
query Parameters
cursor
string or null

Pagination Cursor

campaignId
integer or null

Campaign unique identifier

listId
integer or null

List unique identifier

statusCode
integer or null

status code identifier

uploadedTimestampFrom
string or null

Filter for uploaded lead datetime (not earlier than)

uploadedTimestampTo
string or null

Filter for uploaded lead datetime (not later than)

customerKey
string or null

External id field

phone1
string or null

Filter for phone1 (in E164 format)

Responses

Response samples

Content type
application/json

Generic example

{
  • "metadata": {
    },
  • "items": [
    ]
}

Create lead

Authorizations:
authorization
Request Body schema: application/json
required

Create lead

listId
required
integer

List Id

customerKey
string or null

Customer Key

timezone
string or null

Time Zone

phone1
string or null

Phone 1

phone2
string or null

Phone 2

phone3
string or null

Phone 3

nextAttemptTimestamp
string or null <date-time>

Scheduled date and time for attempt

leadData
object or null

Lead Data

statusCode
integer or null

Status code

agentId
integer or null

Agent Id

Responses

Request samples

Content type
application/json
{
  • "listId": 0,
  • "customerKey": "string",
  • "timezone": "string",
  • "phone1": "string",
  • "phone2": "string",
  • "phone3": "string",
  • "nextAttemptTimestamp": "2019-08-24T14:15:22Z",
  • "leadData": { },
  • "statusCode": 0,
  • "agentId": 0
}

Response samples

Content type
application/json
{
  • "leadId": 0,
  • "inDialler": true
}

Reprocess accepted batch

Authorizations:
authorization
path Parameters
uuid
required
string or null

UUID generated by the /v3.0/leads/bulk/ endpoint

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "status": "string"
}

customer

Customer-related endpoints

Requests deletion of customer details based on the provided phone number or email address.

Authorizations:
authorization
query Parameters
phoneNumber
string or null

The phone number of the customer to delete. Set to null if not used.

emailAddress
string or null

The email address of the customer to delete. Set to null if not used.

Responses

Response samples

Content type
application/json
{
  • "callData": {
    },
  • "emailData": {
    },
  • "leadData": {
    }
}

config

Retrieves the click-to-call configuration response.

Authorizations:
authorization
query Parameters
uid
required
string

The uid.

channelId
required
string

The webrtc channel id.

Responses

Response samples

Content type
application/json
{
  • "secret": "string",
  • "restrictedUrls": [
    ]
}

dialler

Dialler call information

Authorizations:
authorization
path Parameters
attemptId
required
integer

Attempt Unique Identifier

Responses

Response samples

Content type
application/json

Generic example

{
  • "attemptId": 999,
  • "dialStatusId": 1,
  • "dialStatusName": "Answered",
  • "phoneIndex": 1,
  • "phoneNumber": "+61499999999",
  • "leadId": 9999,
  • "timestamps": {
    },
  • "type": "call.outbound",
  • "campaignId": 2,
  • "campaignName": "Sales Outbound",
  • "activityId": 110,
  • "parentActivityId": 109,
  • "rootActivityId": 108
}

List of the dialler calls

Authorizations:
authorization
query Parameters
cursor
string or null

Pagination Cursor

campaignId
integer or null

Campaign unique identifier

leadId
integer or null

Lead unique identifier

dialledTimestampFrom
string or null

Filter for start call datetime (not earlier than)

dialledTimestampTo
string or null

Filter for start call datetime (not later than)

Responses

Response samples

Content type
application/json

Generic example

{
  • "metadata": {
    },
  • "items": [
    ]
}

users

List of Users

Authorizations:
authorization
query Parameters
cursor
string or null

Pagination Cursor

userType
string or null

The type of user (agent/user)

accountActive
boolean or null

Whether the user account is active or not

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "items": [
    ]
}

call

Start/stop Call Recording

Authorizations:
authorization
Request Body schema: application/json
required

Start/stop Call Recording

agentId
required
integer

Agent id

recording
required
boolean

Recording status pause/start

Responses

Request samples

Content type
application/json
{
  • "agentId": 0,
  • "recording": true
}

Response samples

Content type
application/json
{
  • "agentId": 0,
  • "recording": true
}

email

Sends an email to recipients for a campaign.

Authorizations:
authorization
Request Body schema: application/json
required

Sends an email to recipients for a campaign.

campaignId
required
integer

Campaign Id

recipientName
required
string

Recipient name.

to
required
string

To email address.

subject
required
string

Subject.

body
required
string

Email HTML body.

required
string or object

Responses

Request samples

Content type
application/json
{
  • "campaignId": 0,
  • "recipientName": "string",
  • "to": "string",
  • "subject": "string",
  • "body": "string",
  • "plainBody": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

availability

Update agent presence

Authorizations:
authorization
Request Body schema: application/json
required

Update agent presence

agentId
required
integer

Agent Id

available
required
boolean

Available

Responses

Request samples

Content type
application/json
{
  • "agentId": 0,
  • "available": true
}

Response samples

Content type
application/json
{
  • "agentId": 0,
  • "available": true
}