Call

Handle data related to ImBox Call

Get calls (beta)

Get calls

Parameters

Name	Type	Description
apiKey*	String	Your API Key
userId*	String	Unique id for the user

Query parameters

Name	Type	Description
limit	Integer	Number of calls to return
fromDate	String	createdDate >= fromDate (format)
toDate	String	createdDate < toDate (format)
afterId	Integer	Cursor for next result set
afterDate	Integer	Cursor for next result set

Usage

curl -X GET "https://apiv2.imbox.io/api/:apiKey/:userId/phone-calls?limit=2"

Response

{
  "calls": [
    {
      "id": 100,
      "direction": "incoming",
      "internalNumber": "+4601234",
      "externalNumber": "+4605678",
      "queueId": 1,
      "queuedTime": "2020-02-05T00:00:00.000Z",
      "assignTime": "2020-02-05T00:00:30.000Z",
      "answerTime": "2020-02-05T00:01:00.000Z",
      "redirectTime": null,
      "completedTime": "2020-02-05T00:10:00.000Z",
      "createdDate": "2020-02-05T00:00:00.000Z",
      "participants": [
        {
          "contactId": 1,
          "phoneNumber": "+4605678"
        },
        {
          "agentId": 1
        }
      ],
      "recordings": ["https://1.wav", "https://2.wav"]
    },
    {
      "id": 123,
      "direction": "outgoing",
      "internalNumber": "+4619999",
      "externalNumber": "+4601234",
      "queueId": null,
      "queuedTime": null,
      "assignTime": null,
      "answerTime": null,
      "redirectTime": null,
      "completedTime": "2020-02-05T02:10:00.000Z",
      "createdDate": "2020-02-05T00:00:00.000Z",
      "participants": [
        {
          "agentId": 1
        }
      ],
      "recordings": []
    }
  ],
  "paging": {
    "cursor": {
      "afterId": 123
    }
  },
  "next": "https://apiv2.imbox.io/api/apiKey/userId/phone-calls?limit=2&afterId=123"
}

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
Call	Read