ICTCore REST APIs Guide

Overview

API Endpoint : Domain / web url corresponding address for ictcore/wwwroot installation directory.
API Access : Any valid combination of username and password created in usr table.
POST Method: Any data submitted to POST method based APIs must be encoded as json.
DELETE Method: user can use both DELETE and GET methods for delete APIs.
List APIs: All list APIs support optional search filter, to search user need to use search parameters in url as query string using key value pair.

HTTP Response Code

200 Function successfully executed.
401 Invalid or missing username or password.
403 Permission denied. User is not permitted to perform requested action.
404 Invalid API location or request to none existing resource. Check the URL and posting method (GET/POST).
412 Data validation failed.
417 Unexpected error.
423 System is not ready to perform requested action.
500 Internal server error. Try again at a later time.
501 Feature not implemented.

Authentication ¶

Create and return authentication token / session key.

Authentication parameter
POST`/authentication`

Note: Unlike other APIs this API does not require separate authentication in header

Example URI

POST http://ictcore.example.com/authentication

Request

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "admin",
  "passowrd": "mysecret"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "api username for authentication"
    },
    "passowrd": {
      "type": "string",
      "description": "api password for authentication"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "token": "token"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    }
  }
}

System Statistics ¶

Get system statistics, like total and active campaigns, total contacts, total number of calls made etc

Get System Statistics
GET`/statistics`

Example URI

GET http://ictcore.example.com/statistics

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "campaign_total": 1,
  "campaign_active": 0,
  "group_total": 12,
  "contact_total": 5,
  "transmission_total": 1,
  "transmission_active": 1,
  "spool_total": 1,
  "spool_success": 1,
  "spool_failed": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "campaign_total": {
      "type": "number",
      "description": "total number of campaign"
    },
    "campaign_active": {
      "type": "number",
      "description": "total number of active campaign"
    },
    "group_total": {
      "type": "number",
      "description": "number of groups"
    },
    "contact_total": {
      "type": "number",
      "description": "number of contacts"
    },
    "transmission_total": {
      "type": "number",
      "description": "number of transmistions"
    },
    "transmission_active": {
      "type": "number",
      "description": "number of active transmission"
    },
    "spool_total": {
      "type": "number",
      "description": "number of spools"
    },
    "spool_success": {
      "type": "number",
      "description": "number of success spools"
    },
    "spool_failed": {
      "type": "number",
      "description": "number of unsuccessed spools"
    }
  }
}

Contact ¶

Collection of Contacts ¶

Create New Contact
POST`/contacts`

Example URI

POST http://ictcore.example.com/contacts

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "custom1": "custom1",
  "custom2": "custom 2",
  "custom3": "custom 3",
  "description": "description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "custom1": {
      "type": "string"
    },
    "custom2": {
      "type": "string"
    },
    "custom3": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "first_name",
    "phone"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "contact_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "contact_id": {
      "type": "number",
      "description": "id of recently created contact"
    }
  }
}

Get All Contacts
GET`/contacts`

Example URI

GET http://ictcore.example.com/contacts

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "first_name": "first name",
    "last_name": "last name",
    "phone": 3001234567,
    "email": "email",
    "address": "address",
    "custom1": "custom1",
    "custom2": "custom 2",
    "custom3": "custom 3",
    "description": "description"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Contact ¶

View a Contact Detail
GET`/contacts/{contact_id}`

Example URI

GET http://ictcore.example.com/contacts/contact_id

URI Parameters

HideShow

contact_id: number (required)
ID of the contact in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "custom1": "custom1",
  "custom2": "custom 2",
  "custom3": "custom 3",
  "description": "description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "custom1": {
      "type": "string"
    },
    "custom2": {
      "type": "string"
    },
    "custom3": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "first_name",
    "phone"
  ]
}

Update Contacts
PUT`/contacts/{contact_id}`

Example URI

PUT http://ictcore.example.com/contacts/contact_id

URI Parameters

HideShow

contact_id: number (required)
ID of the contact in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "custom1": "custom1",
  "custom2": "custom 2",
  "custom3": "custom 3",
  "description": "description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "custom1": {
      "type": "string"
    },
    "custom2": {
      "type": "string"
    },
    "custom3": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "first_name",
    "phone"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "custom1": "custom1",
  "custom2": "custom 2",
  "custom3": "custom 3",
  "description": "description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "custom1": {
      "type": "string"
    },
    "custom2": {
      "type": "string"
    },
    "custom3": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "first_name",
    "phone"
  ]
}

Delete Contact
DELETE`/contacts/{contact_id}`

Example URI

DELETE http://ictcore.example.com/contacts/contact_id

URI Parameters

HideShow

contact_id: number (required)
ID of the contact in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Contact association with group ¶

Create association
PUT`/contacts/{contact_id}/link/{group_id}`

Example URI

PUT http://ictcore.example.com/contacts/contact_id/link/group_id

URI Parameters

HideShow

contact_id: number (required)
ID of the contact in the form of an integer
group_id: number (required)
ID of the group in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "custom1": "custom1",
  "custom2": "custom 2",
  "custom3": "custom 3",
  "description": "description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "custom1": {
      "type": "string"
    },
    "custom2": {
      "type": "string"
    },
    "custom3": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "first_name",
    "phone"
  ]
}

Delete association
DELETE`/contacts/{contact_id}/link/{group_id}`

remove selected contact from provided contact group

Example URI

DELETE http://ictcore.example.com/contacts/contact_id/link/group_id

URI Parameters

HideShow

contact_id: number (required)
ID of the contact in the form of an integer
group_id: number (required)
ID of the group in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "custom1": "custom1",
  "custom2": "custom 2",
  "custom3": "custom 3",
  "description": "description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "custom1": {
      "type": "string"
    },
    "custom2": {
      "type": "string"
    },
    "custom3": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "first_name",
    "phone"
  ]
}

Contact Group ¶

Collection of Groups ¶

Create New Group
POST`/groups`

Example URI

POST http://ictcore.example.com/groups

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "id": 1,
  "name": "group name",
  "description": "Description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "id is auto increment",
      "default": 1
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "group_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group_id": {
      "type": "number",
      "description": "return newly created id"
    }
  }
}

Get All Groups
GET`/groups`

Example URI

GET http://ictcore.example.com/groups

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 1,
    "name": "group name",
    "description": "Description"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Group ¶

View a Group Detail
GET`/groups/{group_id}`

Example URI

GET http://ictcore.example.com/groups/group_id

URI Parameters

HideShow

group_id: number (required)
ID of the group in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 1,
  "name": "group name",
  "description": "Description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "id is auto increment",
      "default": 1
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

Update Groups
PUT`/groups/{group_id}`

Example URI

PUT http://ictcore.example.com/groups/group_id

URI Parameters

HideShow

group_id: number (required)
ID of the group in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "id": 1,
  "name": "group name",
  "description": "Description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "id is auto increment",
      "default": 1
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 1,
  "name": "group name",
  "description": "Description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "id is auto increment",
      "default": 1
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

Delete Group
DELETE`/groups/{group_id}`

Example URI

DELETE http://ictcore.example.com/groups/group_id

URI Parameters

HideShow

group_id: number (required)
ID of the group in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Group's Contacts collection ¶

Get all Contacts from Group
GET`/groups/{group_id}/contacts`

Example URI

GET http://ictcore.example.com/groups/group_id/contacts

URI Parameters

HideShow

group_id: number (required)
ID of the group in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "first_name": "first name",
    "last_name": "last name",
    "phone": 3001234567,
    "email": "email",
    "address": "address",
    "custom1": "custom1",
    "custom2": "custom 2",
    "custom3": "custom 3",
    "description": "description"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

CSV Contact Import / Export for Group ¶

Import Contacts into Group
POST`/groups/{group_id}/csv`

Example URI

POST http://ictcore.example.com/groups/group_id/csv

URI Parameters

HideShow

group_id: number (required)
ID of the group in the form of an integer

Request

HideShow

Headers

Content-Type: text/csv
Authentication: Bearer JWT

Body

"CSV file contents"

Response 200

Export Contacts from Group
GET`/groups/{group_id}/csv`

Download complete contacts from selected contact group as csv file

Example URI

GET http://ictcore.example.com/groups/group_id/csv

URI Parameters

HideShow

group_id: number (required)
ID of the group in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: text/csv

Body

"CSV file contents"

Sample Csv File ¶

Download a sample csv file

Get Sample csv file
GET`/groups/sample/csv`

Example URI

GET http://ictcore.example.com/groups/sample/csv

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: text/csv

Body

"CSV Sample file contents"

Message ¶

There are different kinds of messages like fax,voice,sms and email

Fax Documents ¶

Create New Document
POST`/messages/documents`

Example URI

POST http://ictcore.example.com/messages/documents

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "group name",
  "description": "Description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "document_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "document_id": {
      "type": "number",
      "description": "document id of recently created document record"
    }
  }
}

Get all Documnets
GET`/messages/documents`

Example URI

GET http://ictcore.example.com/messages/documents

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "name": "group name",
    "description": "Description",
    "type": "type"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Document ¶

Note: Media / document can be downloaded separately using GET messages/documents/{document_id}/media

View a Document Detail
GET`/messages/documents/{document_id}`

Example URI

GET http://ictcore.example.com/messages/documents/document_id

URI Parameters

HideShow

document_id: number (required)
ID of the document in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "group name",
  "description": "Description",
  "type": "type"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name"
  ]
}

Update Document
PUT`/messages/documents/{document_id}`

Example URI

PUT http://ictcore.example.com/messages/documents/document_id

URI Parameters

HideShow

document_id: number (required)
ID of the document in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "group name",
  "description": "Description",
  "type": "type"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "group name",
  "description": "Description",
  "type": "type"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name"
  ]
}

Delete Document
DELETE`/messages/documents/{document_id}`

Example URI

DELETE http://ictcore.example.com/messages/documents/document_id

URI Parameters

HideShow

document_id: number (required)
ID of the document in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Add Document File ¶

Add / Update Document file
PUT`/messages/documents/{document_id}/media`

Upload media / pdf file for an existing document, this method should be called followed by POST messages/documents

Example URI

PUT http://ictcore.example.com/messages/documents/document_id/media

URI Parameters

HideShow

document_id: number (required)
ID of the document in the form of an integer

Request

HideShow

Headers

Content-Type: application/pdf
Authentication: Bearer JWT

Body

"Pdf file contents"

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "document_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "document_id": {
      "type": "number",
      "description": "document id of updated record"
    }
  }
}

Get Document
GET`/messages/documents/{document_id}/media`

Download Documen file

Example URI

GET http://ictcore.example.com/messages/documents/document_id/media

URI Parameters

HideShow

document_id: number (required)
ID of the document in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/pdf

Body

"Pdf file contents"

Voice Recordings ¶

Collection of Voice Recordings ¶

Create New Recording
POST`/messages/recordings`

Example URI

POST http://ictcore.example.com/messages/recordings

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "group name",
  "description": "Description",
  "type": "type"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "recording_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "recording_id": {
      "type": "number",
      "description": "recording id of recently created recording"
    }
  }
}

Get all Recording
GET`/messages/recordings`

Note: Media / recording can be downloaded separately using GET messages/recording/{recording_id}/media

Example URI

GET http://ictcore.example.com/messages/recordings

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "name": "group name",
    "description": "Description",
    "type": "type"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Recording ¶

View a Recording Detail
GET`/messages/recordings/{recording_id}`

Example URI

GET http://ictcore.example.com/messages/recordings/recording_id

URI Parameters

HideShow

recording_id: number (required)
ID of the recording in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "group name",
  "description": "Description",
  "type": "type"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name"
  ]
}

Update Recording
PUT`/messages/recordings/{recording_id}`

Example URI

PUT http://ictcore.example.com/messages/recordings/recording_id

URI Parameters

HideShow

recording_id: number (required)
ID of the recording in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "group name",
  "description": "Description",
  "type": "type"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "group name",
  "description": "Description",
  "type": "type"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name"
  ]
}

Delete Recording
DELETE`/messages/recordings/{recording_id}`

Example URI

DELETE http://ictcore.example.com/messages/recordings/recording_id

URI Parameters

HideShow

recording_id: number (required)
ID of the recording in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Add Recording File ¶

Add / Update Recoridng File
PUT`/messages/recordings/{recording_id}/media`

Upload media / wav file for an existing recording, this method should be called followed by POST messages/recording

Example URI

PUT http://ictcore.example.com/messages/recordings/recording_id/media

URI Parameters

HideShow

recording_id: number (required)
ID of the recording in the form of an integer

Request

HideShow

Headers

Content-Type: audio/wav
Authentication: Bearer JWT

Body

"Recording file contents"

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "recording_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "recording_id": {
      "type": "number",
      "description": "recording id of updated record"
    }
  }
}

Get Recording
GET`/messages/recordings/{recording_id}/media`

Download wav file

Example URI

GET http://ictcore.example.com/messages/recordings/recording_id/media

URI Parameters

HideShow

recording_id: number (required)
ID of the recording in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: audio/wav

Body

"Recording file contents"

Email templates ¶

Collection of Email Templates ¶

Create New Template
POST`/messages/templates`

Example URI

POST http://ictcore.example.com/messages/templates

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "description": "Description",
  "subject": "Subject",
  "body": "body",
  "body_alt": "body alt",
  "type": "upload file"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "body": {
      "type": "string",
      "description": "HTML Message"
    },
    "body_alt": {
      "type": "string",
      "description": "Plain Message"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name",
    "subject",
    "body"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "template_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "template_id": {
      "type": "number",
      "description": "template id of recently created template"
    }
  }
}

Get all Templates
GET`/messages/templates`

Note: Media / attachment can be downloaded separately using GET messages/templates/{template_id}/media

Example URI

GET http://ictcore.example.com/messages/templates

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "name": "name",
    "description": "Description",
    "subject": "Subject",
    "body": "body",
    "body_alt": "body alt",
    "type": "upload file"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Template ¶

View a Template Detail
GET`/messages/templates/{template_id}`

Example URI

GET http://ictcore.example.com/messages/templates/template_id

URI Parameters

HideShow

template_id: number (required)
ID of the template in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "name",
  "description": "Description",
  "subject": "Subject",
  "body": "body",
  "body_alt": "body alt",
  "type": "upload file"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "body": {
      "type": "string",
      "description": "HTML Message"
    },
    "body_alt": {
      "type": "string",
      "description": "Plain Message"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name",
    "subject",
    "body"
  ]
}

Update Template
PUT`/messages/templates/{template_id}`

Example URI

PUT http://ictcore.example.com/messages/templates/template_id

URI Parameters

HideShow

template_id: number (required)
ID of the template in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "description": "Description",
  "subject": "Subject",
  "body": "body",
  "body_alt": "body alt",
  "type": "upload file"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "body": {
      "type": "string",
      "description": "HTML Message"
    },
    "body_alt": {
      "type": "string",
      "description": "Plain Message"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name",
    "subject",
    "body"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "name",
  "description": "Description",
  "subject": "Subject",
  "body": "body",
  "body_alt": "body alt",
  "type": "upload file"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "body": {
      "type": "string",
      "description": "HTML Message"
    },
    "body_alt": {
      "type": "string",
      "description": "Plain Message"
    },
    "type": {
      "type": "string",
      "description": "three digit file extension representing file type"
    }
  },
  "required": [
    "name",
    "subject",
    "body"
  ]
}

Delete Template
DELETE`/messages/templates/{template_id}`

Example URI

DELETE http://ictcore.example.com/messages/templates/template_id

URI Parameters

HideShow

template_id: number (required)
ID of the template in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Add Template File ¶

Add / Update Template File
PUT`/messages/templates/{template_id}/media`

Upload media / attachment for an existing template, this method should be called followed by POST messages/templates

Example URI

PUT http://ictcore.example.com/messages/templates/template_id/media

URI Parameters

HideShow

template_id: number (required)
ID of the template in the form of an integer

Request

HideShow

Headers

Content-Type: text/plain
Authentication: Bearer JWT

Body

"Email template contents"

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "template_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "template_id": {
      "type": "number",
      "description": "template id of updated record"
    }
  }
}

Get Template file
GET`/messages/templates/{template_id}/media`

Download file

Example URI

GET http://ictcore.example.com/messages/templates/template_id/media

URI Parameters

HideShow

template_id: number (required)
ID of the template in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: text/html

Body

"Email template contents"

SMS Text Message ¶

Collection of SMS Text Messages ¶

Create New Texts
POST`/messages/texts`

Example URI

POST http://ictcore.example.com/messages/texts

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "data": "Data",
  "type": "type",
  "description": "Description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "data": {
      "type": "string",
      "description": "Actual message"
    },
    "type": {
      "type": "string",
      "description": "unicode or plain or binary"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "data"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "text_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "text_id": {
      "type": "number",
      "description": "text id of recently created template"
    }
  }
}

Get all Text Messages
GET`/messages/texts`

Example URI

GET http://ictcore.example.com/messages/texts

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "name": "name",
    "data": "Data",
    "type": "type",
    "description": "Description"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Text ¶

View a Text Detail
GET`/messages/texts/{text_id}`

Example URI

GET http://ictcore.example.com/messages/texts/text_id

URI Parameters

HideShow

text_id: number (required)
ID of the text in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "name",
  "data": "Data",
  "type": "type",
  "description": "Description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "data": {
      "type": "string",
      "description": "Actual message"
    },
    "type": {
      "type": "string",
      "description": "unicode or plain or binary"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "data"
  ]
}

Update Text
PUT`/messages/texts/{text_id}`

Example URI

PUT http://ictcore.example.com/messages/texts/text_id

URI Parameters

HideShow

text_id: number (required)
ID of the text in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "data": "Data",
  "type": "type",
  "description": "Description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "data": {
      "type": "string",
      "description": "Actual message"
    },
    "type": {
      "type": "string",
      "description": "unicode or plain or binary"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "data"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "name",
  "data": "Data",
  "type": "type",
  "description": "Description"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "data": {
      "type": "string",
      "description": "Actual message"
    },
    "type": {
      "type": "string",
      "description": "unicode or plain or binary"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "data"
  ]
}

Delete Text
DELETE`/messages/texts/{text_id}`

Example URI

DELETE http://ictcore.example.com/messages/texts/text_id

URI Parameters

HideShow

text_id: number (required)
ID of the text in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Program ¶

General program related function ¶

To create program please use respective APIs separately designed for each type of program.

Get all Programs
GET`/programs`

Example URI

GET http://ictcore.example.com/programs

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "name": "name",
    "type": "type",
    "parent_id": 1
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Program ¶

View a Program Detail
GET`/programs/{program_id}`

Example URI

GET http://ictcore.example.com/programs/program_id

URI Parameters

HideShow

program_id: number (required)
ID of the program in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    }
  },
  "required": [
    "name"
  ]
}

Delete Program
DELETE`/programs/{program_id}`

Example URI

DELETE http://ictcore.example.com/programs/program_id

URI Parameters

HideShow

program_id: number (required)
ID of the program in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Shortcut way to create new Transmissions ¶

New Transmission
PUT`/programs/{program_id}/transmissions`

Example URI

PUT http://ictcore.example.com/programs/program_id/transmissions

URI Parameters

HideShow

program_id: number (required)
ID of the program in the form of an Intiger

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "title": "title",
  "origin": "origin",
  "contact_id": 1,
  "account_id": 1,
  "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
  "program_id": 1,
  "direction": "direction",
  "status": "status",
  "response": "response"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    },
    "origin": {
      "type": "string",
      "description": "reference to function / program which is responsible creation of this transmission"
    },
    "contact_id": {
      "type": "number",
      "description": "contact id to contact where to transmit message"
    },
    "account_id": {
      "type": "number",
      "description": "account id of associated account"
    },
    "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": {
      "type": "string"
    },
    "program_id": {
      "type": "number",
      "description": "program id of program which will be used with this transmission"
    },
    "direction": {
      "type": "string",
      "description": "either can be outbound or inbound"
    },
    "status": {
      "type": "string",
      "description": "if complete or failed"
    },
    "response": {
      "type": "string",
      "description": "the cause of error, transmission failure"
    }
  },
  "required": [
    "contact_id",
    "program_id"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "transmission_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "transmission_id": {
      "type": "number",
      "description": "transmission id of recently created transmission"
    }
  }
}

Get Transmistion
GET`/programs/{program_id}/transmissions`

Example URI

GET http://ictcore.example.com/programs/program_id/transmissions

URI Parameters

HideShow

program_id: number (required)
ID of the program in the form of an Intiger

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "title": "title",
  "origin": "origin",
  "contact_id": 1,
  "account_id": 1,
  "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
  "program_id": 1,
  "direction": "direction",
  "status": "status",
  "response": "response"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    },
    "origin": {
      "type": "string",
      "description": "reference to function / program which is responsible creation of this transmission"
    },
    "contact_id": {
      "type": "number",
      "description": "contact id to contact where to transmit message"
    },
    "account_id": {
      "type": "number",
      "description": "account id of associated account"
    },
    "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": {
      "type": "string"
    },
    "program_id": {
      "type": "number",
      "description": "program id of program which will be used with this transmission"
    },
    "direction": {
      "type": "string",
      "description": "either can be outbound or inbound"
    },
    "status": {
      "type": "string",
      "description": "if complete or failed"
    },
    "response": {
      "type": "string",
      "description": "the cause of error, transmission failure"
    }
  },
  "required": [
    "contact_id",
    "program_id"
  ]
}

Email to Fax program ¶

Create New Email to Fax program
POST`/programs/emailtofax`

Example URI

POST http://ictcore.example.com/programs/emailtofax

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1,
  "account_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    },
    "account_id": {
      "type": "number",
      "description": "account id of account for which this program is being created"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number",
      "description": "program id  of recently created program"
    }
  }
}

Fax to Email program ¶

Create New Fax to Email program
POST`/programs/faxtoemail`

Example URI

POST http://ictcore.example.com/programs/faxtoemail

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1,
  "account_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    },
    "account_id": {
      "type": "number",
      "description": "account id of account for which this program is being created"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number",
      "description": "program id  of recently created program"
    }
  }
}

Receive Email program ¶

Create New Receive Email program
POST`/programs/receiveemail`

Example URI

POST http://ictcore.example.com/programs/receiveemail

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1,
  "account_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    },
    "account_id": {
      "type": "number",
      "description": "account id of account for which this program is being created"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number",
      "description": "program id  of recently created program"
    }
  }
}

Receive FAX program ¶

Create New Receive FAX program
POST`/programs/receivefax`

Example URI

POST http://ictcore.example.com/programs/receivefax

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1,
  "account_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    },
    "account_id": {
      "type": "number",
      "description": "account id of account for which this program is being created"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number",
      "description": "program id  of recently created program"
    }
  }
}

Receive SMS program ¶

Create New Receive SMS program
POST`/programs/receivesms`

Example URI

POST http://ictcore.example.com/programs/receivesms

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1,
  "account_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    },
    "account_id": {
      "type": "number",
      "description": "account id of account for which this program is being created"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number",
      "description": "program id  of recently created program"
    }
  }
}

Send Email program ¶

Create New Send Email program
POST`/programs/sendemail`

Example URI

POST http://ictcore.example.com/programs/sendemail

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1,
  "template_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    },
    "template_id": {
      "type": "number",
      "description": "template id of email template for which this program is being created"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number",
      "description": "program id  of recently created program"
    }
  }
}

Send FAX program ¶

Prepare given fax document for provided account, and make it ready to be sent

Create New Send FAX program
POST`/programs/sendfax`

Example URI

POST http://ictcore.example.com/programs/sendfax

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1,
  "document_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    },
    "document_id": {
      "type": "number",
      "description": "document id of fax document for which this program is being created"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number",
      "description": "program id  of recently created program"
    }
  }
}

Send SMS program ¶

Prepare given SMS for provided account, and make it ready to be sent

Create New Send SMS program
POST`/programs/sendsms`

Example URI

POST http://ictcore.example.com/programs/sendsms

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1,
  "text_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    },
    "text_id": {
      "type": "number",
      "description": "text id of SMS text for which this program is being created"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number",
      "description": "program id  of recently created program"
    }
  }
}

Voice Call with pre recorded message ¶

Voice Message program ¶

Prepare given voice recording for provided account, and make it ready to be played during call

Create New Voice Message program
POST`/programs/voicemessage`

Example URI

POST http://ictcore.example.com/programs/voicemessage

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "type": "type",
  "parent_id": 1,
  "recording_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "description": "program type"
    },
    "parent_id": {
      "type": "number",
      "description": "program id of parent program"
    },
    "recording_id": {
      "type": "number",
      "description": "recording id of voice recording for which this program is being created"
    }
  },
  "required": [
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number",
      "description": "program id  of recently created program"
    }
  }
}

Transmission - the actual call or action ¶

create call request / dial / send message

Collection of Transmission ¶

Create New Transmission
POST`/transmissions`

Example URI

POST http://ictcore.example.com/transmissions

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "title": "title",
  "origin": "origin",
  "contact_id": 1,
  "account_id": 1,
  "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
  "program_id": 1,
  "direction": "direction",
  "status": "status",
  "response": "response"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    },
    "origin": {
      "type": "string",
      "description": "reference to function / program which is responsible creation of this transmission"
    },
    "contact_id": {
      "type": "number",
      "description": "contact id to contact where to transmit message"
    },
    "account_id": {
      "type": "number",
      "description": "account id of associated account"
    },
    "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": {
      "type": "string"
    },
    "program_id": {
      "type": "number",
      "description": "program id of program which will be used with this transmission"
    },
    "direction": {
      "type": "string",
      "description": "either can be outbound or inbound"
    },
    "status": {
      "type": "string",
      "description": "if complete or failed"
    },
    "response": {
      "type": "string",
      "description": "the cause of error, transmission failure"
    }
  },
  "required": [
    "contact_id",
    "program_id"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "text_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "text_id": {
      "type": "number",
      "description": "text id of recently created template"
    }
  }
}

Get all Transmissions
GET`/transmissions`

Example URI

GET http://ictcore.example.com/transmissions

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "title": "title",
  "origin": "origin",
  "contact_id": 1,
  "account_id": 1,
  "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
  "program_id": 1,
  "direction": "direction",
  "status": "status",
  "response": "response"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    },
    "origin": {
      "type": "string",
      "description": "reference to function / program which is responsible creation of this transmission"
    },
    "contact_id": {
      "type": "number",
      "description": "contact id to contact where to transmit message"
    },
    "account_id": {
      "type": "number",
      "description": "account id of associated account"
    },
    "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": {
      "type": "string"
    },
    "program_id": {
      "type": "number",
      "description": "program id of program which will be used with this transmission"
    },
    "direction": {
      "type": "string",
      "description": "either can be outbound or inbound"
    },
    "status": {
      "type": "string",
      "description": "if complete or failed"
    },
    "response": {
      "type": "string",
      "description": "the cause of error, transmission failure"
    }
  },
  "required": [
    "contact_id",
    "program_id"
  ]
}

Transmition Send ¶

Send Transmition
POST`/transmissions/{transmission_id}/send`

Example URI

POST http://ictcore.example.com/transmissions/transmission_id/send

URI Parameters

HideShow

transmission_id: number (required)
ID of the transmission in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "spool_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "spool_id": {
      "type": "number",
      "description": "Spool ID of resulted attempt"
    }
  }
}

Transmition Retry ¶

Retry Transmition
POST`/transmissions/{transmission_id}/retry`

Example URI

POST http://ictcore.example.com/transmissions/transmission_id/retry

URI Parameters

HideShow

transmission_id: number (required)
ID of the transmission in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "spool_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "spool_id": {
      "type": "number",
      "description": "Spool ID of resulted attempt"
    }
  }
}

Transmission Schdule ¶

Schdule Transmission
PUT`/transmissions/{transmission_id}/schedule`

Instead of delivering message instantly, schedule its delivery in near future.

Example URI

PUT http://ictcore.example.com/transmissions/transmission_id/schedule

URI Parameters

HideShow

transmission_id: number (required)
ID of the transmission in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "schedule_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "schedule_id": {
      "type": "number",
      "description": "schedule id of recently created schedule record"
    }
  }
}

Delete Text
DELETE`/transmissions/{transmission_id}/schedule`

Example URI

DELETE http://ictcore.example.com/transmissions/transmission_id/schedule

URI Parameters

HideShow

transmission_id: number (required)
ID of the transmission in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Transmission Clone ¶

Get Transmission Clone
GET`/transmissions/{transmission_id}/clone`

Want to resend an already completed transmission, copy it (Note: after copying, client still need to request send method for message delivery)

Example URI

GET http://ictcore.example.com/transmissions/transmission_id/clone

URI Parameters

HideShow

transmission_id: number (required)
ID of the transmission in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "transmission_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "transmission_id": {
      "type": "number",
      "description": "transmission id of newly created transmission"
    }
  }
}

single Transmission ¶

Get a Transmission
GET`/transmissions/{transmission_id}`

Example URI

GET http://ictcore.example.com/transmissions/transmission_id

URI Parameters

HideShow

transmission_id: number (required)
ID of the transmission in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "title": "title",
  "origin": "origin",
  "contact_id": 1,
  "account_id": 1,
  "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
  "program_id": 1,
  "direction": "direction",
  "status": "status",
  "response": "response"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    },
    "origin": {
      "type": "string",
      "description": "reference to function / program which is responsible creation of this transmission"
    },
    "contact_id": {
      "type": "number",
      "description": "contact id to contact where to transmit message"
    },
    "account_id": {
      "type": "number",
      "description": "account id of associated account"
    },
    "service_flag:  1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": {
      "type": "string"
    },
    "program_id": {
      "type": "number",
      "description": "program id of program which will be used with this transmission"
    },
    "direction": {
      "type": "string",
      "description": "either can be outbound or inbound"
    },
    "status": {
      "type": "string",
      "description": "if complete or failed"
    },
    "response": {
      "type": "string",
      "description": "the cause of error, transmission failure"
    }
  },
  "required": [
    "contact_id",
    "program_id"
  ]
}

Campaign - the actual bulk system ¶

Create campaign for message delivery / calling bulk contacts

Campaign collection ¶

Create New Campaign
POST`/campaigns`

Example URI

POST http://ictcore.example.com/campaigns

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "program_id": 1,
  "group_id": 2,
  "delay": 2,
  "try_allowed": 2,
  "account_id: 1 (number) - account_id of associated account": "Hello, world!",
  "status": "active"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number"
    },
    "group_id": {
      "type": "number"
    },
    "delay": {
      "type": "number",
      "description": "pause between transmissions `milliseconds`"
    },
    "try_allowed": {
      "type": "number"
    },
    "account_id: 1 (number) - account_id of associated account": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "current status of campaign"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "campaign_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "campaign_id": {
      "type": "number",
      "description": "campaign id of recently created campaign record"
    }
  }
}

Get all Campaign
GET`/campaigns`

Example URI

GET http://ictcore.example.com/campaigns

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "program_id": 1,
    "group_id": 2,
    "delay": 2,
    "try_allowed": 2,
    "account_id: 1 (number) - account_id of associated account": "Hello, world!",
    "status": "active"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Campaign Action ¶

Update Campaign
PUT`/campaigns/{campaign_id}`

Example URI

PUT http://ictcore.example.com/campaigns/campaign_id

URI Parameters

HideShow

campaign_id: number (required)
ID of the campaign in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "program_id": 1,
  "group_id": 2,
  "delay": 2,
  "try_allowed": 2,
  "account_id: 1 (number) - account_id of associated account": "Hello, world!",
  "status": "active"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number"
    },
    "group_id": {
      "type": "number"
    },
    "delay": {
      "type": "number",
      "description": "pause between transmissions `milliseconds`"
    },
    "try_allowed": {
      "type": "number"
    },
    "account_id: 1 (number) - account_id of associated account": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "current status of campaign"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1,
  "group_id": 2,
  "delay": 2,
  "try_allowed": 2,
  "account_id: 1 (number) - account_id of associated account": "Hello, world!",
  "status": "active"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number"
    },
    "group_id": {
      "type": "number"
    },
    "delay": {
      "type": "number",
      "description": "pause between transmissions `milliseconds`"
    },
    "try_allowed": {
      "type": "number"
    },
    "account_id: 1 (number) - account_id of associated account": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "current status of campaign"
    }
  }
}

Get a Campaign
GET`/campaigns/{campaign_id}`

Example URI

GET http://ictcore.example.com/campaigns/campaign_id

URI Parameters

HideShow

campaign_id: number (required)
ID of the campaign in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "program_id": 1,
  "group_id": 2,
  "delay": 2,
  "try_allowed": 2,
  "account_id: 1 (number) - account_id of associated account": "Hello, world!",
  "status": "active"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "program_id": {
      "type": "number"
    },
    "group_id": {
      "type": "number"
    },
    "delay": {
      "type": "number",
      "description": "pause between transmissions `milliseconds`"
    },
    "try_allowed": {
      "type": "number"
    },
    "account_id: 1 (number) - account_id of associated account": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "current status of campaign"
    }
  }
}

Delete Campaign
DELETE`/campaigns/{campaign_id}`

Example URI

DELETE http://ictcore.example.com/campaigns/campaign_id

URI Parameters

HideShow

campaign_id: number (required)
ID of the campaign in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Campaign Start ¶

Campaign Start
PUT`/campaigns/{campaign_id}/start`

Start contact processing / calling in selected campaign

Example URI

PUT http://ictcore.example.com/campaigns/campaign_id/start

URI Parameters

HideShow

campaign_id: number (required)
ID of the campaign in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "Boolean": "true on success"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Boolean": {
      "type": "string",
      "description": "Boolean: true on success"
    }
  }
}

Campaign Stop ¶

Campaign Stop
PUT`/campaigns/{campaign_id}/stop`

Stop contact processing / calling in selected campaign

Example URI

PUT http://ictcore.example.com/campaigns/campaign_id/stop

URI Parameters

HideShow

campaign_id: number (required)
ID of the campaign in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "Boolean": "true on success"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Boolean": {
      "type": "string",
      "description": "Boolean: true on success"
    }
  }
}

Campaign schedule ¶

Start Campaign Schedule
POST`/campaigns/{campaign_id}/start/schedule`

Instead of processing campaign contacts instantly, schedule their processing / calling in near future.

Example URI

POST http://ictcore.example.com/campaigns/campaign_id/start/schedule

URI Parameters

HideShow

campaign_id: number (required)
ID of the campaign in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "schedule_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "schedule_id": {
      "type": "number",
      "description": "schedule id of recently created schedule record"
    }
  }
}

Campaign schedule ¶

Stop Campaign Schedule
POST`/campaigns/{campaign_id}/stop/schedule`

Instead manually stopping a campaign, we can schedule it.

Example URI

POST http://ictcore.example.com/campaigns/campaign_id/stop/schedule

URI Parameters

HideShow

campaign_id: number (required)
ID of the campaign in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "schedule_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "schedule_id": {
      "type": "number",
      "description": "schedule id of recently created schedule record"
    }
  }
}

Delete Campaign schedule ¶

Stop Campaign Schedule
POST`/campaigns/{campaign_id}/schedule`

Cancel any schedule associated with given campaign

Example URI

POST http://ictcore.example.com/campaigns/campaign_id/schedule

URI Parameters

HideShow

campaign_id: number (required)
ID of the campaign in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Reports ¶

Get Transmission Status Report ¶

Transmission Status
GET`/transmissions/{transmission_id}/status`

Get current status of an existing transmission

Example URI

GET http://ictcore.example.com/transmissions/transmission_id/status

URI Parameters

HideShow

transmission_id: number (required)
ID of the transmission in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "Status": "status"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Status": {
      "type": "string",
      "description": "Will return one of the following status (pending, processing, completed, failed, invalid)"
    }
  }
}

Get Transmission detail Report ¶

Transmission Detail
GET`/transmissions/{transmission_id}/detail`

A list of attempts (spool) with their detail, which system has made to deliver that transmission

Example URI

GET http://ictcore.example.com/transmissions/transmission_id/detail

URI Parameters

HideShow

transmission_id: number (required)
ID of the transmission in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "spool_id": 1,
    "time_spool": 1518705479,
    "time_start": 1518705479,
    "time_connect": 1518705479,
    "time_end": 1518705479,
    "status": "completed",
    "response": "busy",
    "transmission_id": 1
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Get Transmission result Report ¶

Transmission Result
GET`/transmissions/{transmission_id}/result`

Complete details of each step along with remote side responses, for requested transmission

Example URI

GET http://ictcore.example.com/transmissions/transmission_id/result

URI Parameters

HideShow

transmission_id: number (required)
ID of the transmission in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "spool_result_id": 1,
    "spool_id": 1,
    "type": "dtmf",
    "name": "age",
    "data": "22"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Get Spool result status ¶

Spool Status
GET`/spools/{spool_id}/status`

Get current status of an existing transmission attempt (spool)

Example URI

GET http://ictcore.example.com/spools/spool_id/status

URI Parameters

HideShow

spool_id: number (required)
ID of the spool in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "status"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Will return one of the following status (initiated, completed, failed)"
    }
  }
}

Get Spool result result ¶

Spool Result
GET`/spools/{spool_id}/result`

Complete details of each step along with remote side responses, for requested transmission attempt spool_id

Example URI

GET http://ictcore.example.com/spools/spool_id/result

URI Parameters

HideShow

spool_id: number (required)
ID of the spool in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "spool_result_id": 1,
    "spool_id": 1,
    "type": "dtmf",
    "name": "age",
    "data": "22"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

User account / Email / DID / Extension ¶

Users Acounts ¶

Create Account
POST`/accounts`

Example URI

POST http://ictcore.example.com/accounts

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "username": "username",
  "passwd": "password",
  "passwd_pin": "password pin",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "passwd_pin": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "account_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "account_id": {
      "type": "number",
      "description": "account id of recently created account record"
    }
  }
}

Get All Accounts
GET`/accounts`

Example URI

GET http://ictcore.example.com/accounts

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "username": "username",
    "passwd": "password",
    "passwd_pin": "password pin",
    "first_name": "first name",
    "last_name": "last name",
    "phone": 3001234567,
    "email": "email",
    "address": "address",
    "active": 1
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Account Detail ¶

View a Account
GET`/accounts/{account_id}`

Read / view complete account data

Example URI

GET http://ictcore.example.com/accounts/account_id

URI Parameters

HideShow

account_id: number (required)
ID of the account in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "passwd_pin": "password pin",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "passwd_pin": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Update Account
PUT`/accounts/{account_id}`

Update an existing account

Example URI

PUT http://ictcore.example.com/accounts/account_id

URI Parameters

HideShow

account_id: number (required)
ID of the account in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "username": "username",
  "passwd": "password",
  "passwd_pin": "password pin",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "passwd_pin": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "passwd_pin": "password pin",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "passwd_pin": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Delete Account
DELETE`/accounts/{account_id}`

Delete an existing account

Example URI

DELETE http://ictcore.example.com/accounts/account_id

URI Parameters

HideShow

account_id: number (required)
ID of the account in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Subscribe an account to some exiting program ¶

Subscribe an account to some exiting program
PUT`/accounts/{account_id}/programs/{program_id}`

Example URI

PUT http://ictcore.example.com/accounts/account_id/programs/program_id

URI Parameters

HideShow

account_id: number (required)
ID of the account in the form of an integer
program_id: number (required)
ID of the program in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "passwd_pin": "password pin",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "passwd_pin": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Unsubscribe an account from given program
DELETE`/accounts/{account_id}/programs/{program_id}`

Example URI

DELETE http://ictcore.example.com/accounts/account_id/programs/program_id

URI Parameters

HideShow

account_id: number (required)
ID of the account in the form of an integer
program_id: number (required)
ID of the program in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "passwd_pin": "password pin",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "passwd_pin": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Clear an account from all subscribed programs ¶

Clear an account all subscribed program
DELETE`/accounts/{account_id}/programs`

Example URI

DELETE http://ictcore.example.com/accounts/account_id/programs

URI Parameters

HideShow

account_id: number (required)
ID of the account in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "passwd_pin": "password pin",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "passwd_pin": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Change account ownership ¶

Change account ownership assign account to some other user
PUT`/accounts/{account_id}/users/{user_id}`

Example URI

PUT http://ictcore.example.com/accounts/account_id/users/user_id

URI Parameters

HideShow

account_id: number (required)
ID of the account in the form of an integer
user_id: number (required)
ID of the user in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "passwd_pin": "password pin",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "passwd_pin": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Dissociate a account from any user ¶

Dissociate a account from any user, make it free to assign
DELETE`/accounts/{account_id}/users`

Example URI

DELETE http://ictcore.example.com/accounts/account_id/users

URI Parameters

HideShow

account_id: number (required)
ID of the account in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "passwd_pin": "password pin",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "passwd_pin": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

User Management ¶

User Collection ¶

Create New User
POST`/users`

Example URI

POST http://ictcore.example.com/users

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "username": "username",
  "passwd": "password",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "company": "company name",
  "country_id": 1,
  "timezone_id": 1,
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "country_id": {
      "type": "number",
      "description": "see country table"
    },
    "timezone_id": {
      "type": "number",
      "description": "see timezone table"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "user_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_id": {
      "type": "number",
      "description": "user id of recently created user record"
    }
  }
}

Get All Users
GET`/users`

list all exiting users, optionally client can filter users using query string (key value pair) in url, while using any of following fields

Example URI

GET http://ictcore.example.com/users

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "username": "username",
    "passwd": "password",
    "first_name": "first name",
    "last_name": "last name",
    "phone": 3001234567,
    "email": "email",
    "address": "address",
    "company": "company name",
    "country_id": 1,
    "timezone_id": 1,
    "active": 1
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single User Detail ¶

View a User Detail
GET`/users/{user_id}`

Example URI

GET http://ictcore.example.com/users/user_id

URI Parameters

HideShow

user_id: number (required)
ID of the user in the form of an integer

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "company": "company name",
  "country_id": 1,
  "timezone_id": 1,
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "country_id": {
      "type": "number",
      "description": "see country table"
    },
    "timezone_id": {
      "type": "number",
      "description": "see timezone table"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Update User
PUT`/users/{user_id}`

Example URI

PUT http://ictcore.example.com/users/user_id

URI Parameters

HideShow

user_id: number (required)
ID of the user in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "username": "username",
  "passwd": "password",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "company": "company name",
  "country_id": 1,
  "timezone_id": 1,
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "country_id": {
      "type": "number",
      "description": "see country table"
    },
    "timezone_id": {
      "type": "number",
      "description": "see timezone table"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "company": "company name",
  "country_id": 1,
  "timezone_id": 1,
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "country_id": {
      "type": "number",
      "description": "see country table"
    },
    "timezone_id": {
      "type": "number",
      "description": "see timezone table"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Delete User
DELETE`/users/{user_id}`

Example URI

DELETE http://ictcore.example.com/users/user_id

URI Parameters

HideShow

user_id: number (required)
ID of the user in the form of an integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

User Role Define ¶

Update User Role
PUT`/users/{user_id}/roles/{role_id}`

Example URI

PUT http://ictcore.example.com/users/user_id/roles/role_id

URI Parameters

HideShow

user_id: number (required)
ID of the user in the form of an Integer
role_id: number (required)
ID of the role in the form of an Integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "company": "company name",
  "country_id": 1,
  "timezone_id": 1,
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "country_id": {
      "type": "number",
      "description": "see country table"
    },
    "timezone_id": {
      "type": "number",
      "description": "see timezone table"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Delete User Role
DELETE`/users/{user_id}/roles/{role_id}`

Example URI

DELETE http://ictcore.example.com/users/user_id/roles/role_id

URI Parameters

HideShow

user_id: number (required)
ID of the user in the form of an Integer
role_id: number (required)
ID of the role in the form of an Integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

User permissions Define ¶

Update User Permissions
PUT`/users/{user_id}/permissions/{permission_id}`

Example URI

PUT http://ictcore.example.com/users/user_id/permissions/permission_id

URI Parameters

HideShow

user_id: number (required)
ID of the user in the form of an Integer
permission_id: number (required)
ID of the permission in the form of an Integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "username": "username",
  "passwd": "password",
  "first_name": "first name",
  "last_name": "last name",
  "phone": 3001234567,
  "email": "email",
  "address": "address",
  "company": "company name",
  "country_id": 1,
  "timezone_id": 1,
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "passwd": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "phone": {
      "type": "number"
    },
    "email": {
      "type": "string"
    },
    "address": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "country_id": {
      "type": "number",
      "description": "see country table"
    },
    "timezone_id": {
      "type": "number",
      "description": "see timezone table"
    },
    "active": {
      "type": "number",
      "description": "1 for active, 0 for disabled"
    }
  }
}

Delete User Permissions
DELETE`/users/{user_id}/permissions/{permission_id}`

Example URI

DELETE http://ictcore.example.com/users/user_id/permissions/permission_id

URI Parameters

HideShow

user_id: number (required)
ID of the user in the form of an Integer
permission_id: number (required)
ID of the permission in the form of an Integer

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Trunk / Termination Providers APIs ¶

Trunk Termination ¶

Create Provider
POST`/providers`

Example URI

POST http://ictcore.example.com/providers

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "gateway_flag: 1 (number) - Type of gateway i.e Freeswitch::GATEWAY_FLAG or Kannel": ":GATEWAY_FLAG",
  "service_flag: 1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
  "node_id": 1,
  "host": "ipaddress",
  "port": 8080,
  "username": "username",
  "password": "password",
  "dialstring": "dailstring",
  "prefix": 12,
  "settings": "settings",
  "register": 1,
  "weight": 10,
  "type": "type",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "gateway_flag: 1 (number) - Type of gateway i.e Freeswitch::GATEWAY_FLAG or Kannel": {
      "type": "string"
    },
    "service_flag: 1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": {
      "type": "string"
    },
    "node_id": {
      "type": "number",
      "description": "see node table"
    },
    "host": {
      "type": "string",
      "description": "ip address to termination server"
    },
    "port": {
      "type": "number"
    },
    "username": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "dialstring": {
      "type": "string"
    },
    "prefix": {
      "type": "number",
      "description": "number which is required to be dialed before actual phone number"
    },
    "settings": {
      "type": "string",
      "description": "any additional configuration required by this provider"
    },
    "register": {
      "type": "number"
    },
    "weight": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "active": {
      "type": "number"
    }
  },
  "required": [
    "username"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "provider_id": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "provider_id": {
      "type": "number",
      "description": "provider id of recently created provider record"
    }
  }
}

Get All Providers
GET`/providers`

Example URI

GET http://ictcore.example.com/providers

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "name": "name",
    "gateway_flag: 1 (number) - Type of gateway i.e Freeswitch::GATEWAY_FLAG or Kannel": ":GATEWAY_FLAG",
    "service_flag: 1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
    "node_id": 1,
    "host": "ipaddress",
    "port": 8080,
    "username": "username",
    "password": "password",
    "dialstring": "dailstring",
    "prefix": 12,
    "settings": "settings",
    "register": 1,
    "weight": 10,
    "type": "type",
    "active": 1
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Single Provider Action ¶

Update Provider
PUT`/providers/`

Example URI

PUT http://ictcore.example.com/providers/

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Body

{
  "name": "name",
  "gateway_flag: 1 (number) - Type of gateway i.e Freeswitch::GATEWAY_FLAG or Kannel": ":GATEWAY_FLAG",
  "service_flag: 1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
  "node_id": 1,
  "host": "ipaddress",
  "port": 8080,
  "username": "username",
  "password": "password",
  "dialstring": "dailstring",
  "prefix": 12,
  "settings": "settings",
  "register": 1,
  "weight": 10,
  "type": "type",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "gateway_flag: 1 (number) - Type of gateway i.e Freeswitch::GATEWAY_FLAG or Kannel": {
      "type": "string"
    },
    "service_flag: 1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": {
      "type": "string"
    },
    "node_id": {
      "type": "number",
      "description": "see node table"
    },
    "host": {
      "type": "string",
      "description": "ip address to termination server"
    },
    "port": {
      "type": "number"
    },
    "username": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "dialstring": {
      "type": "string"
    },
    "prefix": {
      "type": "number",
      "description": "number which is required to be dialed before actual phone number"
    },
    "settings": {
      "type": "string",
      "description": "any additional configuration required by this provider"
    },
    "register": {
      "type": "number"
    },
    "weight": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "active": {
      "type": "number"
    }
  },
  "required": [
    "username"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "name",
  "gateway_flag: 1 (number) - Type of gateway i.e Freeswitch::GATEWAY_FLAG or Kannel": ":GATEWAY_FLAG",
  "service_flag: 1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
  "node_id": 1,
  "host": "ipaddress",
  "port": 8080,
  "username": "username",
  "password": "password",
  "dialstring": "dailstring",
  "prefix": 12,
  "settings": "settings",
  "register": 1,
  "weight": 10,
  "type": "type",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "gateway_flag: 1 (number) - Type of gateway i.e Freeswitch::GATEWAY_FLAG or Kannel": {
      "type": "string"
    },
    "service_flag: 1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": {
      "type": "string"
    },
    "node_id": {
      "type": "number",
      "description": "see node table"
    },
    "host": {
      "type": "string",
      "description": "ip address to termination server"
    },
    "port": {
      "type": "number"
    },
    "username": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "dialstring": {
      "type": "string"
    },
    "prefix": {
      "type": "number",
      "description": "number which is required to be dialed before actual phone number"
    },
    "settings": {
      "type": "string",
      "description": "any additional configuration required by this provider"
    },
    "register": {
      "type": "number"
    },
    "weight": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "active": {
      "type": "number"
    }
  },
  "required": [
    "username"
  ]
}

View a Provider Detail
GET`/providers/`

Example URI

GET http://ictcore.example.com/providers/

Request

HideShow

Headers

Authentication: Bearer JWT

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "name",
  "gateway_flag: 1 (number) - Type of gateway i.e Freeswitch::GATEWAY_FLAG or Kannel": ":GATEWAY_FLAG",
  "service_flag: 1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": ":SERVICE_FLAG",
  "node_id": 1,
  "host": "ipaddress",
  "port": 8080,
  "username": "username",
  "password": "password",
  "dialstring": "dailstring",
  "prefix": 12,
  "settings": "settings",
  "register": 1,
  "weight": 10,
  "type": "type",
  "active": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "gateway_flag: 1 (number) - Type of gateway i.e Freeswitch::GATEWAY_FLAG or Kannel": {
      "type": "string"
    },
    "service_flag: 1 (number) - Type of transmission service i.e Email::SERVICE_FLAG or Voice": {
      "type": "string"
    },
    "node_id": {
      "type": "number",
      "description": "see node table"
    },
    "host": {
      "type": "string",
      "description": "ip address to termination server"
    },
    "port": {
      "type": "number"
    },
    "username": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "dialstring": {
      "type": "string"
    },
    "prefix": {
      "type": "number",
      "description": "number which is required to be dialed before actual phone number"
    },
    "settings": {
      "type": "string",
      "description": "any additional configuration required by this provider"
    },
    "register": {
      "type": "number"
    },
    "weight": {
      "type": "number"
    },
    "type": {
      "type": "string"
    },
    "active": {
      "type": "number"
    }
  },
  "required": [
    "username"
  ]
}

Delete Providers
DELETE`/providers/`

Example URI

DELETE http://ictcore.example.com/providers/

Request

HideShow

Headers

Content-Type: application/json
Authentication: Bearer JWT

Response 200

Overview ¶

HTTP Response Code ¶

Authentication ¶

Authentication ¶

Authentication parameterPOST/authentication

Example URI

Headers

Body

Schema

Headers

Body

Schema

System Statistics ¶

System Statistics ¶

Get System StatisticsGET/statistics

Example URI

Headers

Headers

Body

Schema

Contact ¶

Collection of Contacts ¶

Create New ContactPOST/contacts

Example URI

Headers

Body

Schema

Headers

Body

Schema

Get All ContactsGET/contacts

Example URI

Headers

Headers

Body

Schema

Single Contact ¶

View a Contact DetailGET/contacts/{contact_id}

Example URI

Headers

Headers

Body

Schema

Update ContactsPUT/contacts/{contact_id}

Example URI

Headers

Body

Schema

Headers

Body

Schema

Delete ContactDELETE/contacts/{contact_id}

Example URI

Headers

Headers

Contact association with group ¶

Create associationPUT/contacts/{contact_id}/link/{group_id}

Example URI

Headers

Headers

Body

Schema

Delete associationDELETE/contacts/{contact_id}/link/{group_id}

Example URI

Headers

Headers

Body

Schema

Contact Group ¶

Collection of Groups ¶

Create New GroupPOST/groups

Example URI

Headers

Body

Schema

Headers

Body

Schema

Get All GroupsGET/groups

Example URI

Overview

HTTP Response Code

Authentication parameter
POST`/authentication`

Get System Statistics
GET`/statistics`

Create New Contact
POST`/contacts`

Get All Contacts
GET`/contacts`

View a Contact Detail
GET`/contacts/{contact_id}`

Update Contacts
PUT`/contacts/{contact_id}`

Delete Contact
DELETE`/contacts/{contact_id}`

Create association
PUT`/contacts/{contact_id}/link/{group_id}`

Delete association
DELETE`/contacts/{contact_id}/link/{group_id}`

Create New Group
POST`/groups`

Get All Groups
GET`/groups`

View a Group Detail
GET`/groups/{group_id}`

Update Groups
PUT`/groups/{group_id}`

Delete Group
DELETE`/groups/{group_id}`

Get all Contacts from Group
GET`/groups/{group_id}/contacts`

Import Contacts into Group
POST`/groups/{group_id}/csv`

Export Contacts from Group
GET`/groups/{group_id}/csv`

Get Sample csv file
GET`/groups/sample/csv`

Create New Document
POST`/messages/documents`

Get all Documnets
GET`/messages/documents`

View a Document Detail
GET`/messages/documents/{document_id}`

Update Document
PUT`/messages/documents/{document_id}`